chore(bkgpslog):Add timestamp to version content.

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

diff --git a/exec/bkgpslog b/exec/bkgpslog
index 9210e159407a5a7917fb7ee9da7ac3a5ae666875..16007160e856871564f43a68bd0080e7a5fea995 100755 (executable)
--- a/exec/bkgpslog
+++ b/exec/bkgpslog
@@ -2,18 +2,19 @@
 
 # Desc: Records gps data until midnight
 # Author: Steven Baltakatei Sandoval; License: GPLv3+
 
 # Desc: Records gps data until midnight
 # Author: Steven Baltakatei Sandoval; License: GPLv3+

-# Usage: bkgpslog --output [output dir]
+# Usage: bkgpslog -o [output dir]

 
 #==BEGIN Define script parameters==
 ## Logging Behavior parameters
 BUFFER_TTL="60"; # time between file writes
 SCRIPT_TTL="day"; # (day|hour)
 
 #==BEGIN Define script parameters==
 ## Logging Behavior parameters
 BUFFER_TTL="60"; # time between file writes
 SCRIPT_TTL="day"; # (day|hour)

-TZ="UTC"; export TZ; # Default time zone; overridden by '--time-zone=[str]' option
+#### TZ="UTC"; export TZ; # Default time zone; overridden by '--time-zone=[str]' option
+DIR_TMP_DEFAULT="/dev/shm"; # Default parent of working directory

 
 

-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.
-DIR_TMP="/dev/shm/$(timeStart)..bkgpslog"     # Define working directory for temproary files
+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.

 
 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


@@ -21,6 +22,9 @@ declare -Ag dirRollCall # Associative array for storing dir status
 declare -a recPubKeys # for processArguments function
 declare recipients # for main function
 
 declare -a recPubKeys # for processArguments function
 declare recipients # for main function
 

+## Initialize variables
+OPTION_VERBOSE=""; OPTION_ENCRYPT=""; OPTION_COMPRESS=""; OPTION_TMPDIR="";
+

 #===BEGIN Declare local script functions===
 checkapp() {
     # Desc: If arg is a command, save result in assoc array 'appRollCall'
 #===BEGIN Declare local script functions===
 checkapp() {
     # Desc: If arg is a command, save result in assoc array 'appRollCall'


@@ -150,7 +154,8 @@ showUsage() {
     echoerr "            Encrypt output."
     echoerr
     echoerr "    -r, --recipient [ pubkey string ]"
     echoerr "            Encrypt output."
     echoerr
     echoerr "    -r, --recipient [ pubkey string ]"

-    echoerr "            Specify recipient."
+    echoerr "            Specify recipient. May be age or ssh pubkey."
+    echoerr "            See https://github.com/FiloSottile/age"

     echoerr
     echoerr "    -o, --output [ directory ]"
     echoerr "            Specify output directory to save logs."
     echoerr
     echoerr "    -o, --output [ directory ]"
     echoerr "            Specify output directory to save logs."


@@ -158,6 +163,13 @@ showUsage() {
     echoerr "    -c, --compress"
     echoerr "            Compress output with gzip (before encryption if enabled)."
     echoerr
     echoerr "    -c, --compress"
     echoerr "            Compress output with gzip (before encryption if enabled)."
     echoerr

+    echoerr "    -z, --time-zone"
+    echoerr "            Specify time zone. (ex: \"America/New_York\")"
+    echoerr
+    echoerr "    -t, --temp-dir"
+    echoerr "            Specify parent directory for temporary working directory."
+    echoerr "            Default: \"/dev/shm\""
+    echoerr

     echoerr "EXAMPLE: (bash script lines)"
     echoerr "/bin/bash bkgpslog -e -c \\"
     echoerr "-r age1mrmfnwhtlprn4jquex0ukmwcm7y2nxlphuzgsgv8ew2k9mewy3rs8u7su5 \\"
     echoerr "EXAMPLE: (bash script lines)"
     echoerr "/bin/bash bkgpslog -e -c \\"
     echoerr "-r age1mrmfnwhtlprn4jquex0ukmwcm7y2nxlphuzgsgv8ew2k9mewy3rs8u7su5 \\"


@@ -200,10 +212,11 @@ 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.";;
            -c | --compress) OPTION_COMPRESS="true"; vbm "DEBUG:Compressed output mode enabled.";;

-           -z | --time-zone) try setTimeZoneEV "$1";;
-           *) echoerr "ERROR: Unrecognized argument."; exit 1;; # Handle unrecognized options.
+           -z | --time-zone) try setTimeZoneEV "$2"; shift;;
+           -t | --temp-dir) OPTION_TMPDIR="true" && TMP_DIR_PRIORITY="$2"; shift;;
+           *) echoerr "ERROR: Unrecognized argument: $1"; echoerr "STATUS:All arguments:$*"; exit 1;; # Handle unrecognized options.

        esac
        shift
     done
        esac
        shift
     done


@@ -601,7 +614,32 @@ setScriptTTL() {
 } # Seconds until next (day|hour).
 main() {
     processArguments "$@" # Process arguments.
 } # Seconds until next (day|hour).
 main() {
     processArguments "$@" # Process arguments.

+    
+    # Determine working directory
+    ## Set DIR_TMP_PARENT to user-specified value if specified
+    if [[ "$OPTION_TMPDIR" = "true" ]]; then
+           if [[ -d "$TMP_DIR_PRIORITY" ]]; then
+           DIR_TMP_PARENT="$OPTION_TMPDIR"; 
+       else
+           yell "WARNING:Specified temporary working directory not valid:$OPTION_TMP_DIR";
+           exit 1;
+       fi
+    fi

 
 

+    ## Set DIR_TMP_PARENT to default or fallback otherwise
+    if [[ -d "$DIR_TMP_DEFAULT" ]]; then
+       DIR_TMP_PARENT="$DIR_TMP_DEFAULT";
+    elif [[ -d /tmp ]]; then
+       yell "WARNING:/dev/shm not available. Falling back to /tmp .";
+       DIR_TMP_PARENT="/tmp";
+    else
+       yell "ERROR:No valid working directory available. Exiting.";
+       exit 1;
+    fi
+
+    ## Set DIR_TMP using DIR_TMP_PARENT and nonce (SCRIPT_TIME_START)
+    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.
        if checkapp age; then # Check that age is available.
     # Set output encryption and compression option strings
     if [[ "$OPTION_ENCRYPT" = "true" ]]; then # Check if encryption option active.
        if checkapp age; then # Check that age is available.


@@ -610,7 +648,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;


@@ -653,55 +691,84 @@ main() {
     bufferTTL_STR="$(timeDuration $BUFFER_TTL)";
 
     # Init temp working dir
     bufferTTL_STR="$(timeDuration $BUFFER_TTL)";
 
     # Init temp working dir

-    try mkdir "$DIR_TMP" && vbm "DEBUG:Working dir creatd at:$DIR_TMP"
+    try mkdir "$DIR_TMP" && vbm "DEBUG:Working dir creatd at:$DIR_TMP";

 
     # 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 
+    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."
-    ## Create empty tar archive at PATHOUT_TAR
-    try tar --create --directory="$DIR_TMP" --file="$PATHOUT_TAR" --files-from=/dev/null && vbm "DEBUG:bufferRam.tar created."
+    echo "$(dateTimeShort):$(basename "$0")"" Version:""$SCRIPT_VERSION" >> "$DIR_TMP/VERSION" && vbm "DEBUG:VERSION created.";
+    ## 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)..RESUMING_LOGGING_SESSION.txt" && \
+           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" "$(basename "$PATHOUT_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 

     ## 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"
+    try tar --append --directory="$DIR_TMP" --file="$PATHOUT_TAR" "VERSION" && \
+       vbm "DEBUG:VERSION added to $PATHOUT_TAR";

     
     # Record gps data until script lifespan ends
     declare debugCounter; debugCounter="0"; # set debug counter
     timeStart=$(dateTimeShort); # Note start time
     while [[ "$SECONDS" -lt "$scriptTTL" ]]; do
        # Determine file paths (time is start of buffer period)
     
     # Record gps data until script lifespan ends
     declare debugCounter; debugCounter="0"; # set debug counter
     timeStart=$(dateTimeShort); # Note start time
     while [[ "$SECONDS" -lt "$scriptTTL" ]]; do
        # Determine file paths (time is start of buffer period)

-       FILEOUT_BASENAME="$timeStart""--""$bufferTTL_STR""..""$SCRIPT_HOSTNAME""_location" ; # ISO-8601 YYYYmmddTHHMMSS+zzP[$bufferTTL]S
-       ## Files saved to tmpfs memory (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_BASENAME="$timeStart""--""$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";

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

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

        # 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 "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";
            vbm "DEBUG:Appended NMEA location data $PATHOUT_NMEA to $PATHOUT_TAR";

-       try tar --append --directory="$(dirname $"PATHOUT_GPX")" --file="$PATHOUT_TAR" "$(basename "$PATHOUT_GPX")" && \
+       try tar --append --directory="$DIR_TMP" --file="$PATHOUT_TAR" "$(basename "$PATHOUT_GPX")" && \

            vbm "DEBUG:Appended GPX location data $PATHOUT_GPX to $PATHOUT_TAR";
            vbm "DEBUG:Appended GPX location data $PATHOUT_GPX to $PATHOUT_TAR";

-       try tar --append --directory="$(dirname $"PATHOUT_KML")" --file="$PATHOUT_TAR" "$(basename "$PATHOUT_KML")" && \
+       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
            vbm "DEBUG:Appended KML location $PATHOUT_KML to $PATHOUT_TAR";
        # Remove secured chunks from DIR_TMP

-       try rm "$PATHOUT_NMEA" "$PATHOUT_NMEA" "$PATHOUT_NMEA";
+       try rm "$PATHOUT_NMEA" "$PATHOUT_GPX" "$PATHOUT_KML";

        # Reset buffer and filenames
        unset bufferBash FILEOUT_BASENAME PATHOUT_NMEA PATHOUT_GPX PATHOUT_KML PATHOUT_TAR;
        # Reset buffer and filenames
        unset bufferBash FILEOUT_BASENAME PATHOUT_NMEA PATHOUT_GPX PATHOUT_KML PATHOUT_TAR;

+       vbm "DEBUG:Completed buffer session $debugCounter ." 1>&2;

        ((debugCounter++))
     done
        ((debugCounter++))
     done

+
+    # Remove DIR_TMP
+    try rm -r "$DIR_TMP";

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