From 6c30388ff903fe9c9f2c31ced53f1f7003031fac Mon Sep 17 00:00:00 2001 From: Steven Baltakatei Sandoval Date: Wed, 1 Jul 2020 18:44:52 +0000 Subject: [PATCH] feat(bkgpslog): Append to daily tar * Set version to 0.1.0. * Rewrote write loop to append location data to tar file instead of writing each file written by each buffer round directly to disk. Tar contains individually encrypted and compressed files; no attempt at merging location data between buffer rounds was attempted. * Add functions: - setTimeZoneEV (exports TZ) - dateShort (returns current date in `YYYYmmdd` format via stdout) - timeDuration (given seconds, returns ISO-8601 period; Ex: PT60S) - displayMissing (displays missing apps, files, and dirs) - setScriptTTL (sets script TTL given "day" or "hour") * Set default script TTL to "day" (was "hour") * Set default TZ to UTC. Added option `--time-zone`. --- exec/bkgpslog | 451 +++++++++++++++++++++++++++++++++++------ exec/bkgpslog-plan.org | 35 ++++ 2 files changed, 428 insertions(+), 58 deletions(-) create mode 100644 exec/bkgpslog-plan.org diff --git a/exec/bkgpslog b/exec/bkgpslog index 724b6e9..9210e15 100755 --- a/exec/bkgpslog +++ b/exec/bkgpslog @@ -5,11 +5,15 @@ # Usage: bkgpslog --output [output dir] #==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 + 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_DATE_SHORT="$(date +%Y%m%d)" # Save current date in ISO-8601 format. +SCRIPT_VERSION="bkgpslog 0.1.0" # Define version of script. +DIR_TMP="/dev/shm/$(timeStart)..bkgpslog" # Define working directory for temproary files declare -Ag appRollCall # Associative array for storing app status declare -Ag fileRollCall # Associative array for storing file status @@ -193,16 +197,56 @@ processArguments() { -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. + -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;; -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. esac shift done } # Argument Processing +setTimeZoneEV(){ + # Desc: Set time zone environment variable TZ + # Usage: setTimeZoneEV arg1 + # Input: arg1: 'date'-compatible timezone string (ex: "America/New_York") + # TZDIR env var (optional; default: "/usr/share/zoneinfo") + # Output: exports TZ + # exit code 0 on success + # exit code 1 on incorrect number of arguments + # exit code 2 if unable to validate arg1 + # Depends: yell, printenv, bash 5 + # Tested on: Debian 10 + ARG1="$1" + local tzDir returnState + if ! [[ $# -eq 1 ]]; then + yell "ERROR:Invalid argument count."; + return 1; + fi + + # Read TZDIR env var if available + if printenv TZDIR 1>/dev/null 2>&1; then + tzDir="$(printenv TZDIR)"; + else + tzDir="/usr/share/zoneinfo"; + fi + + # Validate TZ string + if ! [[ -f "$tzDir"/"$ARG1" ]]; then + yell "ERROR:Invalid time zone argument."; + return 2; + else + # Export ARG1 as TZ environment variable + TZ="$ARG1" && export TZ && returnState="true"; + fi + + # Determine function return code + if [ "$returnState" = "true" ]; then + return 0; + fi +} # Exports TZ environment variable timeUntilNextDay(){ # Desc: Report seconds until next day. # Output: stdout: integer seconds until next day @@ -273,9 +317,292 @@ dateTimeShort(){ 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 +} # Get YYYYmmddTHHMMSS±zzzz +dateShort(){ + # Desc: Date without separators (YYYYmmdd) + # Usage: dateShort + # Output: stdout: date (ISO-8601, no separators) + local TIME_CURRENT DATE_CURRENT_SHORT + TIME_CURRENT="$(date --iso-8601=seconds)" ; # Produce `date`-parsable current timestamp with resolution of 1 second. + DATE_CURRENT_SHORT="$(date -d "$TIME_CURRENT" +%Y%m%d)"; # Produce separator-less current date with resolution 1 day. + echo "$DATE_CURRENT_SHORT"; +} # Get YYYYmmdd +timeDuration(){ + # Desc: Output approximate time duration string before given time (default:current date) + # 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]) + # 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; + ARG1="$1"; + ARG2="$2"; + precision=2; # set default precision + returnState="true"; # set default return state + + # Check that between one and two arguments is supplied + if ! { [[ $# -ge 1 ]] && [[ $# -le 2 ]]; }; then + yell "ERROR:Invalid number of arguments:$# . Exiting."; + returnState="ERROR_INPUT"; fi + + # Check that arg1 provided + if [[ $# -ge 1 ]]; then + # Check that arg1 is a positive integer + if [[ "$ARG1" =~ ^[[:digit:]]+$ ]]; then + arg1Valid="true"; + else + yell "ERROR:ARG1 not a digit."; + returnState="ERROR_INPUT"; + arg1Valid="false"; + fi + else + yell "ERROR:No argument provided. Exiting."; + exit 1; + fi + + # 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"; + precision="$ARG2"; + else + yell "ERROR:ARG2 not a positive integer. (is $ARG2 ). Leaving early."; + returnState="ERROR_INPUT"; + arg2Valid="false"; + fi; + else + arg2Valid="false"; + fi; + + remainder="$ARG1" ; # seconds + ## Calculate full years Y, update remainder + fullYears=$(( remainder / (365*24*60*60) )); + remainder=$(( remainder - (fullYears*365*24*60*60) )); + ## Calculate full months M, update remainder + fullMonths=$(( remainder / (30*24*60*60) )); + remainder=$(( remainder - (fullMonths*30*24*60*60) )); + ## Calculate full days D, update remainder + fullDays=$(( remainder / (24*60*60) )); + remainder=$(( remainder - (fullDays*24*60*60) )); + ## Calculate full hours H, update remainder + fullHours=$(( remainder / (60*60) )); + remainder=$(( remainder - (fullHours*60*60) )); + ## Calculate full minutes M, update remainder + fullMinutes=$(( remainder / (60) )); + remainder=$(( remainder - (fullMinutes*60) )); + ## Calculate full seconds S, update remainder + fullSeconds=$(( remainder / (1) )); + remainder=$(( remainder - (remainder*1) )); + ## Check which fields filled + if [[ $fullYears -gt 0 ]]; then hasYears="true"; else hasYears="false"; fi + if [[ $fullMonths -gt 0 ]]; then hasMonths="true"; else hasMonths="false"; fi + if [[ $fullDays -gt 0 ]]; then hasDays="true"; else hasDays="false"; fi + if [[ $fullHours -gt 0 ]]; then hasHours="true"; else hasHours="false"; fi + if [[ $fullMinutes -gt 0 ]]; then hasMinutes="true"; else hasMinutes="false"; fi + if [[ $fullSeconds -gt 0 ]]; then hasSeconds="true"; else hasSeconds="false"; fi + + ## Determine which fields to display (see ISO-8601:2004 §4.4.3.2) + witherPrecision="false" + + ### Years + if $hasYears && [[ $precision -gt 0 ]]; then + displayYears="true"; + witherPrecision="true"; + else + displayYears="false"; + fi; + if $witherPrecision; then ((precision--)); fi; + + ### Months + if $hasMonths && [[ $precision -gt 0 ]]; then + displayMonths="true"; + witherPrecision="true"; + else + displayMonths="false"; + fi; + if $witherPrecision && [[ $precision -gt 0 ]]; then + displayMonths="true"; + fi; + if $witherPrecision; then ((precision--)); fi; + + ### Days + if $hasDays && [[ $precision -gt 0 ]]; then + displayDays="true"; + witherPrecision="true"; + else + displayDays="false"; + fi; + if $witherPrecision && [[ $precision -gt 0 ]]; then + displayDays="true"; + fi; + if $witherPrecision; then ((precision--)); fi; + + ### Hours + if $hasHours && [[ $precision -gt 0 ]]; then + displayHours="true"; + witherPrecision="true"; + else + displayHours="false"; + fi; + if $witherPrecision && [[ $precision -gt 0 ]]; then + displayHours="true"; + fi; + if $witherPrecision; then ((precision--)); fi; + + ### Minutes + if $hasMinutes && [[ $precision -gt 0 ]]; then + displayMinutes="true"; + witherPrecision="true"; + else + displayMinutes="false"; + fi; + if $witherPrecision && [[ $precision -gt 0 ]]; then + displayMinutes="true"; + fi; + if $witherPrecision; then ((precision--)); fi; + + ### Seconds + + if $hasSeconds && [[ $precision -gt 0 ]]; then + displaySeconds="true"; + witherPrecision="true"; + else + displaySeconds="false"; + fi; + if $witherPrecision && [[ $precision -gt 0 ]]; then + displaySeconds="true"; + fi; + if $witherPrecision; then ((precision--)); fi; + + + + ## Determine whether or not the "T" separator is needed to separate date and time elements + if ( $displayHours || $displayMinutes || $displaySeconds); then + displayDateTime="true"; else displayDateTime="false"; fi + + ## Construct duration output string + OUTPUT="P" + if $displayYears; then + OUTPUT=$OUTPUT$fullYears"Y"; fi + if $displayMonths; then + OUTPUT=$OUTPUT$fullMonths"M"; fi + if $displayDays; then + OUTPUT=$OUTPUT$fullDays"D"; fi + if $displayDateTime; then + OUTPUT=$OUTPUT"T"; fi + if $displayHours; then + OUTPUT=$OUTPUT$fullHours"H"; fi + if $displayMinutes; then + OUTPUT=$OUTPUT$fullMinutes"M"; fi + if $displaySeconds; then + OUTPUT=$OUTPUT$fullSeconds"S"; fi + + ## Output duration string to stdout + if [[ "$returnState" = "true" ]]; then echo "$OUTPUT"; fi + + #===Determine function return code=== + if [ "$returnState" = "true" ]; then + return 0; + else + echo "$returnState" 1>&2; + return 1; + fi + +} # Get duration (ex: PT10M4S ) +displayMissing() { + # Desc: Displays missing apps, files, and dirs + # Usage: displayMissing + # Input: associative arrays: appRollCall, fileRollCall, dirRollCall + # Output: stderr messages + #==BEGIN Display errors== + #===BEGIN Display Missing Apps=== + missingApps="Missing apps :" + #for key in "${!appRollCall[@]}"; do echo "DEBUG:$key => ${appRollCall[$key]}"; done + for key in "${!appRollCall[@]}"; do + value="${appRollCall[$key]}" + if [ "$value" = "false" ]; then + #echo "DEBUG:Missing apps: $key => $value"; + missingApps="$missingApps""$key " + appMissing="true" + fi + done + if [ "$appMissing" = "true" ]; then # Only indicate if an app is missing. + echo "$missingApps" 1>&2; + fi + #===END Display Missing Apps=== + + #===BEGIN Display Missing Files=== + missingFiles="Missing files:" + #for key in "${!fileRollCall[@]}"; do echo "DEBUG:$key => ${fileRollCall[$key]}"; done + for key in "${!fileRollCall[@]}"; do + value="${fileRollCall[$key]}" + if [ "$value" = "false" ]; then + #echo "DEBUG:Missing files: $key => $value"; + missingFiles="$missingFiles""$key " + fileMissing="true" + fi + done + if [ "$fileMissing" = "true" ]; then # Only indicate if an app is missing. + echo "$missingFiles" 1>&2; + fi + #===END Display Missing Files=== + + #===BEGIN Display Missing Directories=== + missingDirs="Missing dirs:" + #for key in "${!dirRollCall[@]}"; do echo "DEBUG:$key => ${dirRollCall[$key]}"; done + for key in "${!dirRollCall[@]}"; do + value="${dirRollCall[$key]}" + if [ "$value" = "false" ]; then + #echo "DEBUG:Missing dirs: $key => $value"; + missingDirs="$missingDirs""$key " + dirMissing="true" + fi + done + if [ "$dirMissing" = "true" ]; then # Only indicate if an dir is missing. + echo "$missingDirs" 1>&2; + fi + #===END Display Missing Directories=== + + #==END Display errors== +} # Display missing apps, files, dirs +setScriptTTL() { + #Desc: Sets script TTL + #Usage: setScriptTTL arg1 + #Input: arg1: "day" or "hour" + #Output: scriptTTL + #Depends: timeUntilNextHour or timeUntilNextDay + local ARG1 + ARG1="$1" + if [[ "$ARG1" = "day" ]]; 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; + elif [[ "$ARG1" = "hour" ]]; then + # 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; + else + yell "ERROR:Invalid argument for setScriptTTL function."; exit 1; + fi +} # Seconds until next (day|hour). main() { processArguments "$@" # Process arguments. + + # 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. for pubkey in "${recPubKeys[@]}"; do # Validate recipient pubkey strings by forming test message @@ -301,7 +628,6 @@ main() { 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 "; @@ -314,55 +640,68 @@ main() { CMD_COMPRESS_SUFFIX=""; vbm "DEBUG:Compression not enabled." 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"$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 + # Check that critical apps and dirs are available, displag missing ones. + if ! checkapp gpspipe tar && ! checkdir "$DIR_OUT" "/dev/shm"; then + yell "ERROR:Critical components missing."; + displayMissing; yell "Exiting."; exit 1; fi + + # Set script lifespan + setScriptTTL "$SCRIPT_TTL"; + + # File name substring: encoded bufferTTL + bufferTTL_STR="$(timeDuration $BUFFER_TTL)"; + + # Init temp working dir + 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")) + 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." + ## 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." + ## Append VERSION file 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) + 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" ; + ## 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 + # 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 + # Fill Bash variable buffer + bufferBash="$(timeout "$BUFFER_TTL""s" gpspipe -r)"; # Record gpspipe nmea data to buffer for bufferTTL seconds + # 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; + # 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"; + # Reset buffer and filenames + unset bufferBash FILEOUT_BASENAME PATHOUT_NMEA PATHOUT_GPX PATHOUT_KML PATHOUT_TAR; + ((debugCounter++)) + done } # Main function. #===END Declare local script functions=== #==END Define script parameters== @@ -372,7 +711,3 @@ main() { main "$@" # Run main function. exit 0; #==END Perform work and exit== - - - - #gpspipe -r -d -l -o "$DIROUT1"/"$FILEOUT1" ; diff --git a/exec/bkgpslog-plan.org b/exec/bkgpslog-plan.org new file mode 100644 index 0000000..bc98f9a --- /dev/null +++ b/exec/bkgpslog-plan.org @@ -0,0 +1,35 @@ +* bkgpslog narrative +** Initialize environment +*** Init variables +**** Save timeStart (YYYYmmddTHHMMSS±zz) +*** Define Functions +**** Define Debugging functions +**** Define Argument Processing function +**** Define Main function +** Run Main Function +*** Process Arguments +*** Set output encryption and compression option strings +*** Check that critical apps and dirs are available, displag missing ones. +*** Set lifespans of script and buffer +*** Init temp working dir ~DIR_TMP~ +Make temporary dir in tmpfs dir: ~/dev/shm/$(nonce)..bkgpslog/~ (~DIR_TMP~) +*** Initialize ~tar~ archive +**** Write ~bkgpslog~ version to ~$DIR_TMP/VERSION~ +**** Create empty ~tar~ archive in ~DIR_OUT~ at ~PATHOUT_TAR~ + +Set output file name to: +: PATHOUT_TAR="$DIR_OUT/YYYYmmdd..hostname_location.gz.age.tar" +Usage: ~iso8601Period $timeStart $timeEnd~ + +**** Append ~VERSION~ file to ~PATHOUT_TAR~ + +Append ~$DIR_TMP/VERSION~ to ~PATHOUT_TAR~ via ~tar --append~ + +*** Read/Write Loop (Record gps data until script lifespan ends) +**** Determine output file paths +**** Define GPS conversion commands +**** Fill Bash variable buffer from ~gpspipe~ +**** Process bufferBash, save secured chunk set to ~DIR_TMP~ +**** Append each secured chunk to ~PATHOUT_TAR~ +: tar --append --directory=DIR_TMP --file=PATHOUT_TAR $(basename PATHOUT_{NMEA,GPX,KML} ) +**** Remove secured chunk from ~DIR_TMP~ -- 2.30.2