style(unitproc):checkMakeTar(): Change VAR_NAMES to varNames

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

diff --git a/unitproc/bktemp-timeDuration b/unitproc/bktemp-timeDuration
index 5aac0d50a64b8930a79317a51c5ce39a635fdfea..57ea1f514b98c0ec18715792e193ff548b61fe53 100644 (file)
--- a/unitproc/bktemp-timeDuration
+++ b/unitproc/bktemp-timeDuration
@@ -6,87 +6,80 @@ yell() { echo "$0: $*" >&2; } # Yell, Die, Try Three-Fingered Claw technique; #
 die() { yell "$*"; exit 111; }
 try() { "$@" || die "cannot $*"; }
 timeDuration(){
 die() { yell "$*"; exit 111; }
 try() { "$@" || die "cannot $*"; }
 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)
     # 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.4

     # 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")
     # 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'
     # Example: 'timeDuration 111111 3' yields 'P1DT6H51M'

-    # Depends: date 8 (gnucoreutils)
-    local returnState fullHours fullMinutes fullSeconds;
-    ARG1="$1";
-    ARG2="$2";
+    # Depends: date 8, bash 5, yell,
+    local argSeconds argPrecision precision returnState remainder
+    local fullYears fullMonths fullDays fullHours fullMinutes fullSeconds
+    local hasYears hasMonths hasDays hasHours hasMinutes hasSeconds
+    local witherPrecision output
+    local displayYears displayMonths displayDays displayHours displayMinutes displaySeconds
+    
+    argSeconds="$1"; # read arg1 (seconds)
+    argPrecision="$2"; # read arg2 (precision)

     precision=2; # set default 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.";
 
     # 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
     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
        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
 
        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
     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
        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
        fi;
     else

-       arg2Valid="false";
+       :

     fi;
     
     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) ));
     ## Calculate full years Y, update remainder
     fullYears=$(( remainder / (365*24*60*60) ));
     remainder=$(( remainder - (fullYears*365*24*60*60) ));

-    #yell "DEBUG:post-Y remainder:$remainder"
-    #yell "DEBUG:fullYears:$fullYears"

     ## Calculate full months M, update remainder
     fullMonths=$(( remainder / (30*24*60*60) ));
     remainder=$(( remainder - (fullMonths*30*24*60*60) ));
     ## Calculate full months M, update remainder
     fullMonths=$(( remainder / (30*24*60*60) ));
     remainder=$(( remainder - (fullMonths*30*24*60*60) ));

-    #yell "DEBUG:post-m remainder:$remainder"
-    #yell "DEBUG:fullMonths:$fullMonths"

     ## Calculate full days D, update remainder
     fullDays=$(( remainder / (24*60*60) ));
     remainder=$(( remainder - (fullDays*24*60*60) ));
     ## Calculate full days D, update remainder
     fullDays=$(( remainder / (24*60*60) ));
     remainder=$(( remainder - (fullDays*24*60*60) ));

-    #yell "DEBUG:post-d remainder:$remainder"
-    #yell "DEBUG:fullMonths:$fullDays"

     ## Calculate full hours H, update remainder
     fullHours=$(( remainder / (60*60) ));
     remainder=$(( remainder - (fullHours*60*60) ));
     ## Calculate full hours H, update remainder
     fullHours=$(( remainder / (60*60) ));
     remainder=$(( remainder - (fullHours*60*60) ));

-    #yell "DEBUG:post-H remainder:$remainder"
-    #yell "DEBUG:fullHours:$fullHours"

     ## Calculate full minutes M, update remainder
     fullMinutes=$(( remainder / (60) ));
     remainder=$(( remainder - (fullMinutes*60) ));
     ## Calculate full minutes M, update remainder
     fullMinutes=$(( remainder / (60) ));
     remainder=$(( remainder - (fullMinutes*60) ));

-    #yell "DEBUG:post-M remainder:$remainder"
-    #yell "DEBUG:fullMinutes:$fullMinutes"

     ## Calculate full seconds S, update remainder
     fullSeconds=$(( remainder / (1) ));
     remainder=$(( remainder - (remainder*1) ));
     ## Calculate full seconds S, update remainder
     fullSeconds=$(( remainder / (1) ));
     remainder=$(( remainder - (remainder*1) ));

-    #yell "DEBUG:post-S remainder:$remainder"
-    #yell "DEBUG:fullSeconds:$fullSeconds"

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


@@ -168,56 +161,39 @@ timeDuration(){
     fi;
     if $witherPrecision; then ((precision--)); fi;
 
     fi;
     if $witherPrecision; then ((precision--)); fi;
 

-
-

     ## Determine whether or not the "T" separator is needed to separate date and time elements
     ## Determine whether or not the "T" separator is needed to separate date and time elements

-    #    if ( $displayYears || $displayMonths || $displayDays ) && ( $displayHours || $displayMinutes || $displaySeconds); then

     if ( $displayHours || $displayMinutes || $displaySeconds); then
        displayDateTime="true"; else displayDateTime="false"; fi
     
     ## Construct duration output string
     if ( $displayHours || $displayMinutes || $displaySeconds); then
        displayDateTime="true"; else displayDateTime="false"; fi
     
     ## Construct duration output string

-    OUTPUT="P"
+    output="P"

     if $displayYears; then
     if $displayYears; then

-       OUTPUT=$OUTPUT$fullYears"Y"; fi
+       output=$output$fullYears"Y"; fi

     if $displayMonths; then
     if $displayMonths; then

-       OUTPUT=$OUTPUT$fullMonths"M"; fi
+       output=$output$fullMonths"M"; fi

     if $displayDays; then
     if $displayDays; then

-       OUTPUT=$OUTPUT$fullDays"D"; fi
+       output=$output$fullDays"D"; fi

     if $displayDateTime; then
     if $displayDateTime; then

-       OUTPUT=$OUTPUT"T"; fi
+       output=$output"T"; fi

     if $displayHours; then
     if $displayHours; then

-       OUTPUT=$OUTPUT$fullHours"H"; fi
+       output=$output$fullHours"H"; fi

     if $displayMinutes; then
     if $displayMinutes; then

-       OUTPUT=$OUTPUT$fullMinutes"M"; fi
+       output=$output$fullMinutes"M"; fi

     if $displaySeconds; then
     if $displaySeconds; then

-       OUTPUT=$OUTPUT$fullSeconds"S"; fi
+       output=$output$fullSeconds"S"; fi

 
     ## Output duration string to stdout
 
     ## Output duration string to stdout

-    if [[ "$returnState" = "true" ]]; then echo "$OUTPUT"; fi
-    
-
-    # if [[ "$OPTION_DATEPARSE" = "true" ]]; then
-    #  echo "asdf";
-    #  # Get current time for parsing year/month/day idiosyncrasies
-    #  DATE_NOW="$(TZ=":UTC" date --iso-8601 | tr -d '[:punct:]')"; # Produces YYYYMMDD
-    #  #TIME_CURRENT="$(date --iso-8601=seconds)" ; # Produce `date`-parsable current timestamp with resolution of 1 second.
-    #  # Get date : Given YYYY-MM-DDTHH:MM:SS+ZZ, outputs YYYYMMDD (also supports YYYYYY)
-    #  DATE_AGO="$(TZ="UTC" date -d '$ARG1 seconds ago' --iso-8601=seconds | tr -d '[:punct:]' | cut -dT -f1)"; 
-    #  # Get day
-    #  DAY_AGO=${DATE_AGO: -2}
-    #  # Get month
-    #  MONTH_AGO=${DATE_AGO: -4: -2}
-    #  # Get year
-    #  YEAR_AGO=${YEAR: 0: -4}
-       
-    # fi
+    echo "$output" && returnState="true";

 
     #===Determine function return code===
     if [ "$returnState" = "true" ]; then
        return 0;
 
     #===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;
        return 1;

+    else
+       yell "ERROR:Unknown";
+       return 2;

     fi
 
 } # Get duration (ex: PT10M4S )
     fi
 
 } # Get duration (ex: PT10M4S )


@@ -230,7 +206,7 @@ echo "Precision 3 duration:$(timeDuration "$(date +%s)" 3)"
 echo "Precision 2 duration:$(timeDuration "$(date +%s)" 2)"
 echo "Precision 1 duration:$(timeDuration "$(date +%s)" 1)"
 echo "Precision 6 duration:$(timeDuration $((60+60*60+60*60*24+60*60*24*30+60*60*24*365 - (60+60*60+60*60*24+60*60*24*30) )) 6)"
 echo "Precision 2 duration:$(timeDuration "$(date +%s)" 2)"
 echo "Precision 1 duration:$(timeDuration "$(date +%s)" 1)"
 echo "Precision 6 duration:$(timeDuration $((60+60*60+60*60*24+60*60*24*30+60*60*24*365 - (60+60*60+60*60*24+60*60*24*30) )) 6)"

-timeDuration "$@"
+echo "Parsing argument provided to script:\"$*\""; timeDuration "$@"

 #==END sample code==
 
 # Author: Steven Baltakatei Sandoval
 #==END sample code==
 
 # Author: Steven Baltakatei Sandoval