[BK-2020-03.git] / unitproc / bktemp-timeUntilNextDay

#!/bin/bash
# Desc: Template to report seconds until beginning of next day
# Author: Steven Baltaktei Sandoval; License: GPLv3+

#==BEGIN Define script parameters==
#===BEGIN Declare local script functions===
yell() { echo "$0: $*" >&2; } # Yell, Die, Try Three-Fingered Claw technique; # Ref/Attrib: https://stackoverflow.com/a/25515370
die() { yell "$*"; exit 111; }
try() { "$@" || die "cannot $*"; }
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="$(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_DAY="$(date -d "$DATE_TOMORROW" --iso-8601=seconds)" ; # Produce `date`-parsable timestamp of closest next day (res. 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 midnight
#===END Declare local script functions===
#==END Define script parameters==


#==BEGIN sample code==
try echo "Time until next day (seconds):$(timeUntilNextDay)" # simple report

if ! myTTL="$(timeUntilNextDay)"; then yell "ERROR in if statement for myTTL:$myTTL"; exit 1; fi # Use of exit code to exit early if time <= 0.
#==END sample code==
Commit	Line	Data
2ea4288a	1	#!/bin/bash
2385300a	2	# Desc: Template to report seconds until beginning of next day
5ef33b04	3	# Author: Steven Baltaktei Sandoval; License: GPLv3+
2ea4288a SBS	4
	5	#==BEGIN Define script parameters==
	6	#===BEGIN Declare local script functions===
5ef33b04 SBS	7	yell() { echo "$0: $*" >&2; } # Yell, Die, Try Three-Fingered Claw technique; # Ref/Attrib: https://stackoverflow.com/a/25515370
	8	die() { yell "$*"; exit 111; }
	9	try() { "$@" \|\| die "cannot $*"; }
2385300a SBS	10	timeUntilNextDay(){
	11	# Desc: Report seconds until next day.
	12	# Output: stdout: integer seconds until next day
5ef33b04	13	# Output: exit code 0 if stdout > 0; 1 if stdout = 0; 2 if stdout < 0
2385300a SBS	14	# Usage: timeUntilNextDay
2385300a SBS	15	# Usage: if ! myTTL="$(timeUntilNextDay)"; then yell "ERROR in if statement"; exit 1; fi
5ef33b04	16	local returnState
2ea4288a SBS	17	TIME_CURRENT="$(date --iso-8601=seconds)" ; # Produce `date`-parsable current timestamp with resolution of 1 second.
	18	TIME_CURRENT_SHORT="$(date -d "$TIME_CURRENT" +%Y%m%dT%H%M%S%z)" # Produce separator-less current timestamp with resolution 1 second.
	19	DATE_CURRENT="$(date -d "$TIME_CURRENT" --iso-8601=date)" ; # Produce `date`-parsable current timestamp with resolution of 1 day.
	20	DATE_CURRENT_SHORT="$(date -d "$TIME_CURRENT" +%Y%m%d)" ; # Produce separator-less current timestamp with resolution 1 day.
	21	DATE_TOMORROW="$(date -d "$TIME_CURRENT next day" --iso-8601=date)" ; # Produce timestamp of tomorrow's date (res. 1 day).
2385300a SBS	22	TIME_NEXT_DAY="$(date -d "$DATE_TOMORROW" --iso-8601=seconds)" ; # Produce `date`-parsable timestamp of closest next day (res. 1 second).
	23	SECONDS_UNTIL_NEXT_DAY="$(( $(date +%s -d "$TIME_NEXT_DAY") - $(date +%s -d "$TIME_CURRENT") ))" ; # Calculate seconds until closest future midnight (res. 1 second).
	24	if [[ "$SECONDS_UNTIL_NEXT_DAY" -gt 0 ]]; then
5ef33b04	25	returnState="true";
2385300a	26	elif [[ "$SECONDS_UNTIL_NEXT_DAY" -eq 0 ]]; then
5ef33b04	27	returnState="WARNING_ZERO";
2385300a SBS	28	yell "WARNING:Reported time until next day exactly zero.";
2385300a SBS	29	elif [[ "$SECONDS_UNTIL_NEXT_DAY" -lt 0 ]]; then
5ef33b04	30	returnState="WARNING_NEGATIVE";
2385300a	31	yell "WARNING:Reported time until next day is negative.";
5ef33b04 SBS	32	fi
5ef33b04 SBS	33
2385300a	34	try echo "$SECONDS_UNTIL_NEXT_DAY"; # Report
5ef33b04 SBS	35
	36	#===Determine function return code===
	37	if [[ "$returnState" = "true" ]]; then
	38	return 0;
	39	elif [[ "$returnState" = "WARNING_ZERO" ]]; then
	40	return 1;
	41	elif [[ "$returnState" = "WARNING_NEGATIVE" ]]; then
	42	return 2;
	43	fi
2ea4288a SBS	44	} # Report seconds until next midnight
	45	#===END Declare local script functions===
	46	#==END Define script parameters==
	47
	48
	49	#==BEGIN sample code==
2385300a	50	try echo "Time until next day (seconds):$(timeUntilNextDay)" # simple report
5ef33b04	51
2385300a	52	if ! myTTL="$(timeUntilNextDay)"; then yell "ERROR in if statement for myTTL:$myTTL"; exit 1; fi # Use of exit code to exit early if time <= 0.
2ea4288a	53	#==END sample code==