update(README):Clarify `user` directory

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

diff --git a/unitproc/bktemp-timeDuration b/unitproc/bktemp-timeDuration
index 25740ff1e5537364217af74b2c7c3c647a0a3881..1db408b8c101a203a026a03ab16486b2544a23f8 100644 (file)
--- a/unitproc/bktemp-timeDuration
+++ b/unitproc/bktemp-timeDuration
@@ -6,59 +6,62 @@ 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])
-    # Version: 1.0.1
+    # Usage: timeDuration [1:seconds] ([2:precision])
+    # Version: 1.0.5

     # 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), yell, 
-    local returnState ARG1 ARG2 remainder precision witherPrecision
+    # Depends: date 8, bash 5, yell,
+    local argSeconds argPrecision precision returnState remainder

     local fullYears fullMonths fullDays fullHours fullMinutes fullSeconds
     local fullYears fullMonths fullDays fullHours fullMinutes fullSeconds

-    local displayYears displayMonths displayDays displayHours displayMinutes displaySeconds

     local hasYears hasMonths hasDays hasHours hasMinutes hasSeconds
     local hasYears hasMonths hasDays hasHours hasMinutes hasSeconds

+    local witherPrecision output
+    local displayYears displayMonths displayDays displayHours displayMinutes displaySeconds

     
     

-    ARG1="$1";
-    ARG2="$2";
+    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
+       ## Check that argSeconds is a positive integer
+       if [[ "$argSeconds" =~ ^[[:digit:]]+$ ]]; then

            :
        else
            :
        else

-           yell "ERROR:ARG1 not a digit.";
-           returnState="ERROR_INPUT";
+           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
-       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";
+           yell "ERROR:argPrecision not a positive integer. (is $argPrecision ). Leaving early.";
+           returnState="error_input";

        fi;
     else
        :
     fi;
     
        fi;
     else
        :
     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) ));


@@ -83,7 +86,7 @@ timeDuration(){
     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 [[ $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
+    if [[ $fullSeconds -ge 0 ]]; then hasSeconds="true"; else hasSeconds="false"; fi

     
     ## Determine which fields to display (see ISO-8601:2004 §4.4.3.2)
     witherPrecision="false"
     
     ## Determine which fields to display (see ISO-8601:2004 §4.4.3.2)
     witherPrecision="false"


@@ -158,38 +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
     if ( $displayHours || $displayMinutes || $displaySeconds); then
        displayDateTime="true"; else displayDateTime="false"; fi
     
     ## Construct duration output string
     ## 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"
+    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
+    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 )


@@ -202,7 +206,8 @@ 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 "Zero seconds:$(timeDuration "0")";
+echo "Parsing argument provided to script:\"$*\""; timeDuration "$@"

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