doc(bkgpslog):Update plan doc
[EVA-2020-02.git] / exec / bkgpslog
index cf41e54fb6b3abf133895ec524945c949827a336..19f95f270ede42591555bf3d9f6c79d824129735 100755 (executable)
@@ -14,7 +14,7 @@ DIR_TMP_DEFAULT="/dev/shm"; # Default parent of working directory
 SCRIPT_TIME_START=$(date +%Y%m%dT%H%M%S.%N);
 PATH="$HOME/.local/bin:$PATH";   # Add "$(systemd-path user-binaries)" path in case apps saved there
 SCRIPT_HOSTNAME=$(hostname);     # Save hostname of system running this script.
 SCRIPT_TIME_START=$(date +%Y%m%dT%H%M%S.%N);
 PATH="$HOME/.local/bin:$PATH";   # Add "$(systemd-path user-binaries)" path in case apps saved there
 SCRIPT_HOSTNAME=$(hostname);     # Save hostname of system running this script.
-SCRIPT_VERSION="bkgpslog 0.1.0"; # Define version of script.
+SCRIPT_VERSION="bkgpslog 0.2.0"; # Define version of script.
 
 declare -Ag appRollCall # Associative array for storing app status
 declare -Ag fileRollCall # Associative array for storing file status
 
 declare -Ag appRollCall # Associative array for storing app status
 declare -Ag fileRollCall # Associative array for storing file status
@@ -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;;
@@ -262,41 +262,47 @@ setTimeZoneEV(){
 } # Exports TZ environment variable
 timeUntilNextDay(){
     # Desc: Report seconds until next day.
 } # Exports TZ environment variable
 timeUntilNextDay(){
     # Desc: Report seconds until next day.
+    # Version: 1.0.0
     # Output: stdout: integer seconds until next day
     # Output: exit code 0 if stdout > 0; 1 if stdout = 0; 2 if stdout < 0
     # Usage: timeUntilNextDay
     # Usage: if ! myTTL="$(timeUntilNextDay)"; then yell "ERROR in if statement"; exit 1; fi
     # Output: stdout: integer seconds until next day
     # Output: exit code 0 if stdout > 0; 1 if stdout = 0; 2 if stdout < 0
     # Usage: timeUntilNextDay
     # Usage: if ! myTTL="$(timeUntilNextDay)"; then yell "ERROR in if statement"; exit 1; fi
+    # Depends: date 8, echo 8, yell, try
+    
     local returnState TIME_CURRENT TIME_NEXT_DAY SECONDS_UNTIL_NEXT_DAY
     local returnState TIME_CURRENT TIME_NEXT_DAY SECONDS_UNTIL_NEXT_DAY
+
     TIME_CURRENT="$(date --iso-8601=seconds)" ; # Produce `date`-parsable current timestamp with resolution of 1 second.
     TIME_NEXT_DAY="$(date -d "$TIME_CURRENT next day" --iso-8601=date)"; # Produce timestamp of beginning of tomorrow with resolution of 1 second.
     SECONDS_UNTIL_NEXT_DAY="$(( $(date +%s -d "$TIME_NEXT_DAY") - $(date +%s -d "$TIME_CURRENT") ))" ; # Calculate seconds until closest future midnight (res. 1 second).
     if [[ "$SECONDS_UNTIL_NEXT_DAY" -gt 0 ]]; then
        returnState="true";
     elif [[ "$SECONDS_UNTIL_NEXT_DAY" -eq 0 ]]; then
     TIME_CURRENT="$(date --iso-8601=seconds)" ; # Produce `date`-parsable current timestamp with resolution of 1 second.
     TIME_NEXT_DAY="$(date -d "$TIME_CURRENT next day" --iso-8601=date)"; # Produce timestamp of beginning of tomorrow with resolution of 1 second.
     SECONDS_UNTIL_NEXT_DAY="$(( $(date +%s -d "$TIME_NEXT_DAY") - $(date +%s -d "$TIME_CURRENT") ))" ; # Calculate seconds until closest future midnight (res. 1 second).
     if [[ "$SECONDS_UNTIL_NEXT_DAY" -gt 0 ]]; then
        returnState="true";
     elif [[ "$SECONDS_UNTIL_NEXT_DAY" -eq 0 ]]; then
-       returnState="WARNING_ZERO";
+       returnState="warning_zero";
        yell "WARNING:Reported time until next day exactly zero.";
     elif [[ "$SECONDS_UNTIL_NEXT_DAY" -lt 0 ]]; then
        yell "WARNING:Reported time until next day exactly zero.";
     elif [[ "$SECONDS_UNTIL_NEXT_DAY" -lt 0 ]]; then
-       returnState="WARNING_NEGATIVE";
+       returnState="warning_negative";
        yell "WARNING:Reported time until next day is negative.";
     fi
 
     try echo "$SECONDS_UNTIL_NEXT_DAY"; # Report
     
        yell "WARNING:Reported time until next day is negative.";
     fi
 
     try echo "$SECONDS_UNTIL_NEXT_DAY"; # Report
     
-    #===Determine function return code===
+    # Determine function return code
     if [[ "$returnState" = "true" ]]; then
        return 0;
     if [[ "$returnState" = "true" ]]; then
        return 0;
-    elif [[ "$returnState" = "WARNING_ZERO" ]]; then
+    elif [[ "$returnState" = "warning_zero" ]]; then
        return 1;
        return 1;
-    elif [[ "$returnState" = "WARNING_NEGATIVE" ]]; then
+    elif [[ "$returnState" = "warning_negative" ]]; then
        return 2;
     fi
 } # Report seconds until next day
 timeUntilNextHour(){
     # Desc: Report seconds until next hour
        return 2;
     fi
 } # Report seconds until next day
 timeUntilNextHour(){
     # Desc: Report seconds until next hour
+    # Version 1.0.0
     # Output: stdout: integer seconds until next hour
     # Output: exit code 0 if stdout > 0; 1 if stdout = 0; 2 if stdout < 0
     # Usage: timeUntilNextHour
     # Usage: if ! myTTL="$(timeUntilNextHour)"; then yell "ERROR in if statement"; exit 1; fi
     # Output: stdout: integer seconds until next hour
     # Output: exit code 0 if stdout > 0; 1 if stdout = 0; 2 if stdout < 0
     # Usage: timeUntilNextHour
     # Usage: if ! myTTL="$(timeUntilNextHour)"; then yell "ERROR in if statement"; exit 1; fi
+    
     local returnState TIME_CURRENT TIME_NEXT_HOUR SECONDS_UNTIL_NEXT_HOUR
     TIME_CURRENT="$(date --iso-8601=seconds)"; # Produce `date`-parsable current timestamp with resolution of 1 second.
     TIME_NEXT_HOUR="$(date -d "$TIME_CURRENT next hour" --iso-8601=hours)"; # Produce `date`-parsable current time stamp with resolution of 1 second.
     local returnState TIME_CURRENT TIME_NEXT_HOUR SECONDS_UNTIL_NEXT_HOUR
     TIME_CURRENT="$(date --iso-8601=seconds)"; # Produce `date`-parsable current timestamp with resolution of 1 second.
     TIME_NEXT_HOUR="$(date -d "$TIME_CURRENT next hour" --iso-8601=hours)"; # Produce `date`-parsable current time stamp with resolution of 1 second.
@@ -304,21 +310,21 @@ timeUntilNextHour(){
     if [[ "$SECONDS_UNTIL_NEXT_HOUR" -gt 0 ]]; then
        returnState="true";
     elif [[ "$SECONDS_UNTIL_NEXT_HOUR" -eq 0 ]]; then
     if [[ "$SECONDS_UNTIL_NEXT_HOUR" -gt 0 ]]; then
        returnState="true";
     elif [[ "$SECONDS_UNTIL_NEXT_HOUR" -eq 0 ]]; then
-       returnState="WARNING_ZERO";
+       returnState="warning_zero";
        yell "WARNING:Reported time until next hour exactly zero.";
     elif [[ "$SECONDS_UNTIL_NEXT_HOUR" -lt 0 ]]; then
        yell "WARNING:Reported time until next hour exactly zero.";
     elif [[ "$SECONDS_UNTIL_NEXT_HOUR" -lt 0 ]]; then
-       returnState="WARNING_NEGATIVE";
+       returnState="warning_negative";
        yell "WARNING:Reported time until next hour is negative.";
     fi
 
     try echo "$SECONDS_UNTIL_NEXT_HOUR"; # Report
     
        yell "WARNING:Reported time until next hour is negative.";
     fi
 
     try echo "$SECONDS_UNTIL_NEXT_HOUR"; # Report
     
-    #===Determine function return code===
+    # Determine function return code
     if [[ "$returnState" = "true" ]]; then
        return 0;
     if [[ "$returnState" = "true" ]]; then
        return 0;
-    elif [[ "$returnState" = "WARNING_ZERO" ]]; then
+    elif [[ "$returnState" = "warning_zero" ]]; then
        return 1;
        return 1;
-    elif [[ "$returnState" = "WARNING_NEGATIVE" ]]; then
+    elif [[ "$returnState" = "warning_negative" ]]; then
        return 2;
     fi
 } # Report seconds until next hour
        return 2;
     fi
 } # Report seconds until next hour
@@ -345,12 +351,17 @@ timeDuration(){
     # Ref/Attrib: ISO-8601:2004(E), §4.4.4.2 Representations of time intervals by duration and context information
     # Note: "1 month" ("P1M") is assumed to be "30 days" (see ISO-8601:2004(E), §2.2.1.2)
     # Usage: timeDuration [arg1] ([arg2])
     # Ref/Attrib: ISO-8601:2004(E), §4.4.4.2 Representations of time intervals by duration and context information
     # Note: "1 month" ("P1M") is assumed to be "30 days" (see ISO-8601:2004(E), §2.2.1.2)
     # Usage: timeDuration [arg1] ([arg2])
+    # Version: 1.0.1
     # Input: arg1: seconds as base 10 integer >= 0  (ex: 3601)
     #        arg2: precision level (optional; default=2)
     # Output: stdout: ISO-8601 duration string (ex: "P1H1S", "P2Y10M15DT10H30M20S")
     # Example: 'timeDuration 111111 3' yields 'P1DT6H51M'
     # Input: arg1: seconds as base 10 integer >= 0  (ex: 3601)
     #        arg2: precision level (optional; default=2)
     # Output: stdout: ISO-8601 duration string (ex: "P1H1S", "P2Y10M15DT10H30M20S")
     # Example: 'timeDuration 111111 3' yields 'P1DT6H51M'
-    # Depends: date 8 (gnucoreutils)
-    local returnState fullHours fullMinutes fullSeconds;
+    # Depends: date 8 (gnucoreutils), yell, 
+    local returnState ARG1 ARG2 remainder precision witherPrecision
+    local fullYears fullMonths fullDays fullHours fullMinutes fullSeconds
+    local displayYears displayMonths displayDays displayHours displayMinutes displaySeconds
+    local hasYears hasMonths hasDays hasHours hasMinutes hasSeconds
+    
     ARG1="$1";
     ARG2="$2";
     precision=2; # set default precision
     ARG1="$1";
     ARG2="$2";
     precision=2; # set default precision
@@ -363,13 +374,12 @@ timeDuration(){
 
     # Check that arg1 provided
     if [[ $# -ge 1 ]]; then
 
     # Check that arg1 provided
     if [[ $# -ge 1 ]]; then
-       # Check that arg1 is a positive integer
+       ## Check that arg1 is a positive integer
        if [[ "$ARG1" =~ ^[[:digit:]]+$ ]]; then
        if [[ "$ARG1" =~ ^[[:digit:]]+$ ]]; then
-           arg1Valid="true";
+           :
        else
            yell "ERROR:ARG1 not a digit.";
            returnState="ERROR_INPUT";
        else
            yell "ERROR:ARG1 not a digit.";
            returnState="ERROR_INPUT";
-           arg1Valid="false";
        fi
     else
        yell "ERROR:No argument provided. Exiting.";
        fi
     else
        yell "ERROR:No argument provided. Exiting.";
@@ -379,16 +389,14 @@ timeDuration(){
     # Consider whether arg2 was provided
     if  [[ $# -eq 2 ]]; then
        # Check that the second arg is a positive integer
     # Consider whether arg2 was provided
     if  [[ $# -eq 2 ]]; then
        # Check that the second arg is a positive integer
-       if [[ "$ARG2" =~ ^[[:digit:]]+$ ]] && [[ "ARG2" -gt 0 ]]; then
-       arg2Valid="true";
+       if [[ "$ARG2" =~ ^[[:digit:]]+$ ]] && [[ "$ARG2" -gt 0 ]]; then
        precision="$ARG2";
        else
            yell "ERROR:ARG2 not a positive integer. (is $ARG2 ). Leaving early.";
            returnState="ERROR_INPUT";
        precision="$ARG2";
        else
            yell "ERROR:ARG2 not a positive integer. (is $ARG2 ). Leaving early.";
            returnState="ERROR_INPUT";
-           arg2Valid="false";
        fi;
     else
        fi;
     else
-       arg2Valid="false";
+       :
     fi;
     
     remainder="$ARG1" ; # seconds
     fi;
     
     remainder="$ARG1" ; # seconds
@@ -612,6 +620,129 @@ 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 ]
+    # 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
+magicWriteVersion() {
+    # Desc: Appends time-stamped VERSION to PATHOUT_TAR
+    # Usage: magicWriteVersion
+    # Input: CONTENT_VERSION, FILEOUT_VERSION, PATHOUT_TAR, DIR_TMP
+    # Depends: dateTimeShort, appendArgTar
+    
+    # Generate VERSION file in BashVar
+    FILEOUT_VERSION="$(dateTimeShort)..VERSION";
+    CONTENT_VERSION="$(dateTimeShort):$(basename "$0")"" Version:""$SCRIPT_VERSION";
+    # Create BashVar as file FILEOUT_VERSION and write-append to PATHOUT_TAR
+    appendArgTar "$CONTENT_VERSION" "$FILEOUT_VERSION" "$PATHOUT_TAR" "$DIR_TMP";
+} # bkgpslog: write version data to PATHOUT_TAR via appendArgTar()
+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().";
+
+    # Validate PATHOUT_TAR as tar.
+    checkMakeTar "$PATHOUT_TAR";
+    ## Add VERSION file if checkMakeTar had to create a tar (exited 1) or replace one (exited 2)
+    if [[ $? -eq 1 ]] || [[ $? -eq 2 ]]; then magicWriteVersion; fi
+
+    # 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.
     
 main() {
     processArguments "$@" # Process arguments.
     
@@ -621,7 +752,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
@@ -638,7 +769,7 @@ main() {
     fi
 
     ## Set DIR_TMP using DIR_TMP_PARENT and nonce (SCRIPT_TIME_START)
     fi
 
     ## Set DIR_TMP using DIR_TMP_PARENT and nonce (SCRIPT_TIME_START)
-    DIR_TMP="$DIR_TMP_PARENT"/"$SCRIPT_TIME_START""..bkgpslog"; # Note: removed at end of main().
+    DIR_TMP="$DIR_TMP_PARENT"/"$SCRIPT_TIME_START""..bkgpslog" && vbm "DEBUG:Set DIR_TMP to:$DIR_TMP"; # Note: removed at end of main().
     
     # Set output encryption and compression option strings
     if [[ "$OPTION_ENCRYPT" = "true" ]]; then # Check if encryption option active.
     
     # Set output encryption and compression option strings
     if [[ "$OPTION_ENCRYPT" = "true" ]]; then # Check if encryption option active.
@@ -648,7 +779,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;
@@ -676,7 +807,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.
@@ -685,7 +816,7 @@ main() {
        displayMissing; yell "Exiting."; exit 1; fi
 
     # Set script lifespan
        displayMissing; yell "Exiting."; exit 1; fi
 
     # Set script lifespan
-    setScriptTTL "$SCRIPT_TTL";
+    setScriptTTL "$SCRIPT_TTL"; # seconds until next new SCRIPT_TTL (ex: "day" or "hour")
 
     # File name substring: encoded bufferTTL
     bufferTTL_STR="$(timeDuration $BUFFER_TTL)";
 
     # File name substring: encoded bufferTTL
     bufferTTL_STR="$(timeDuration $BUFFER_TTL)";
@@ -695,65 +826,56 @@ 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 ;
-    ## Write bkgpslog version to DIR_TMP/VERSION
-    echo "$0"" Version:""$SCRIPT_VERSION" >> "$DIR_TMP/VERSION" && vbm "DEBUG:VERSION created.";
-    ## Check if PATHOUT_TAR already exists.
-    if [[ -f "$PATHOUT_TAR" ]]; then
-       ### Check if preexisting tar is appendable.
-       PATHOUT_APPENDTEST="$DIR_TMP"/"$(dateTimeShort)..append_test.txt";
-       echo "$(dateTimeShort)" >> "$PATHOUT_APPENDTEST" && vbm "DEBUG:""$PATHOUT_APPENDTEST"" created."
-       if ! tar --append --directory="$DIR_TMP" --file="$PATHOUT_TAR" "$(basename "$PATHOUT_APPENDTEST")"; then
-           ### If not appendable, label tar broken, move tar, proceed.
-           mv "$PATHOUT_TAR" "${PATHOUT_TAR%.*}""-broken$(dateTimeShort)".tar;
-       fi
-    else
-       ### 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:""$PATHOUT_TAR"" created.";
-    fi 
+    PATHOUT_TAR="$DIR_OUT"/"$(dateShort)".."$SCRIPT_HOSTNAME""_location""$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX".tar && \
+       vbm "STATUS:Set PATHOUT_TAR to:$PATHOUT_TAR";
+    ## 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
     ## Append VERSION file to PATHOUT_TAR
-    try tar --append --directory="$DIR_TMP" --file="$PATHOUT_TAR" "VERSION" && vbm "DEBUG:VERSION added to $PATHOUT_TAR";
+    magicWriteVersion;
     
     # 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" ; # ISO-8601 YYYYmmddTHHMMSS+zzP[$bufferTTL]S
+       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" ; 
-       PATHOUT_GPX="$DIR_TMP"/"$FILEOUT_BASENAME".gpx"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" ;
-       PATHOUT_KML="$DIR_TMP"/"$FILEOUT_BASENAME".kml"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" ;
+       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")
        ## 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_TAR="$DIR_OUT"/"$(dateShort)".."$SCRIPT_HOSTNAME""_location""$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX".tar && \
+           vbm "STATUS:Set PATHOUT_TAR to:$PATHOUT_TAR";
        # Define GPS conversion commands
        # Define GPS conversion commands
-       CMD_CONV_NMEA="tee /dev/null " ; # tee as passthrough
-       CMD_CONV_GPX="gpsbabel -i nmea -f - -o gpx -F - " ; # convert NMEA to GPX
-       CMD_CONV_KML="gpsbabel -i nmea -f - -o kml -F - " ; # 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
        # Fill Bash variable buffer
-       bufferBash="$(timeout "$BUFFER_TTL""s" gpspipe -r)"; # Record gpspipe nmea data to buffer for bufferTTL seconds
+       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
        # Process bufferBash, save secured chunk set 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)
-       vbm "DEBUG:Completed buffer session $debugCounter ." 1>&2;
+       vbm "STATUS:Beginning to save data to $DIR_TMP";
+       magicWriteBuffer &
        # 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)
-       try tar --append --directory="$(dirname $"PATHOUT_NMEA")" --file="$PATHOUT_TAR" "$(basename "$PATHOUT_NMEA")" && \
-           vbm "DEBUG:Appended NMEA location data $PATHOUT_NMEA to $PATHOUT_TAR";
-       try tar --append --directory="$(dirname $"PATHOUT_GPX")" --file="$PATHOUT_TAR" "$(basename "$PATHOUT_GPX")" && \
-           vbm "DEBUG:Appended GPX location data $PATHOUT_GPX to $PATHOUT_TAR";
-       try tar --append --directory="$(dirname $"PATHOUT_KML")" --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_NMEA" "$PATHOUT_NMEA";
+       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";
+
        # 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";
        ((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==