X-Git-Url: https://zdv2.bktei.com/gitweb/EVA-2020-02.git/blobdiff_plain/9efeccb59ffdf317ee26669fb44bfbbf7e879ff6..d6ba417340cdc4b063c92698b7c75a5a3345065b:/exec/bkgpslog diff --git a/exec/bkgpslog b/exec/bkgpslog index 0305303..84a74b0 100755 --- a/exec/bkgpslog +++ b/exec/bkgpslog @@ -6,7 +6,7 @@ #==BEGIN Define script parameters== ## Logging Behavior parameters -BUFFER_TTL="60"; # time between file writes +BUFFER_TTL="300"; # time between file writes SCRIPT_TTL="day"; # (day|hour) #### TZ="UTC"; export TZ; # Default time zone; overridden by '--time-zone=[str]' option DIR_TMP_DEFAULT="/dev/shm"; # Default parent of working directory @@ -14,7 +14,11 @@ DIR_TMP_DEFAULT="/dev/shm"; # Default parent of working directory 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. +SCRIPT_VERSION="0.3.8"; # Define version of script. +SCRIPT_NAME="bkgpslog"; # Define basename of script file. +SCRIPT_URL="https://gitlab.com/baltakatei/ninfacyzga-01"; # Define wesite hosting this script. +AGE_VERSION="1.0.0-beta2"; # Define version of age (encryption program) +AGE_URL="https://github.com/FiloSottile/age/releases/tag/v1.0.0-beta2"; # Define website hosting age. declare -Ag appRollCall # Associative array for storing app status declare -Ag fileRollCall # Associative array for storing file status @@ -262,41 +266,47 @@ setTimeZoneEV(){ } # Exports TZ environment variable timeUntilNextDay(){ # Desc: Report seconds until next day. + # Version: 1.0.0 # 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 + # Depends: date 8, echo 8, yell, try + 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"; + returnState="warning_zero"; 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 next day is negative."; fi try echo "$SECONDS_UNTIL_NEXT_DAY"; # Report - #===Determine function return code=== + # Determine function return code if [[ "$returnState" = "true" ]]; then return 0; - elif [[ "$returnState" = "WARNING_ZERO" ]]; then + elif [[ "$returnState" = "warning_zero" ]]; then return 1; - elif [[ "$returnState" = "WARNING_NEGATIVE" ]]; then + elif [[ "$returnState" = "warning_negative" ]]; then return 2; fi } # Report seconds until next day timeUntilNextHour(){ # Desc: Report seconds until next hour + # Version 1.0.0 # 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. @@ -304,94 +314,142 @@ timeUntilNextHour(){ if [[ "$SECONDS_UNTIL_NEXT_HOUR" -gt 0 ]]; then returnState="true"; elif [[ "$SECONDS_UNTIL_NEXT_HOUR" -eq 0 ]]; then - returnState="WARNING_ZERO"; + returnState="warning_zero"; 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 next hour is negative."; fi try echo "$SECONDS_UNTIL_NEXT_HOUR"; # Report - #===Determine function return code=== + # Determine function return code if [[ "$returnState" = "true" ]]; then return 0; - elif [[ "$returnState" = "WARNING_ZERO" ]]; then + elif [[ "$returnState" = "warning_zero" ]]; then return 1; - elif [[ "$returnState" = "WARNING_NEGATIVE" ]]; then + elif [[ "$returnState" = "warning_negative" ]]; then return 2; fi } # Report seconds until next hour dateTimeShort(){ # Desc: Timestamp without separators (YYYYmmddTHHMMSS+zzzz) - # Usage: dateTimeShort + # Usage: dateTimeShort ([str date]) + # Version 1.1.0 + # Input: arg1: 'date'-parsable timestamp string (optional) # Output: stdout: timestamp (ISO-8601, no separators) + # Depends: yell local TIME_CURRENT TIME_CURRENT_SHORT + + argTime="$1"; + # Get Current Time 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. + # Decide to parse current or supplied date + ## Check if time argument empty + if [[ -z "$argTime" ]]; then + ## T: Time argument empty, use current time + TIME_INPUT="$TIME_CURRENT"; + else + ## F: Time argument exists, validate time + if date --date="$argTime" 1>/dev/null 2>&1; then + ### T: Time argument is valid; use it + TIME_INPUT="$argTime"; + else + ### F: Time argument not valid; exit + yell "ERROR:Invalid time argument supplied. Exiting."; exit 1; + fi + fi + # Construct and deliver separator-les date string + TIME_CURRENT_SHORT="$(date -d "$TIME_INPUT" +%Y%m%dT%H%M%S%z)"; echo "$TIME_CURRENT_SHORT"; } # Get YYYYmmddTHHMMSS±zzzz dateShort(){ # Desc: Date without separators (YYYYmmdd) - # Usage: dateShort + # Usage: dateShort ([str date]) + # Version: 1.1.0 + # Input: arg1: 'date'-parsable timestamp string (optional) # Output: stdout: date (ISO-8601, no separators) + # Depends: yell local TIME_CURRENT DATE_CURRENT_SHORT + + argTime="$1"; + # Get Current Time 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. + # Decide to parse current or supplied date + ## Check if time argument empty + if [[ -z "$argTime" ]]; then + ## T: Time argument empty, use current time + TIME_INPUT="$TIME_CURRENT"; + else + ## F: Time argument exists, validate time + if date --date="$argTime" 1>/dev/null 2>&1; then + ### T: Time argument is valid; use it + TIME_INPUT="$argTime"; + else + ### F: Time argument not valid; exit + yell "ERROR:Invalid time argument supplied. Exiting."; exit 1; + fi + fi + # Construct and deliver separator-les date string + DATE_CURRENT_SHORT="$(date -d "$TIME_INPUT" +%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) + # Desc: Given seconds, output ISO-8601 duration string # 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]) + # Usage: timeDuration [1:seconds] ([2:precision]) + # Version: 1.0.3 # 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") + # exit code 0: success + # exit code 1: error_input + # exit code 2: error_unknown # Example: 'timeDuration 111111 3' yields 'P1DT6H51M' - # Depends: date 8 (gnucoreutils) - local returnState fullHours fullMinutes fullSeconds; - ARG1="$1"; - ARG2="$2"; + # Depends: date 8 (gnucoreutils), yell, + local returnState argSeconds argPrecision remainder precision witherPrecision + local fullYears fullMonths fullDays fullHours fullMinutes fullSeconds + local displayYears displayMonths displayDays displayHours displayMinutes displaySeconds + local hasYears hasMonths hasDays hasHours hasMinutes hasSeconds + + argSeconds="$1"; # read arg1 (seconds) + argPrecision="$2"; # read arg2 (precision) 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 + returnState="error_input"; fi - # Check that arg1 provided + # Check that argSeconds provided if [[ $# -ge 1 ]]; then - # Check that arg1 is a positive integer - if [[ "$ARG1" =~ ^[[:digit:]]+$ ]]; then - arg1Valid="true"; + ## Check that argSeconds is a positive integer + if [[ "$argSeconds" =~ ^[[:digit:]]+$ ]]; then + : else - yell "ERROR:ARG1 not a digit."; - returnState="ERROR_INPUT"; - arg1Valid="false"; + yell "ERROR:argSeconds not a digit."; + returnState="error_input"; fi else yell "ERROR:No argument provided. Exiting."; exit 1; fi - # Consider whether arg2 was provided + # Consider whether argPrecision 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"; + # Check that argPrecision is a positive integer + if [[ "$argPrecision" =~ ^[[:digit:]]+$ ]] && [[ "$argPrecision" -gt 0 ]]; then + precision="$argPrecision"; else - yell "ERROR:ARG2 not a positive integer. (is $ARG2 ). Leaving early."; - returnState="ERROR_INPUT"; - arg2Valid="false"; + yell "ERROR:argPrecision not a positive integer. (is $argPrecision ). Leaving early."; + returnState="error_input"; fi; else - arg2Valid="false"; + : fi; - remainder="$ARG1" ; # seconds + remainder="$argSeconds" ; # seconds ## Calculate full years Y, update remainder fullYears=$(( remainder / (365*24*60*60) )); remainder=$(( remainder - (fullYears*365*24*60*60) )); @@ -491,8 +549,6 @@ timeDuration(){ 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 @@ -515,14 +571,17 @@ timeDuration(){ OUTPUT=$OUTPUT$fullSeconds"S"; fi ## Output duration string to stdout - if [[ "$returnState" = "true" ]]; then echo "$OUTPUT"; fi + echo "$OUTPUT" && returnState="true"; #===Determine function return code=== if [ "$returnState" = "true" ]; then return 0; - else - echo "$returnState" 1>&2; + elif [ "$returnState" = "error_input" ]; then + yell "ERROR:input"; return 1; + else + yell "ERROR:Unknown"; + return 2; fi } # Get duration (ex: PT10M4S ) @@ -612,6 +671,273 @@ setScriptTTL() { yell "ERROR:Invalid argument for setScriptTTL function."; exit 1; fi } # Seconds until next (day|hour). +checkMakeTar() { + # Desc: Checks that a valid tar archive exists, creates one otherwise + # Usage: checkMakeTar [ path ] + # Version: 1.0.1 + # Input: arg1: path of tar archive + # Output: exit code 0 : tar readable + # exit code 1 : tar missing; created + # exit code 2 : tar not readable; moved; replaced + # Depends: try, tar, date + local PATH_TAR returnFlag0 returnFlag1 returnFlag2 + PATH_TAR="$1" + + # Check if file is a valid tar archive + if tar --list --file="$PATH_TAR" 1>/dev/null 2>&1; then + ## T1: return success + returnFlag0="tar valid"; + else + ## F1: Check if file exists + if [[ -f "$PATH_TAR" ]]; then + ### T: Rename file + try mv "$PATH_TAR" "$PATH_TAR""--broken--""$(date +%Y%m%dT%H%M%S)" && \ + returnFlag1="tar moved"; + else + ### F: - + : + fi + ## F2: Create tar archive, return 0 + try tar --create --file="$PATH_TAR" --files-from=/dev/null && \ + returnFlag2="tar created"; + fi + + # Determine function return code + if [[ "$returnFlag0" = "tar valid" ]]; then + return 0; + elif [[ "$returnFlag2" = "tar created" ]] && ! [[ "$returnFlag1" = "tar moved" ]]; then + return 1; # tar missing so created + elif [[ "$returnFlag2" = "tar created" ]] && [[ "$returnFlag1" = "tar moved" ]]; then + return 2; # tar not readable so moved; replaced + fi +} # checks if arg1 is tar; creates one otherwise +appendArgTar(){ + # Desc: Writes first argument to temporary file with arguments as options, then appends file to tar + # Usage: appendArgTar "$(echo "Data to be written.")" [name of file to be inserted] [tar path] [temp dir] ([cmd1] [cmd2] [cmd3] [cmd4]...) + # Version: 1.0.3 + # Input: arg1: data to be written + # arg2: file name of file to be inserted into tar + # arg3: tar archive path (must exist first) + # arg4: temporary working dir + # arg5+: command strings (ex: "gpsbabel -i nmea -f - -o kml -F - ") + # Output: file written to disk + # Example: decrypt multiple large files in parallel + # appendArgTar "$(cat /tmp/largefile1.gpg)" "largefile1" $HOME/archive.tar /tmp "gpg --decrypt" & + # appendArgTar "$(cat /tmp/largefile2.gpg)" "largefile2" $HOME/archive.tar /tmp "gpg --decrypt" & + # appendArgTar "$(cat /tmp/largefile3.gpg)" "largefile3" $HOME/archive.tar /tmp "gpg --decrypt" & + # Depends: bash 5 + # Ref/Attrib: Using 'eval' to construct command strings https://askubuntu.com/a/476533 + + # Save function name + local FN="${FUNCNAME[0]}"; + #yell "DEBUG:STATUS:$FN:Finished appendArgTar()." + + # Set file name + if ! [ -z "$2" ]; then FILENAME="$2"; else yell "ERROR:$FN:Not enough arguments."; exit 1; fi + + # Check tar path is a file + if [ -f "$3" ]; then TAR_PATH="$3"; else yell "ERROR:$FN:Tar archive arg not a file."; exit 1; fi + + # Check temp dir arg + if ! [ -z "$4" ]; then TMP_DIR="$4"; else yell "ERROR:$FN:No temporary working dir set."; exit 1; fi + + # Set command strings + if ! [ -z "$5" ]; then CMD1="$5"; else CMD1="tee /dev/null "; fi # command string 1 + if ! [ -z "$6" ]; then CMD2="$6"; else CMD2="tee /dev/null "; fi # command string 2 + if ! [ -z "$7" ]; then CMD3="$7"; else CMD3="tee /dev/null "; fi # command string 3 + if ! [ -z "$8" ]; then CMD4="$8"; else CMD4="tee /dev/null "; fi # command string 4 + + # Input command + CMD0="echo \"\$1\"" + + # # Debug + # yell "DEBUG:STATUS:$FN:CMD0:$CMD0" + # yell "DEBUG:STATUS:$FN:CMD1:$CMD1" + # yell "DEBUG:STATUS:$FN:CMD2:$CMD2" + # yell "DEBUG:STATUS:$FN:CMD3:$CMD3" + # yell "DEBUG:STATUS:$FN:CMD4:$CMD4" + # yell "DEBUG:STATUS:$FN:FILENAME:$FILENAME" + # yell "DEBUG:STATUS:$FN:TAR_PATH:$TAR_PATH" + # yell "DEBUG:STATUS:$FN:TMP_DIR:$TMP_DIR" + + # Write to temporary working dir + eval "$CMD0"" | ""$CMD1"" | ""$CMD2"" | ""$CMD3"" | ""$CMD4" > "$TMP_DIR"/"$FILENAME"; + + # Append to tar + try tar --append --directory="$TMP_DIR" --file="$TAR_PATH" "$FILENAME"; + #yell "DEBUG:STATUS:$FN:Finished appendArgTar()." +} # Append Bash var to file appended to Tar archive +appendFileTar(){ + # Desc: Processes first file and then appends to tar + # Usage: appendFileTar [file path] [name of file to be inserted] [tar path] [temp dir] ([cmd1] [cmd2] [cmd3] [cmd4]...) + # Version: 1.0.2 + # Input: arg1: path of file to be (processed and) written + # arg2: name to use for file inserted into tar + # arg3: tar archive path (must exist first) + # arg4: temporary working dir + # arg5+: command strings (ex: "gpsbabel -i nmea -f - -o kml -F - ") + # Output: file written to disk + # Example: decrypt multiple large files in parallel + # appendFileTar /tmp/largefile1.gpg "largefile1" $HOME/archive.tar /tmp "gpg --decrypt" & + # appendFileTar /tmp/largefile2.gpg "largefile2" $HOME/archive.tar /tmp "gpg --decrypt" & + # appendFileTar /tmp/largefile3.gpg "largefile3" $HOME/archive.tar /tmp "gpg --decrypt" & + # Depends: bash 5 + + # Save function name + local FN="${FUNCNAME[0]}"; + #yell "DEBUG:STATUS:$FN:Finished appendFileTar()." + + # Set file name + if ! [ -z "$2" ]; then FILENAME="$2"; else yell "ERROR:$FN:Not enough arguments."; exit 1; fi + # Check tar path is a file + if [ -f "$3" ]; then TAR_PATH="$3"; else yell "ERROR:$FN:Tar archive arg not a file."; exit 1; fi + # Check temp dir arg + if ! [ -z "$4" ]; then TMP_DIR="$4"; else yell "ERROR:$FN:No temporary working dir set."; exit 1; fi + # Set command strings + if ! [ -z "$5" ]; then CMD1="$5"; else CMD1="tee /dev/null "; fi # command string 1 + if ! [ -z "$6" ]; then CMD2="$6"; else CMD2="tee /dev/null "; fi # command string 2 + if ! [ -z "$7" ]; then CMD3="$7"; else CMD3="tee /dev/null "; fi # command string 3 + if ! [ -z "$8" ]; then CMD4="$8"; else CMD4="tee /dev/null "; fi # command string 4 + + # Input command string + CMD0="cat \"\$1\"" + + # # Debug + # yell "DEBUG:STATUS:$FN:CMD0:$CMD0" + # yell "DEBUG:STATUS:$FN:CMD1:$CMD1" + # yell "DEBUG:STATUS:$FN:CMD2:$CMD2" + # yell "DEBUG:STATUS:$FN:CMD3:$CMD3" + # yell "DEBUG:STATUS:$FN:CMD4:$CMD4" + # yell "DEBUG:STATUS:$FN:FILENAME:$FILENAME" + # yell "DEBUG:STATUS:$FN:TAR_PATH:$TAR_PATH" + # yell "DEBUG:STATUS:$FN:TMP_DIR:$TMP_DIR" + + # Write to temporary working dir + eval "$CMD0 | $CMD1 | $CMD2 | $CMD3 | $CMD4" > "$TMP_DIR"/"$FILENAME"; + + # Append to tar + try tar --append --directory="$TMP_DIR" --file="$TAR_PATH" "$FILENAME"; + #yell "DEBUG:STATUS:$FN:Finished appendFileTar()." +} # Append file to Tar archive +validateInput() { + # Desc: Validates Input + # Usage: validateInput [str input] [str input type] + # Version: 0.2.1 + # Input: arg1: string to validate + # arg2: string specifying input type (ex:"ssh_pubkey") + # Output: return code 0: if input string matched specified string type + # Depends: bash 5, yell + + # Save function name + local FN="${FUNCNAME[0]}"; + + # Process arguments + argInput="$1"; + argType="$2"; + if [[ $# -gt 2 ]]; then yell "ERROR:$0:$FN:Too many arguments."; exit 1; fi; + + # Check for blank + if [[ -z "$argInput" ]]; then return 1; fi + + # Define input types + ## ssh_pubkey + ### Check for alnum/dash base64 (ex: "ssh-rsa AAAAB3NzaC1yc2EAAA") + if [[ "$argType" = "ssh_pubkey" ]]; then + if [[ "$argInput" =~ ^[[:alnum:]-]*[\ ]*[[:alnum:]+/=]*$ ]]; then + return 0; fi; fi; + + ## age_pubkey + ### Check for age1[:bech32:] + if [[ "$argType" = "age_pubkey" ]]; then + if [[ "$argInput" =~ ^age1[qpzry9x8gf2tvdw0s3jn54khce6mua7l]*$ ]]; then + return 0; fi; fi + + # Return error if no condition matched. + return 1; +} # Validates strings +magicWriteVersion() { + # Desc: Appends time-stamped VERSION to PATHOUT_TAR + # Usage: magicWriteVersion + # Version: 0.1.0 + # Input: CONTENT_VERSION, FILEOUT_VERSION, PATHOUT_TAR, DIR_TMP + # Input: SCRIPT_VERSION, SCRIPT_URL, AGE_VERSION, AGE_URL, SCRIPT_HOSTNAME + # Output: appends tar PATHOUT_TAR + # Depends: dateTimeShort, appendArgTar + local CONTENT_VERSION pubKeyIndex + + # Set VERSION file name + FILEOUT_VERSION="$(dateTimeShort)..VERSION"; + + # Gather VERSION data in CONTENT_VERSION + CONTENT_VERSION="SCRIPT_VERSION=$SCRIPT_VERSION"; + #CONTENT_VERSION="$CONTENT_VERSION""\\n"; + CONTENT_VERSION="$CONTENT_VERSION""\\n""SCRIPT_NAME=$SCRIPT_NAME"; + CONTENT_VERSION="$CONTENT_VERSION""\\n""SCRIPT_URL=$SCRIPT_URL"; + CONTENT_VERSION="$CONTENT_VERSION""\\n""AGE_VERSION=$AGE_VERSION"; + CONTENT_VERSION="$CONTENT_VERSION""\\n""AGE_URL=$AGE_URL"; + CONTENT_VERSION="$CONTENT_VERSION""\\n""DATE=$(date --iso-8601=seconds)"; + CONTENT_VERSION="$CONTENT_VERSION""\\n""HOSTNAME=$SCRIPT_HOSTNAME"; + ## Add list of recipient pubkeys + for pubkey in "${recPubKeysValid[@]}"; do + ((pubKeyIndex++)) + CONTENT_VERSION="$CONTENT_VERSION""\\n""PUBKEY_$pubKeyIndex=$pubkey"; + done + ## Process newline escapes + CONTENT_VERSION="$(echo -e "$CONTENT_VERSION")" + + # Write CONTENT_VERSION as file FILEOUT_VERSION and write-append to PATHOUT_TAR + appendArgTar "$CONTENT_VERSION" "$FILEOUT_VERSION" "$PATHOUT_TAR" "$DIR_TMP"; + +} # bkgpslog: write version data to PATHOUT_TAR via appendArgTar() +magicGatherWriteBuffer() { + # Desc: bkgpslog-specific meta function for writing data to DIR_TMP then appending each file to PATHOUT_TAR + # Inputs: PATHOUT_TAR FILEOUT_{NMEA,GPX,KML} CMD_CONV_{NMEA,GPX,KML} CMD_{COMPRESS,ENCRYPT} DIR_TMP, + # Inputs: BUFFER_TTL bufferTTL_STR SCRIPT_HOSTNAME CMD_COMPRESS_SUFFIX CMD_ENCRYPT_SUFFIX + # Depends: yell, try, vbm, appendArgTar, tar + local FN="${FUNCNAME[0]}"; + wait; # Wait to avoid collision with older magicWriteBuffer() instances (see https://www.tldp.org/LDP/abs/html/x9644.html ) + # Create buffer file with unique name + PATHOUT_BUFFER="$DIR_TMP/buffer$SECONDS"; + # Fill buffer + timeout "$BUFFER_TTL"s gpspipe -r -o "$PATHOUT_BUFFER" ; + timeBufferStart="$(dateTimeShort "$(date --date="$BUFFER_TTL seconds ago")")"; # Note start time + vbm "DEBUG:STATUS:$FN:Started magicWriteBuffer()."; + # Determine file paths (time is start of buffer period) + FILEOUT_BASENAME="$timeBufferStart""--""$bufferTTL_STR""..""$SCRIPT_HOSTNAME""_location" && vbm "STATUS:Set FILEOUT_BASENAME to:$FILEOUT_BASENAME"; + ## Files saved to DIR_TMP + FILEOUT_NMEA="$FILEOUT_BASENAME".nmea"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" && vbm "STATUS:Set FILEOUT_NMEA to:$FILEOUT_NMEA"; + FILEOUT_GPX="$FILEOUT_BASENAME".gpx"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" && vbm "STATUS:Set FILEOUT_GPX to:$FILEOUT_GPX"; + FILEOUT_KML="$FILEOUT_BASENAME".kml"$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX" && vbm "STATUS:Set FILEOUT_KML to:$FILEOUT_KML"; + PATHOUT_NMEA="$DIR_TMP"/"$FILEOUT_NMEA" && vbm "STATUS:Set PATHOUT_NMEA to:$PATHOUT_NMEA"; + PATHOUT_GPX="$DIR_TMP"/"$FILEOUT_GPX" && vbm "STATUS:Set PATHOUT_GPX to:$PATHOUT_GPX"; + PATHOUT_KML="$DIR_TMP"/"$FILEOUT_KML" && 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") + PATHOUT_TAR="$DIR_OUT"/"$(dateShort "$(date --date="$BUFFER_TTL seconds ago")")".."$SCRIPT_HOSTNAME""_location""$CMD_COMPRESS_SUFFIX""$CMD_ENCRYPT_SUFFIX".tar && \ + vbm "STATUS:Set PATHOUT_TAR to:$PATHOUT_TAR"; + # DEBUG: check vars + vbm "STATUS:DIR_TMP :$DIR_TMP"; + vbm "STATUS:PATHOUT_TAR :$PATHOUT_TAR"; + vbm "STATUS:PATHOUT_NMEA:$PATHOUT_NMEA"; + vbm "STATUS:PATHOUT_GPX:$PATHOUT_GPX"; + vbm "STATUS:PATHOUT_KML:$PATHOUT_KML"; + + + # Validate PATHOUT_TAR as tar. + checkMakeTar "$PATHOUT_TAR"; + ## Add VERSION file if checkMakeTar had to create a tar (exited 1) or replace one (exited 2) + if [[ $? -eq 1 ]] || [[ $? -eq 2 ]]; then magicWriteVersion; fi + + # Write bufferBash to PATHOUT_TAR + appendFileTar "$PATHOUT_BUFFER" "$FILEOUT_NMEA" "$PATHOUT_TAR" "$DIR_TMP" "$CMD_CONV_NMEA" "$CMD_COMPRESS" "$CMD_ENCRYPT"; # Write NMEA data + appendFileTar "$PATHOUT_BUFFER" "$FILEOUT_GPX" "$PATHOUT_TAR" "$DIR_TMP" "$CMD_CONV_GPX" "$CMD_COMPRESS" "$CMD_ENCRYPT"; # Write GPX file + appendFileTar "$PATHOUT_BUFFER" "$FILEOUT_KML" "$PATHOUT_TAR" "$DIR_TMP" "$CMD_CONV_KML" "$CMD_COMPRESS" "$CMD_ENCRYPT"; # Write KML file + + # Remove secured chunks from DIR_TMP + rm "$PATHOUT_BUFFER" "$PATHOUT_NMEA" "$PATHOUT_GPX" "$PATHOUT_KML"; + vbm "DEBUG:STATUS:$FN:Finished magicWriteBuffer()."; +} # write buffer to disk + main() { processArguments "$@" # Process arguments. @@ -621,7 +947,7 @@ main() { if [[ -d "$TMP_DIR_PRIORITY" ]]; then DIR_TMP_PARENT="$OPTION_TMPDIR"; else - yell "WARNING:Specified temporary working directory not valid:$OPTION_TMP_DIR"; + yell "WARNING:Specified temporary working directory not valid:$OPTION_TMPDIR"; exit 1; fi fi @@ -644,39 +970,43 @@ main() { 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 "DEBUG:Testing pubkey string:$pubkey"; + if echo "butts" | age -a -r "$pubkey" 1>/dev/null && + ( validateInput "$pubkey" "ssh_pubkey" || validateInput "$pubkey" "age_pubkey"); then + #### Form age recipient string + recipients="$recipients""-r '$pubkey' "; vbm "STATUS:Added pubkey for forming age recipient string:""$pubkey"; vbm "DEBUG:recipients:""$recipients"; + #### Add validated pubkey to recPubKeysValid array + recPubKeysValid+=("$pubkey") && vbm "DEBUG:recPubkeysValid:pubkey added:$pubkey"; 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"; + + ## Form age command string + CMD_ENCRYPT="age ""$recipients " && vbm "CMD_ENCRYPT:$CMD_ENCRYPT"; + CMD_ENCRYPT_SUFFIX=".age" && vbm "CMD_ENCRYPT_SUFFIX:$CMD_ENCRYPT_SUFFIX"; else yell "ERROR:Encryption enabled but \"age\" not found. Exiting."; exit 1; fi else - CMD_ENCRYPT="tee /dev/null "; - CMD_ENCRYPT_SUFFIX=""; + CMD_ENCRYPT="tee /dev/null " && vbm "CMD_ENCRYPT:$CMD_ENCRYPT"; + CMD_ENCRYPT_SUFFIX="" && vbm "CMD_ENCRYPT_SUFFIX:$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"; + CMD_COMPRESS="gzip " && vbm "CMD_COMPRESS:$CMD_COMPRESS"; + CMD_COMPRESS_SUFFIX=".gz" && vbm "CMD_COMPRESS_SUFFIX:$CMD_COMPRESS_SUFFIX"; 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." + CMD_COMPRESS="tee /dev/null " && vbm "CMD_COMPRESS:$CMD_COMPRESS"; + CMD_COMPRESS_SUFFIX="" && vbm "CMD_COMPRESS_SUFFIX:$CMD_COMPRESS_SUFFIX"; + vbm "DEBUG:Compression not enabled."; fi # Check that critical apps and dirs are available, displag missing ones. @@ -685,7 +1015,7 @@ main() { displayMissing; yell "Exiting."; exit 1; fi # Set script lifespan - setScriptTTL "$SCRIPT_TTL"; + setScriptTTL "$SCRIPT_TTL"; # seconds until next new SCRIPT_TTL (ex: "day" or "hour") # File name substring: encoded bufferTTL bufferTTL_STR="$(timeDuration $BUFFER_TTL)"; @@ -697,78 +1027,27 @@ main() { ## 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 && \ vbm "STATUS:Set PATHOUT_TAR to:$PATHOUT_TAR"; - ## Write bkgpslog version to DIR_TMP/VERSION - echo "$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 + ## Check that PATHOUT_TAR is a tar. Rename old and create empty one otherwise. + checkMakeTar "$PATHOUT_TAR" && vbm "DEBUG:Confirmed or Created to be a tar:$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"; - - # Record gps data until script lifespan ends - declare debugCounter; debugCounter="0"; # set debug counter - timeStart=$(dateTimeShort); # Note start time + magicWriteVersion; + + # Define GPS conversion commands + 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 + + # MAIN LOOP:Record gps data until script lifespan ends while [[ "$SECONDS" -lt "$scriptTTL" ]]; do - # Determine file paths (time is start of buffer period) - 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") - 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 - 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 - 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 - 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) - # Append each secured chunk in memory dir (DIR_TMP) to file on disk (PATHOUT_TAR in DIR_OUT) - 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"; - try tar --append --directory="$DIR_TMP" --file="$PATHOUT_TAR" "$(basename "$PATHOUT_GPX")" && \ - vbm "DEBUG:Appended GPX location data $PATHOUT_GPX to $PATHOUT_TAR"; - 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 - try rm "$PATHOUT_NMEA" "$PATHOUT_GPX" "$PATHOUT_KML"; - # 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 + magicGatherWriteBuffer & + sleep "$BUFFER_TTL"; + done - # Remove DIR_TMP + # Cleanup + ## Remove DIR_TMP try rm -r "$DIR_TMP"; + + vbm "STATUS:Main function finished."; } # Main function. #===END Declare local script functions=== #==END Define script parameters==