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

#!/bin/bash

# Desc: Records gps data until midnight
# Author: Steven Baltakatei Sandoval; License: GPLv3+
# 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)
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_DATE_SHORT="$(date +%Y%m%d)"          # Save current date in ISO-8601 format.

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

#===BEGIN Declare local script functions===
checkapp() {
    # Desc: If arg is a command, save result in assoc array 'appRollCall'
    # Usage: checkapp arg1 arg2 arg3 ...
    # Input: global assoc. array 'appRollCall'
    # Output: adds/updates key(value) to global assoc array 'appRollCall'
    local returnState    
    #echo "DEBUG:$(date +%S.%N)..Starting checkapp function."
    #echo "DEBUG:args: $@"
    #echo "DEBUG:returnState:$returnState"

    #===Process Args===
    for arg in "$@"; do
	#echo "DEBUG:processing arg:$arg"
	if command -v "$arg" 1>/dev/null 2>&1; then # Check if arg is a valid command
	    appRollCall[$arg]="true";
	    #echo "DEBUG:appRollCall[$arg]:"${appRollCall[$arg]}
	    if ! [ "$returnState" = "false" ]; then returnState="true"; fi
	else
	    appRollCall[$arg]="false"; returnState="false";
	fi
    done
    
    #for key in "${!appRollCall[@]}"; do echo "DEBUG:$key => ${appRollCall[$key]}"; done
    #echo "DEBUG:evaluating returnstate. returnState:"$returnState

    #===Determine function return code===
    if [ "$returnState" = "true" ]; then
	#echo "DEBUG:checkapp returns true for $arg";
	return 0;
    else
	#echo "DEBUG:checkapp returns false for $arg";
	return 1;
    fi
} # Check that app exists
checkfile() {
    # Desc: If arg is a file path, save result in assoc array 'fileRollCall'
    # Usage: checkfile arg1 arg2 arg3 ...
    # Input: global assoc. array 'fileRollCall'
    # Output: adds/updates key(value) to global assoc array 'fileRollCall';
    # Output: returns 0 if app found, 1 otherwise
    local returnState

    #===Process Args===
    for arg in "$@"; do
	#echo "DEBUG:processing arg:$arg"
	if [ -f "$arg" ]; then
	    fileRollCall["$arg"]="true";
	    #echo "DEBUG:fileRollCall[\"$arg\"]:"${fileRollCall["$arg"]}
	    if ! [ "$returnState" = "false" ]; then returnState="true"; fi
	else
	    fileRollCall["$arg"]="false"; returnState="false";
	fi
    done

    #for key in "${!fileRollCall[@]}"; do echo "DEBUG:fileRollCall key [$key] is:${fileRollCall[$key]}"; done
    #echo "DEBUG:evaluating returnstate. returnState:"$returnState
    
    #===Determine function return code===
    if [ "$returnState" = "true" ]; then
	#echo "DEBUG:checkapp returns true for $arg";
	return 0;
    else
	#echo "DEBUG:checkapp returns false for $arg";
	return 1;
    fi
} # Check that file exists
checkdir() {
    # Desc: If arg is a dir path, save result in assoc array 'dirRollCall'
    # Usage: checkdir arg1 arg2 arg3 ...
    # Input: global assoc. array 'dirRollCall'
    # Output: adds/updates key(value) to global assoc array 'dirRollCall';
    # Output: returns 0 if app found, 1 otherwise
    local returnState

    #===Process Args===
    for arg in "$@"; do
	#echo "DEBUG:processing arg:$arg"
	if [ -d "$arg" ]; then
	    dirRollCall["$arg"]="true";
	    #echo "DEBUG:dirRollCall[\"$arg\"]:"${dirRollCall["$arg"]}
	    if ! [ "$returnState" = "false" ]; then returnState="true"; fi
	elif [ "$arg" = "" ]; then
	    dirRollCall["$arg"]="false"; returnState="false";
	else
	    returnState="false";
	fi
    done

    #for key in "${!dirRollCall[@]}"; do echo "DEBUG:dirRollCall key [$key] is:${dirRollCall[$key]}"; done
    #echo "DEBUG:evaluating returnstate. returnState:"$returnState
    
    #===Determine function return code===
    if [ "$returnState" = "true" ]; then
	#echo "DEBUG:checkapp returns true for $arg";
	return 0;
    else
	#echo "DEBUG:checkapp returns false for $arg";
	return 1;
    fi
} # Check that dir exists

# Yell, Die, Try Three-Fingered Claw technique
# Ref/Attrib: https://stackoverflow.com/a/25515370
yell() { echo "$0: $*" >&2; }
die() { yell "$*"; exit 111; }
try() { "$@" || die "cannot $*"; }

echoerr() {
    echo "$@" 1>&2; # Define stderr echo function.
} # Define stderr message function.
showUsage() {
    echoerr "USAGE:"
    echoerr "    bkgpslog [ options ]"
    echoerr
    echoerr "OPTIONS:"
    echoerr "    -h, --help"
    echoerr "            Display help information."
    echoerr
    echoerr "    --version"
    echoerr "            Display script version."
    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
    echoerr "EXAMPLE: (bash script lines)"
    echoerr "/bin/bash bkgpslog -e \\"
    echoerr "-r age1mrmfnwhtlprn4jquex0ukmwcm7y2nxlphuzgsgv8ew2k9mewy3rs8u7su5 \\"
    echoerr "-r age1ala848kqrvxc88rzaauc6vc5v0fqrvef9dxyk79m0vjea3hagclswu0lgq \\"
    echoerr "-o ~/Sync/Location"
} # Display information on how to use this script.
showVersion() {
    echoerr "$SCRIPT_VERSION"
} # Display script version.
vbm() {
    # Usage: vbm "DEBUG:verbose message here"
    # Description: Prints verbose message ("vbm") to stderr if OPTION_VERBOSE is set to "true".
    # Input:
    #   - OPTION_VERBOSE  variable set by processArguments function. (ex: "true", "false")
    #   - "$@"            positional arguments fed to this function.
    # Output: stderr
    # Script function dependencies: echoerr
    # External function dependencies: echo
    # Last modified: 2020-04-11T23:57Z
    # Last modified by: Steven Baltakatei Sandoval
    # License: GPLv3+
    # Ref./Attrib:

    if [ "$OPTION_VERBOSE" = "true" ]; then
	FUNCTION_TIME=$(date --iso-8601=ns); # Save current time in nano seconds.
	echoerr "[$FUNCTION_TIME] ""$*"; # Display argument text.
    fi

    # End function
    return 0; # Function finished.
} # 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:""$*"
	case "$1" in
	    -h | --help) showUsage; exit 1;; # Display usage.
	    --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.
	    -e | --encrypt) OPTION_ENCRYPT="true"; vbm "DEBUG:Encrypted output mode enabled.";;
	    -r | --recipient) # Add 'age' recipient via public key string
		recPubKeys+=("$2"); shift;;
	    *) echoerr "ERROR: Unrecognized argument."; exit 1;; # Handle unrecognized options.
	esac
	shift
    done
} # Argument Processing
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
    # 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_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";
    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)
    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.
    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
		    yell "ERROR:Exit code ""$?"". Invalid recipient pubkey string. Exiting."; exit 1; fi
	    done
	else
	    yell "ERROR:Encryption enabled but \"age\" not found. Exiting."; exit 1;
	fi
    fi
    
    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;

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

	# Record gps data until script lifespan ends
	declare debugCounter; debugCounter="0"
	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" ; # ISO-8601 YYYYmmddTHHMMSS+zzP[$bufferTTL]S
	    FILEOUT_NMEA="$FILEOUT_BASENAME".nmea ;
	    FILEOUT_GPX="$FILEOUT_BASENAME".gpx ;
	    FILEOUT_KML="$FILEOUT_BASENAME".kml ;
	    # Fill buffer
	    buffer="$(timeout "$bufferTTL""s" gpspipe -r)"; # Record gpspipe nmea data to buffer for bufferTTL seconds
	    # Process and save buffers
	    echo "$buffer"                                     > "$DIROUT"/"$FILEOUT_NMEA" & # Save NMEA format
	    echo "$buffer" | gpsbabel -i nmea -f - -o gpx -F - > "$DIROUT"/"$FILEOUT_GPX"  & # Save GPX format
	    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 FILEOUT_BASENAME FILEOUT_NMEA FILEOUT_GPX FILEOUT_KML;
	done
    fi
} # Main function.
#===END Declare local script functions===
#==END Define script parameters==


#==BEGIN Perform work and exit==
main "$@" # Run main function.
exit 0;
#==END Perform work and exit==


    #gpspipe -r -d -l -o "$DIROUT1"/"$FILEOUT1" ;
Commit	Line	Data
032f4b05 SBS	1	#!/bin/bash
032f4b05 SBS	2
8fbca23d SBS	3	# Desc: Records gps data until midnight
	4	# Author: Steven Baltakatei Sandoval; License: GPLv3+
	5	# Usage: bkgpslog --output [output dir]
032f4b05	6
8fbca23d	7	#==BEGIN Define script parameters==
032f4b05 SBS	8	PATH="/opt/bktei:$PATH" # Add default baltakatei script install directory to PATH (necessary for other bk scripts)
	9	SCRIPT_HOSTNAME=$(hostname) # Save hostname of system running this script.
	10	SCRIPT_VERSION="bkgpslog 0.0.1" # Define version of script.
	11	SCRIPT_TIME_SHORT="$(date +%Y%m%dT%H%M%S%z)" # Save current date & time in ISO-8601 format.
	12	SCRIPT_DATE_SHORT="$(date +%Y%m%d)" # Save current date in ISO-8601 format.
8fbca23d SBS	13
	14	declare -Ag appRollCall # Associative array for storing app status
	15	declare -Ag fileRollCall # Associative array for storing file status
	16	declare -Ag dirRollCall # Associative array for storing dir status
17d49005	17	declare -a recPubKeys # for processArguments function
8fbca23d SBS	18
	19	#===BEGIN Declare local script functions===
	20	checkapp() {
	21	# Desc: If arg is a command, save result in assoc array 'appRollCall'
	22	# Usage: checkapp arg1 arg2 arg3 ...
	23	# Input: global assoc. array 'appRollCall'
	24	# Output: adds/updates key(value) to global assoc array 'appRollCall'
	25	local returnState
	26	#echo "DEBUG:$(date +%S.%N)..Starting checkapp function."
	27	#echo "DEBUG:args: $@"
	28	#echo "DEBUG:returnState:$returnState"
	29
	30	#===Process Args===
	31	for arg in "$@"; do
	32	#echo "DEBUG:processing arg:$arg"
0b3dde05	33	if command -v "$arg" 1>/dev/null 2>&1; then # Check if arg is a valid command
8fbca23d SBS	34	appRollCall[$arg]="true";
	35	#echo "DEBUG:appRollCall[$arg]:"${appRollCall[$arg]}
	36	if ! [ "$returnState" = "false" ]; then returnState="true"; fi
	37	else
	38	appRollCall[$arg]="false"; returnState="false";
	39	fi
	40	done
	41
	42	#for key in "${!appRollCall[@]}"; do echo "DEBUG:$key => ${appRollCall[$key]}"; done
	43	#echo "DEBUG:evaluating returnstate. returnState:"$returnState
	44
	45	#===Determine function return code===
	46	if [ "$returnState" = "true" ]; then
	47	#echo "DEBUG:checkapp returns true for $arg";
	48	return 0;
	49	else
	50	#echo "DEBUG:checkapp returns false for $arg";
	51	return 1;
	52	fi
	53	} # Check that app exists
	54	checkfile() {
	55	# Desc: If arg is a file path, save result in assoc array 'fileRollCall'
	56	# Usage: checkfile arg1 arg2 arg3 ...
	57	# Input: global assoc. array 'fileRollCall'
	58	# Output: adds/updates key(value) to global assoc array 'fileRollCall';
	59	# Output: returns 0 if app found, 1 otherwise
	60	local returnState
	61
	62	#===Process Args===
	63	for arg in "$@"; do
	64	#echo "DEBUG:processing arg:$arg"
	65	if [ -f "$arg" ]; then
	66	fileRollCall["$arg"]="true";
	67	#echo "DEBUG:fileRollCall[\"$arg\"]:"${fileRollCall["$arg"]}
	68	if ! [ "$returnState" = "false" ]; then returnState="true"; fi
	69	else
	70	fileRollCall["$arg"]="false"; returnState="false";
	71	fi
	72	done
	73
	74	#for key in "${!fileRollCall[@]}"; do echo "DEBUG:fileRollCall key [$key] is:${fileRollCall[$key]}"; done
	75	#echo "DEBUG:evaluating returnstate. returnState:"$returnState
	76
	77	#===Determine function return code===
	78	if [ "$returnState" = "true" ]; then
	79	#echo "DEBUG:checkapp returns true for $arg";
	80	return 0;
	81	else
	82	#echo "DEBUG:checkapp returns false for $arg";
	83	return 1;
	84	fi
	85	} # Check that file exists
	86	checkdir() {
	87	# Desc: If arg is a dir path, save result in assoc array 'dirRollCall'
	88	# Usage: checkdir arg1 arg2 arg3 ...
	89	# Input: global assoc. array 'dirRollCall'
	90	# Output: adds/updates key(value) to global assoc array 'dirRollCall';
	91	# Output: returns 0 if app found, 1 otherwise
	92	local returnState
	93
	94	#===Process Args===
	95	for arg in "$@"; do
	96	#echo "DEBUG:processing arg:$arg"
	97	if [ -d "$arg" ]; then
98	dirRollCall["$arg"]="true";
99	#echo "DEBUG:dirRollCall[\"$arg\"]:"${dirRollCall["$arg"]}
100	if ! [ "$returnState" = "false" ]; then returnState="true"; fi
bcf09dcc	101	elif [ "$arg" = "" ]; then
8fbca23d	102	dirRollCall["$arg"]="false"; returnState="false";
bcf09dcc SBS	103	else
bcf09dcc SBS	104	returnState="false";
8fbca23d SBS	105	fi
	106	done
	107
	108	#for key in "${!dirRollCall[@]}"; do echo "DEBUG:dirRollCall key [$key] is:${dirRollCall[$key]}"; done
	109	#echo "DEBUG:evaluating returnstate. returnState:"$returnState
	110
	111	#===Determine function return code===
	112	if [ "$returnState" = "true" ]; then
	113	#echo "DEBUG:checkapp returns true for $arg";
	114	return 0;
	115	else
	116	#echo "DEBUG:checkapp returns false for $arg";
	117	return 1;
	118	fi
	119	} # Check that dir exists
032f4b05	120
c609b9c8 SBS	121	# Yell, Die, Try Three-Fingered Claw technique
	122	# Ref/Attrib: https://stackoverflow.com/a/25515370
	123	yell() { echo "$0: $*" >&2; }
	124	die() { yell "$*"; exit 111; }
	125	try() { "$@" \|\| die "cannot $*"; }
	126
032f4b05 SBS	127	echoerr() {
	128	echo "$@" 1>&2; # Define stderr echo function.
	129	} # Define stderr message function.
	130	showUsage() {
	131	echoerr "USAGE:"
94e094d1	132	echoerr " bkgpslog [ options ]"
032f4b05 SBS	133	echoerr
	134	echoerr "OPTIONS:"
	135	echoerr " -h, --help"
	136	echoerr " Display help information."
	137	echoerr
	138	echoerr " --version"
	139	echoerr " Display script version."
	140	echoerr
	141	echoerr " -v, --verbose"
	142	echoerr " Display debugging info."
	143	echoerr
17d49005 SBS	144	echoerr " -e, --encrypt"
	145	echoerr " Encrypt output."
	146	echoerr
	147	echoerr " -r, --recipient [ pubkey string ]"
	148	echoerr " Specify recipient."
	149	echoerr
032f4b05 SBS	150	echoerr " -o, --output [ directory ]"
032f4b05 SBS	151	echoerr " Specify output directory to save logs."
17d49005 SBS	152	echoerr
	153	echoerr "EXAMPLE: (bash script lines)"
	154	echoerr "/bin/bash bkgpslog -e \\"
	155	echoerr "-r age1mrmfnwhtlprn4jquex0ukmwcm7y2nxlphuzgsgv8ew2k9mewy3rs8u7su5 \\"
	156	echoerr "-r age1ala848kqrvxc88rzaauc6vc5v0fqrvef9dxyk79m0vjea3hagclswu0lgq \\"
	157	echoerr "-o ~/Sync/Location"
032f4b05 SBS	158	} # Display information on how to use this script.
	159	showVersion() {
	160	echoerr "$SCRIPT_VERSION"
	161	} # Display script version.
	162	vbm() {
0b3dde05 SBS	163	# Usage: vbm "DEBUG:verbose message here"
	164	# Description: Prints verbose message ("vbm") to stderr if OPTION_VERBOSE is set to "true".
	165	# Input:
	166	# - OPTION_VERBOSE variable set by processArguments function. (ex: "true", "false")
	167	# - "$@" positional arguments fed to this function.
	168	# Output: stderr
	169	# Script function dependencies: echoerr
	170	# External function dependencies: echo
	171	# Last modified: 2020-04-11T23:57Z
	172	# Last modified by: Steven Baltakatei Sandoval
	173	# License: GPLv3+
	174	# Ref./Attrib:
	175
	176	if [ "$OPTION_VERBOSE" = "true" ]; then
	177	FUNCTION_TIME=$(date --iso-8601=ns); # Save current time in nano seconds.
	178	echoerr "[$FUNCTION_TIME] ""$*"; # Display argument text.
032f4b05	179	fi
0b3dde05 SBS	180
	181	# End function
	182	return 0; # Function finished.
032f4b05 SBS	183	} # Verbose message display function.
	184	processArguments() {
	185	while [ ! $# -eq 0 ]; do # While number of arguments ($#) is not (!) equal to (-eq) zero (0).
d6896d3b SBS	186	#echoerr "DEBUG:Starting processArguments while loop."
d6896d3b SBS	187	#echoerr "DEBUG:Provided arguments are:""$*"
032f4b05	188	case "$1" in
c1bbf9f7	189	-h \| --help) showUsage; exit 1;; # Display usage.
032f4b05	190	--version) showVersion; exit 1;; # Show version
c1bbf9f7 SBS	191	-v \| --verbose) OPTION_VERBOSE="true"; vbm "DEBUG:Verbose mode enabled.";; # Enable verbose mode.
c1bbf9f7 SBS	192	-o \| --output) if [ -d "$2" ]; then DIROUT="$2"; vbm "DEBUG:DIROUT:$DIROUT"; shift; fi ;; # Define output directory.
17d49005 SBS	193	-e \| --encrypt) OPTION_ENCRYPT="true"; vbm "DEBUG:Encrypted output mode enabled.";;
	194	-r \| --recipient) # Add 'age' recipient via public key string
	195	recPubKeys+=("$2"); shift;;
032f4b05 SBS	196	*) echoerr "ERROR: Unrecognized argument."; exit 1;; # Handle unrecognized options.
	197	esac
	198	shift
	199	done
	200	} # Argument Processing
c2aaff78 SBS	201	timeUntilNextDay(){
	202	# Desc: Report seconds until next day.
	203	# Output: stdout: integer seconds until next day
8fbca23d	204	# Output: exit code 0 if stdout > 0; 1 if stdout = 0; 2 if stdout < 0
c2aaff78 SBS	205	# Usage: timeUntilNextDay
	206	# Usage: if ! myTTL="$(timeUntilNextDay)"; then yell "ERROR in if statement"; exit 1; fi
	207	local returnState TIME_CURRENT TIME_NEXT_DAY SECONDS_UNTIL_NEXT_DAY
8fbca23d	208	TIME_CURRENT="$(date --iso-8601=seconds)" ; # Produce `date`-parsable current timestamp with resolution of 1 second.
c2aaff78 SBS	209	TIME_NEXT_DAY="$(date -d "$TIME_CURRENT next day" --iso-8601=date)"; # Produce timestamp of beginning of tomorrow with resolution of 1 second.
	210	SECONDS_UNTIL_NEXT_DAY="$(( $(date +%s -d "$TIME_NEXT_DAY") - $(date +%s -d "$TIME_CURRENT") ))" ; # Calculate seconds until closest future midnight (res. 1 second).
	211	if [[ "$SECONDS_UNTIL_NEXT_DAY" -gt 0 ]]; then
	212	returnState="true";
	213	elif [[ "$SECONDS_UNTIL_NEXT_DAY" -eq 0 ]]; then
	214	returnState="WARNING_ZERO";
	215	yell "WARNING:Reported time until next day exactly zero.";
	216	elif [[ "$SECONDS_UNTIL_NEXT_DAY" -lt 0 ]]; then
	217	returnState="WARNING_NEGATIVE";
	218	yell "WARNING:Reported time until next day is negative.";
	219	fi
	220
	221	try echo "$SECONDS_UNTIL_NEXT_DAY"; # Report
	222
	223	#===Determine function return code===
	224	if [[ "$returnState" = "true" ]]; then
	225	return 0;
	226	elif [[ "$returnState" = "WARNING_ZERO" ]]; then
	227	return 1;
	228	elif [[ "$returnState" = "WARNING_NEGATIVE" ]]; then
	229	return 2;
	230	fi
	231	} # Report seconds until next day
	232	timeUntilNextHour(){
	233	# Desc: Report seconds until next hour
	234	# Output: stdout: integer seconds until next hour
	235	# Output: exit code 0 if stdout > 0; 1 if stdout = 0; 2 if stdout < 0
	236	# Usage: timeUntilNextHour
	237	# Usage: if ! myTTL="$(timeUntilNextHour)"; then yell "ERROR in if statement"; exit 1; fi
	238	local returnState TIME_CURRENT TIME_NEXT_HOUR SECONDS_UNTIL_NEXT_HOUR
	239	TIME_CURRENT="$(date --iso-8601=seconds)"; # Produce `date`-parsable current timestamp with resolution of 1 second.
	240	TIME_NEXT_HOUR="$(date -d "$TIME_CURRENT next hour" --iso-8601=hours)"; # Produce `date`-parsable current time stamp with resolution of 1 second.
	241	SECONDS_UNTIL_NEXT_HOUR="$(( $(date +%s -d "$TIME_NEXT_HOUR") - $(date +%s -d "$TIME_CURRENT") ))"; # Calculate seconds until next hour (res. 1 second).
	242	if [[ "$SECONDS_UNTIL_NEXT_HOUR" -gt 0 ]]; then
8fbca23d	243	returnState="true";
c2aaff78	244	elif [[ "$SECONDS_UNTIL_NEXT_HOUR" -eq 0 ]]; then
8fbca23d	245	returnState="WARNING_ZERO";
c2aaff78 SBS	246	yell "WARNING:Reported time until next hour exactly zero.";
c2aaff78 SBS	247	elif [[ "$SECONDS_UNTIL_NEXT_HOUR" -lt 0 ]]; then
8fbca23d	248	returnState="WARNING_NEGATIVE";
c2aaff78	249	yell "WARNING:Reported time until next hour is negative.";
8fbca23d	250	fi
032f4b05	251
c2aaff78	252	try echo "$SECONDS_UNTIL_NEXT_HOUR"; # Report
8fbca23d SBS	253
	254	#===Determine function return code===
	255	if [[ "$returnState" = "true" ]]; then
	256	return 0;
	257	elif [[ "$returnState" = "WARNING_ZERO" ]]; then
	258	return 1;
	259	elif [[ "$returnState" = "WARNING_NEGATIVE" ]]; then
	260	return 2;
	261	fi
c2aaff78	262	} # Report seconds until next hour
8fbca23d SBS	263	dateTimeShort(){
	264	# Desc: Timestamp without separators (YYYYmmddTHHMMSS+zzzz)
	265	# Usage: dateTimeShort
	266	# Output: stdout: timestamp (ISO-8601, no separators)
c2aaff78	267	local TIME_CURRENT TIME_CURRENT_SHORT
8fbca23d SBS	268	TIME_CURRENT="$(date --iso-8601=seconds)" ; # Produce `date`-parsable current timestamp with resolution of 1 second.
	269	TIME_CURRENT_SHORT="$(date -d "$TIME_CURRENT" +%Y%m%dT%H%M%S%z)"; # Produce separator-less current timestamp with resolution 1 second.
	270	echo "$TIME_CURRENT_SHORT";
	271	} # Get date&time without separators
032f4b05	272	main() {
0b3dde05	273	processArguments "$@" # Process arguments.
17d49005 SBS	274	if [[ "$OPTION_ENCRYPT" = "true" ]]; then # Check if encryption option active.
	275	if checkapp age; then # Check that age is available.
	276	for pubkey in "${recPubKeys[@]}"; do # Validate recipient pubkey strings by forming test message
	277	vbm "DEBUG:Testing pubkey string:$pubkey"
	278	if ! echo "butts" \| age -a -r "$pubkey" 1>/dev/null; then
	279	yell "ERROR:Exit code ""$?"". Invalid recipient pubkey string. Exiting."; exit 1; fi
	280	done
	281	else
	282	yell "ERROR:Encryption enabled but \"age\" not found. Exiting."; exit 1;
	283	fi
	284	fi
	285
8fbca23d	286	if checkapp gpspipe && checkdir "$DIROUT"; then
17d49005	287
c2aaff78 SBS	288	# # Set script lifespan to end at start of next day
	289	# if ! scriptTTL="$(timeUntilNextDay)"; then
	290	# if [[ "$scriptTTL" -eq 0 ]]; then
	291	# ((scriptTTL++)); # Add 1 because 0 would cause 'timeout' to never timeout.
	292	# else
	293	# yell "ERROR: timeUntilNextDay exit code $?"; exit 1;
	294	# fi;
	295	# fi;
032f4b05	296
c2aaff78 SBS	297	# Set script lifespan to end at start of next hour
	298	if ! scriptTTL="$(timeUntilNextHour)"; then
	299	if [[ "$scriptTTL" -eq 0 ]]; then
	300	((scriptTTL++)); # Add 1 because 0 would cause 'timeout' to never timeout.
	301	else
	302	yell "ERROR: timeUntilNextHour exit code $?"; exit 1;
	303	fi;
	304	fi;
8fbca23d SBS	305
8fbca23d SBS	306	# Determine buffer lifespan
94e094d1	307	bufferTTL="60";
032f4b05	308
5b601ed5	309	# Record gps data until script lifespan ends
8fbca23d SBS	310	declare debugCounter; debugCounter="0"
	311	while [[ "$SECONDS" -lt "$scriptTTL" ]]; do
	312	((debugCounter++))
b9a85f63	313	# Determine output file paths (time is start of buffer period)
fde89ac0	314	FILEOUT_BASENAME="$(dateTimeShort)""--P""$bufferTTL""S..""$SCRIPT_HOSTNAME""_location" ; # ISO-8601 YYYYmmddTHHMMSS+zzP[$bufferTTL]S
20dae002 SBS	315	FILEOUT_NMEA="$FILEOUT_BASENAME".nmea ;
	316	FILEOUT_GPX="$FILEOUT_BASENAME".gpx ;
	317	FILEOUT_KML="$FILEOUT_BASENAME".kml ;
b9a85f63 SBS	318	# Fill buffer
	319	buffer="$(timeout "$bufferTTL""s" gpspipe -r)"; # Record gpspipe nmea data to buffer for bufferTTL seconds
	320	# Process and save buffers
	321	echo "$buffer" > "$DIROUT"/"$FILEOUT_NMEA" & # Save NMEA format
	322	echo "$buffer" \| gpsbabel -i nmea -f - -o gpx -F - > "$DIROUT"/"$FILEOUT_GPX" & # Save GPX format
	323	echo "$buffer" \| gpsbabel -i nmea -f - -o kml -F - > "$DIROUT"/"$FILEOUT_KML" & # Save KML format
94e094d1	324	vbm "DEBUG:Completed buffer session $debugCounter ." 1>&2;
f8ea736f	325	# Reset buffer and filenames
d4ead4d1	326	unset buffer FILEOUT_BASENAME FILEOUT_NMEA FILEOUT_GPX FILEOUT_KML;
8fbca23d SBS	327	done
	328	fi
	329	} # Main function.
	330	#===END Declare local script functions===
	331	#==END Define script parameters==
032f4b05 SBS	332
032f4b05 SBS	333
8fbca23d SBS	334	#==BEGIN Perform work and exit==
	335	main "$@" # Run main function.
	336	exit 0;
	337	#==END Perform work and exit==
032f4b05 SBS	338
032f4b05 SBS	339
032f4b05 SBS	340
032f4b05 SBS	341	#gpspipe -r -d -l -o "$DIROUT1"/"$FILEOUT1" ;