doc(location):Add html version of location README

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

diff --git a/exec/bkgpslog b/exec/bkgpslog
index 22f558bc9fdc7198d7aa43f72c073b906fb7be65..724b6e94a3cf1fef447c5d8122dad2cbdaadde76 100755 (executable)
--- a/exec/bkgpslog
+++ b/exec/bkgpslog
@@ -5,7 +5,7 @@
 # Usage: bkgpslog --output [output dir]
 
 #==BEGIN Define script parameters==
 # Usage: bkgpslog --output [output dir]
 
 #==BEGIN Define script parameters==

-PATH="/opt/bktei:$PATH"         # Add default baltakatei script install directory to PATH (necessary for other bk scripts)
+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.0.1" # Define version of script.
 SCRIPT_TIME_SHORT="$(date +%Y%m%dT%H%M%S%z)" # Save current date & time in ISO-8601 format.
 SCRIPT_HOSTNAME=$(hostname)     # Save hostname of system running this script.
 SCRIPT_VERSION="bkgpslog 0.0.1" # Define version of script.
 SCRIPT_TIME_SHORT="$(date +%Y%m%dT%H%M%S%z)" # Save current date & time in ISO-8601 format.


@@ -14,6 +14,8 @@ SCRIPT_DATE_SHORT="$(date +%Y%m%d)"          # Save current date in ISO-8601 for
 declare -Ag appRollCall # Associative array for storing app status
 declare -Ag fileRollCall # Associative array for storing file status
 declare -Ag dirRollCall # Associative array for storing dir status
 declare -Ag appRollCall # Associative array for storing app status
 declare -Ag fileRollCall # Associative array for storing file status
 declare -Ag dirRollCall # Associative array for storing dir status

+declare -a recPubKeys # for processArguments function
+declare recipients # for main function

 
 #===BEGIN Declare local script functions===
 checkapp() {
 
 #===BEGIN Declare local script functions===
 checkapp() {


@@ -128,7 +130,7 @@ echoerr() {
 } # Define stderr message function.
 showUsage() {
     echoerr "USAGE:"
 } # Define stderr message function.
 showUsage() {
     echoerr "USAGE:"

-    echoerr "    bkgpslog.sh [ options ]"
+    echoerr "    bkgpslog [ options ]"

     echoerr
     echoerr "OPTIONS:"
     echoerr "    -h, --help"
     echoerr
     echoerr "OPTIONS:"
     echoerr "    -h, --help"


@@ -140,8 +142,23 @@ showUsage() {
     echoerr "    -v, --verbose"
     echoerr "            Display debugging info."
     echoerr
     echoerr "    -v, --verbose"
     echoerr "            Display debugging info."
     echoerr

+    echoerr "    -e, --encrypt"
+    echoerr "            Encrypt output."
+    echoerr
+    echoerr "    -r, --recipient [ pubkey string ]"
+    echoerr "            Specify recipient."
+    echoerr

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

+    echoerr
+    echoerr "    -c, --compress"
+    echoerr "            Compress output with gzip (before encryption if enabled)."
+    echoerr
+    echoerr "EXAMPLE: (bash script lines)"
+    echoerr "/bin/bash bkgpslog -e -c \\"
+    echoerr "-r age1mrmfnwhtlprn4jquex0ukmwcm7y2nxlphuzgsgv8ew2k9mewy3rs8u7su5 \\"
+    echoerr "-r age1ala848kqrvxc88rzaauc6vc5v0fqrvef9dxyk79m0vjea3hagclswu0lgq \\"
+    echoerr "-o ~/Sync/Location"

 } # Display information on how to use this script.
 showVersion() {
     echoerr "$SCRIPT_VERSION"
 } # Display information on how to use this script.
 showVersion() {
     echoerr "$SCRIPT_VERSION"


@@ -170,43 +187,43 @@ vbm() {
 } # Verbose message display function.
 processArguments() {
     while [ ! $# -eq 0 ]; do   # While number of arguments ($#) is not (!) equal to (-eq) zero (0).
 } # Verbose message display function.
 processArguments() {
     while [ ! $# -eq 0 ]; do   # While number of arguments ($#) is not (!) equal to (-eq) zero (0).

-       echoerr "DEBUG:Starting processArguments while loop."
-       echoerr "DEBUG:Provided arguments are:""$*"
+       #echoerr "DEBUG:Starting processArguments while loop."
+       #echoerr "DEBUG:Provided arguments are:""$*"

        case "$1" in
        case "$1" in

-           --h | --help) showUsage; exit 1;; # Display usage.
+           -h | --help) showUsage; exit 1;; # Display usage.

            --version) showVersion; exit 1;; # Show version
            --version) showVersion; exit 1;; # Show version

-           --v | --verbose) OPTION_VERBOSE="true"; vbm "DEBUG:Verbose mode enabled.";; # Enable verbose mode.
-           --o | --output) if [ -d "$2" ]; then DIROUT="$2"; vbm "DEBUG:DIROUT:$DIROUT"; shift; fi ;; # Define output directory.
+           -v | --verbose) OPTION_VERBOSE="true"; vbm "DEBUG:Verbose mode enabled.";; # Enable verbose mode.
+           -o | --output) if [ -d "$2" ]; then DIROUT="$2"; vbm "DEBUG:DIROUT:$DIROUT"; 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;;
+           -c | --compress) OPTION_COMPRESS="true"; vbm "DEBUG:Compressed output mode enabled.";;

            *) echoerr "ERROR: Unrecognized argument."; exit 1;; # Handle unrecognized options.
        esac
        shift
     done
 } # Argument Processing
            *) echoerr "ERROR: Unrecognized argument."; exit 1;; # Handle unrecognized options.
        esac
        shift
     done
 } # Argument Processing

-timeUntilMidnight(){
-    # Desc: Report seconds until midnight
-    # Output: stdout: integer seconds until midnight
+timeUntilNextDay(){
+    # Desc: Report seconds until next day.
+    # Output: stdout: integer seconds until next day

     # Output: exit code 0 if stdout > 0; 1 if stdout = 0; 2 if stdout < 0
     # Output: exit code 0 if stdout > 0; 1 if stdout = 0; 2 if stdout < 0

-    # Usage: timeUntilMidnight
-    # Usage: if ! myTTL="$(timeUntilMidnight)"; then yell "ERROR in if statement"; exit 1; fi
-    local returnState
+    # Usage: timeUntilNextDay
+    # Usage: if ! myTTL="$(timeUntilNextDay)"; then yell "ERROR in if statement"; exit 1; fi
+    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_CURRENT="$(date --iso-8601=seconds)" ; # Produce `date`-parsable current timestamp with resolution of 1 second.

-    TIME_CURRENT_SHORT="$(date -d "$TIME_CURRENT" +%Y%m%dT%H%M%S%z)" # Produce separator-less current timestamp with resolution 1 second.
-    DATE_CURRENT="$(date -d "$TIME_CURRENT" --iso-8601=date)" ; # Produce `date`-parsable current timestamp with resolution of 1 day.
-    DATE_CURRENT_SHORT="$(date -d "$TIME_CURRENT" +%Y%m%d)" ; # Produce separator-less current timestamp with resolution 1 day.
-    DATE_TOMORROW="$(date -d "$TIME_CURRENT next day" --iso-8601=date)" ; # Produce timestamp of tomorrow's date (res. 1 day).
-    TIME_NEXT_MIDNIGHT="$(date -d "$DATE_TOMORROW" --iso-8601=seconds)" ; # Produce `date`-parsable timestamp of closest future midnight (res. 1 second).
-    SECONDS_UNTIL_NEXT_MIDNIGHT="$(( $(date +%s -d "$TIME_NEXT_MIDNIGHT") - $(date +%s -d "$TIME_CURRENT") ))" ; # Calculate seconds until closest future midnight (res. 1 second).
-    if [[ "$SECONDS_UNTIL_NEXT_MIDNIGHT" -gt 0 ]]; then
+    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";
        returnState="true";

-    elif [[ "$SECONDS_UNTIL_NEXT_MIDNIGHT" -eq 0 ]]; then
+    elif [[ "$SECONDS_UNTIL_NEXT_DAY" -eq 0 ]]; then

        returnState="WARNING_ZERO";
        returnState="WARNING_ZERO";

-       yell "WARNING:Reported time until midnight exactly zero.";
-    elif [[ "$SECONDS_UNTIL_NEXT_MIDNIGHT" -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 midnight is negative.";
+       yell "WARNING:Reported time until next day is negative.";

     fi
 
     fi
 

-    try echo "$SECONDS_UNTIL_NEXT_MIDNIGHT"; # Report
+    try echo "$SECONDS_UNTIL_NEXT_DAY"; # Report

     
     #===Determine function return code===
     if [[ "$returnState" = "true" ]]; then
     
     #===Determine function return code===
     if [[ "$returnState" = "true" ]]; then


@@ -216,36 +233,134 @@ timeUntilMidnight(){
     elif [[ "$returnState" = "WARNING_NEGATIVE" ]]; then
        return 2;
     fi
     elif [[ "$returnState" = "WARNING_NEGATIVE" ]]; then
        return 2;
     fi

-} # Report seconds until next midnight
+} # Report seconds until next day
+timeUntilNextHour(){
+    # Desc: Report seconds until next hour
+    # 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.
+    SECONDS_UNTIL_NEXT_HOUR="$(( $(date +%s -d "$TIME_NEXT_HOUR") - $(date +%s -d "$TIME_CURRENT") ))"; # Calculate seconds until next hour (res. 1 second).
+    if [[ "$SECONDS_UNTIL_NEXT_HOUR" -gt 0 ]]; then
+       returnState="true";
+    elif [[ "$SECONDS_UNTIL_NEXT_HOUR" -eq 0 ]]; then
+       returnState="WARNING_ZERO";
+       yell "WARNING:Reported time until next hour exactly zero.";
+    elif [[ "$SECONDS_UNTIL_NEXT_HOUR" -lt 0 ]]; then
+       returnState="WARNING_NEGATIVE";
+       yell "WARNING:Reported time until next hour is negative.";
+    fi
+
+    try echo "$SECONDS_UNTIL_NEXT_HOUR"; # Report
+    
+    #===Determine function return code===
+    if [[ "$returnState" = "true" ]]; then
+       return 0;
+    elif [[ "$returnState" = "WARNING_ZERO" ]]; then
+       return 1;
+    elif [[ "$returnState" = "WARNING_NEGATIVE" ]]; then
+       return 2;
+    fi
+} # Report seconds until next hour

 dateTimeShort(){
     # Desc: Timestamp without separators (YYYYmmddTHHMMSS+zzzz)
     # Usage: dateTimeShort
     # Output: stdout: timestamp (ISO-8601, no separators)
 dateTimeShort(){
     # Desc: Timestamp without separators (YYYYmmddTHHMMSS+zzzz)
     # Usage: dateTimeShort
     # Output: stdout: timestamp (ISO-8601, no separators)

+    local TIME_CURRENT TIME_CURRENT_SHORT

     TIME_CURRENT="$(date --iso-8601=seconds)" ; # Produce `date`-parsable current timestamp with resolution of 1 second.
     TIME_CURRENT_SHORT="$(date -d "$TIME_CURRENT" +%Y%m%dT%H%M%S%z)"; # Produce separator-less current timestamp with resolution 1 second.
     echo "$TIME_CURRENT_SHORT";
 } # Get date&time without separators
 main() {
     processArguments "$@" # Process arguments.
     TIME_CURRENT="$(date --iso-8601=seconds)" ; # Produce `date`-parsable current timestamp with resolution of 1 second.
     TIME_CURRENT_SHORT="$(date -d "$TIME_CURRENT" +%Y%m%dT%H%M%S%z)"; # Produce separator-less current timestamp with resolution 1 second.
     echo "$TIME_CURRENT_SHORT";
 } # Get date&time without separators
 main() {
     processArguments "$@" # Process arguments.

+    if [[ "$OPTION_ENCRYPT" = "true" ]]; then # Check if encryption option active.
+       if checkapp age; then # Check that age is available.
+           for pubkey in "${recPubKeys[@]}"; do # Validate recipient pubkey strings by forming test message
+               vbm "DEBUG:Testing pubkey string:$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 "DEBUG:recipients:""$recipients";
+               else
+                   yell "ERROR:Exit code ""$?"". Invalid recipient pubkey string. Exiting."; exit 1;
+               fi
+           done
+           vbm "DEBUG:Finished processing recPubKeys array";
+           # Form age command string
+           CMD_ENCRYPT="age ""$recipients ";
+           CMD_ENCRYPT_SUFFIX=".age";
+       else
+           yell "ERROR:Encryption enabled but \"age\" not found. Exiting."; exit 1;
+       fi
+    else
+       CMD_ENCRYPT="tee /dev/null ";
+       CMD_ENCRYPT_SUFFIX="";
+       vbm "DEBUG:Encryption not enabled."
+    fi
+
+    if [[ "$OPTION_COMPRESS" = "true" ]]; then # Check if compression option active
+       if checkapp gzip; then # Check if gzip available
+           CMD_COMPRESS="gzip ";
+           CMD_COMPRESS_SUFFIX=".gz";
+       else
+           yell "ERROR:Compression enabled but \"gzip\" not found. Exiting."; exit 1;
+       fi
+    else
+       CMD_COMPRESS="tee /dev/null ";
+       CMD_COMPRESS_SUFFIX="";
+       vbm "DEBUG:Compression not enabled."
+    fi
+    
+    

     if checkapp gpspipe && checkdir "$DIROUT"; then
     if checkapp gpspipe && checkdir "$DIROUT"; then

-       # Determine output file paths
-       FILEOUT_NMEA="$(dateTimeShort)".."$SCRIPT_HOSTNAME"_location.nmea ;
-       #FILEOUT_GPX="" ;
-       #FILEOUT_KML="" ;
+       
+       # # Set script lifespan to end at start of next day
+       # if ! scriptTTL="$(timeUntilNextDay)"; then
+       #     if [[ "$scriptTTL" -eq 0 ]]; then
+       #       ((scriptTTL++)); # Add 1 because 0 would cause 'timeout' to never timeout.
+       #     else
+       #       yell "ERROR: timeUntilNextDay exit code $?"; exit 1;
+       #     fi;
+       # fi;

 
 

-       # Determine script lifespan (note: exit if <= 0 since 'timeout' runs forever if provided "0s".
-       #if ! scriptTTL="$(timeUntilMidnight)"; then yell "ERROR: timeUntilMidnight exit code $?"; exit 1; fi 
-       scriptTTL="60"; #DEBUG DEBUG DEBUG DEBUG        
+       # Set script lifespan to end at start of next hour
+       if ! scriptTTL="$(timeUntilNextHour)"; then
+           if [[ "$scriptTTL" -eq 0 ]]; then
+               ((scriptTTL++)); # Add 1 because 0 would cause 'timeout' to never timeout.
+           else
+               yell "ERROR: timeUntilNextHour exit code $?"; exit 1;
+           fi;
+       fi;

         
        # Determine buffer lifespan
         
        # Determine buffer lifespan

-       bufferTTL="15";
+       bufferTTL="60";

 
 

-       # Record gps data until life ends
+       # Record gps data until script lifespan ends

        declare debugCounter; debugCounter="0"
        while [[ "$SECONDS" -lt "$scriptTTL" ]]; do
            ((debugCounter++))
        declare debugCounter; debugCounter="0"
        while [[ "$SECONDS" -lt "$scriptTTL" ]]; do
            ((debugCounter++))

-           timeout "$bufferTTL""s" gpspipe -r 1>> "$DIROUT"/"$FILEOUT_NMEA""$debugCounter"
-           vbm "DEBUG:Completed buffer session $debugCounter" 1>&2;
+           # Determine output file paths (time is start of buffer period)
+           FILEOUT_BASENAME="$(dateTimeShort)""--P""$bufferTTL""S..""$SCRIPT_HOSTNAME""_location" ; # ISO-8601 YYYYmmddTHHMMSS+zzP[$bufferTTL]S
+           FILEOUT_NMEA="$FILEOUT_BASENAME".nmea"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" ;
+           FILEOUT_GPX="$FILEOUT_BASENAME".gpx"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" ;
+           FILEOUT_KML="$FILEOUT_BASENAME".kml"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" ;
+           # Define GPS conversion commands
+           CMD_CONV_NMEA="tee /dev/null "
+           CMD_CONV_GPX="gpsbabel -i nmea -f - -o gpx -F - "
+           CMD_CONV_KML="gpsbabel -i nmea -f - -o kml -F - "
+           # Fill buffer
+           buffer="$(timeout "$bufferTTL""s" gpspipe -r)"; # Record gpspipe nmea data to buffer for bufferTTL seconds
+           # Execute processing and save command string
+           echo "$buffer" | $CMD_CONV_NMEA | $CMD_COMPRESS | $CMD_ENCRYPT > "$DIROUT"/"$FILEOUT_NMEA" & # Save NMEA format
+           echo "$buffer" | $CMD_CONV_GPX  | $CMD_COMPRESS | $CMD_ENCRYPT > "$DIROUT"/"$FILEOUT_GPX" & # Save GPX format
+           echo "$buffer" | $CMD_CONV_KML  | $CMD_COMPRESS | $CMD_ENCRYPT > "$DIROUT"/"$FILEOUT_KML" & # Save KML format
+           vbm "DEBUG:Completed buffer session $debugCounter ." 1>&2;
+           # Reset buffer and filenames
+           unset buffer FILEOUT_BASENAME FILEOUT_NMEA FILEOUT_GPX FILEOUT_KML;

        done
     fi
 } # Main function.
        done
     fi
 } # Main function.