feat(bkgpslog):Enable hour TTL, cleanup functions

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

diff --git a/exec/bkgpslog b/exec/bkgpslog
index ef7e13f393add94ca90a13aee4cd288a41f5538a..999775e8df7cbeb03b6444d78ad78948ffb2d99b 100755 (executable)
--- a/exec/bkgpslog
+++ b/exec/bkgpslog
@@ -182,31 +182,58 @@ processArguments() {
        shift
     done
 } # Argument Processing
        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";
+    elif [[ "$SECONDS_UNTIL_NEXT_DAY" -eq 0 ]]; then
+       returnState="WARNING_ZERO";
+       yell "WARNING:Reported time until next day exactly zero.";
+    elif [[ "$SECONDS_UNTIL_NEXT_DAY" -lt 0 ]]; then
+       returnState="WARNING_NEGATIVE";
+       yell "WARNING:Reported time until next day is negative.";
+    fi
+
+    try echo "$SECONDS_UNTIL_NEXT_DAY"; # 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 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";
        returnState="true";

-    elif [[ "$SECONDS_UNTIL_NEXT_MIDNIGHT" -eq 0 ]]; then
+    elif [[ "$SECONDS_UNTIL_NEXT_HOUR" -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 hour exactly zero.";
+    elif [[ "$SECONDS_UNTIL_NEXT_HOUR" -lt 0 ]]; then

        returnState="WARNING_NEGATIVE";
        returnState="WARNING_NEGATIVE";

-       yell "WARNING:Reported time until midnight is negative.";
+       yell "WARNING:Reported time until next hour is negative.";

     fi
 
     fi
 

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

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


@@ -216,11 +243,12 @@ 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 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";
     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";


@@ -229,10 +257,23 @@ main() {
     processArguments "$@" # Process arguments.
     if checkapp gpspipe && checkdir "$DIROUT"; then
 
     processArguments "$@" # Process arguments.
     if checkapp gpspipe && checkdir "$DIROUT"; then
 

+       # # 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="3600"; # 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
        bufferTTL="60";
         
        # Determine buffer lifespan
        bufferTTL="60";


@@ -242,7 +283,7 @@ main() {
        while [[ "$SECONDS" -lt "$scriptTTL" ]]; do
            ((debugCounter++))
            # Determine output file paths (time is start of buffer period)
        while [[ "$SECONDS" -lt "$scriptTTL" ]]; do
            ((debugCounter++))
            # Determine output file paths (time is start of buffer period)

-           FILEOUT_BASENAME="$(dateTimeShort)--P$(bufferTTL)S..$SCRIPT_HOSTNAME_location" ;
+           FILEOUT_BASENAME="$(dateTimeShort)""--P""$bufferTTL""S..""$SCRIPT_HOSTNAME""_location" ; # ISO-8601 YYYYmmddTHHMMSS+zzP[$bufferTTL]S

            FILEOUT_NMEA="$FILEOUT_BASENAME".nmea ;
            FILEOUT_GPX="$FILEOUT_BASENAME".gpx ;
            FILEOUT_KML="$FILEOUT_BASENAME".kml ;
            FILEOUT_NMEA="$FILEOUT_BASENAME".nmea ;
            FILEOUT_GPX="$FILEOUT_BASENAME".gpx ;
            FILEOUT_KML="$FILEOUT_BASENAME".kml ;


@@ -254,7 +295,7 @@ main() {
            echo "$buffer" | gpsbabel -i nmea -f - -o kml -F - > "$DIROUT"/"$FILEOUT_KML"  & # Save KML format
            vbm "DEBUG:Completed buffer session $debugCounter ." 1>&2;
            # Reset buffer and filenames
            echo "$buffer" | gpsbabel -i nmea -f - -o kml -F - > "$DIROUT"/"$FILEOUT_KML"  & # Save KML format
            vbm "DEBUG:Completed buffer session $debugCounter ." 1>&2;
            # Reset buffer and filenames

-           unset buffer buffer_GPX buffer_KML FILEOUT_BASENAME FILEOUT_NMEA FILEOUT_GPX FILEOUT_KML;
+           unset buffer FILEOUT_BASENAME FILEOUT_NMEA FILEOUT_GPX FILEOUT_KML;

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