Changeset 848 for trunk/core/lib/Foswiki/Time.pm

Timestamp:

11/22/08 11:11:26 (4 years ago)

Author:

CrawfordCurrie

Message:

Item240: recoded interval parser and added unit tests

File:

• trunk/core/lib/Foswiki/Time.pm (modified) (3 diffs)

trunk/core/lib/Foswiki/Time.pm

@@ -350 +350 @@
    * y(year), m(month), w(week), d(day), h(hour), M(minute), S(second)
 
-=date= follows ISO8601 and must include hypens.  (any amount of trailing
+=date= follows ISO8601 and must include hyphens.  (any amount of trailing
        elements may be omitted and will be filled in differently on the
        differents ends of the interval as to include the longest possible
@@ -368 +368 @@
 
 sub parseInterval {
-    my ($theInterval) = @_;
-
+    my ($interval) = @_;
     my @lt    = localtime();
     my $today = sprintf( '%04d-%02d-%02d', $lt[5] + 1900, $lt[4] + 1, $lt[3] );
@@ -375 +374 @@
 
     # replace $now and $today shortcuts
-    $theInterval =~ s/\$today/$today/g;
-    $theInterval =~ s/\$now/$now/g;
+    $interval =~ s/\$today/$today/g;
+    $interval =~ s/\$now/$now/g;
 
     # if $theDate does not contain a '/': force it to do so.
-    $theInterval = $theInterval . '/' . $theInterval
-      unless ( $theInterval =~ /\// );
-
-    my @ends = split( /\//, $theInterval );
+    $interval = $interval . '/' . $interval
+      unless ( $interval =~ /\// );
+
+    my ($first, $last) = split( /\//, $interval, 2 );
+    my ( $start, $end );
 
     # first translate dates into seconds from epoch,
     # in the second loop we will examine interval durations.
 
-    foreach my $i ( 0, 1 ) {
-
-        #   if not a period of time:
-        next if ( $ends[$i] =~ /^P/ );
-
-        #   TODO assert(must include the year)
-        if ($i) {
-
-            # fillEnd
-            #     if ending point, complete with parts from "-12-31T23:59:60"
-            #     if completing ending point, check last day of month
-            # TODO: do we do leap years?
-            if ( length( $ends[$i] ) == 7 ) {
-                my $month = substr( $ends[$i], 5 );
-                $ends[$i] .= $MONTHLENS[ $month - 1 ];
-            }
-            $ends[$i] .= substr( "0000-12-31T23:59:59", length( $ends[$i] ) );
-        }
-        else {
-
-            # fillStart
-            #     if starting point, complete with parts from "-01-01T00:00:00"
-            $ends[$i] .= substr( "0000-01-01T00:00:00", length( $ends[$i] ) );
-        }
-
-        #     convert the string into integer amount of seconds
-        #     from 1970-01-01T00:00:00.00 UTC
-
-        $ends[$i] = parseTime( $ends[$i], 1 );
-    }
-
-    # now we're ready to translate interval durations...
-    # ... we don't do P<whatever/P<whatever> !!!
-
-    my @oper = ( "-", "+" );
-
-    # if any extreme was a time duration, examine it
-    foreach my $i ( 0, 1 ) {
-        next unless ( $ends[$i] =~ /^P/ );
-
-        #   drop the 'P', substitute each letter with '*<value>+',
-        #   where <value> is the amount of seconds represented by
-        #   the unit.  for example: w (week) becomes '*604800+'.
-        $ends[$i] =~ s/^P//;
-        $ends[$i] =~ s/y/\*31556925\+/gi;    # tropical year
-        $ends[$i] =~ s/m/\*2592000\+/g;      # 1m = 30 days
-        $ends[$i] =~ s/w/\*604800\+/gi;      # 1w = 7 days
-        $ends[$i] =~ s/d/\*86400\+/gi;
-        $ends[$i] =~ s/h/\*3600\+/gi;
-        $ends[$i] =~ s/M/\*60\+/g;           # note: m != M
-        $ends[$i] =~ s/S/\*1\+/gi;
-
-        #   possibly append '0' and evaluate numerically the string.
-        $ends[$i] =~ s/\+$/+0/;
-        my $duration = eval( $ends[$i] );
-
-        #   the value computed, if it specifies the starting point
-        #   in time, must be subtracted from the previously
-        #   computed ending point.  if it specifies the ending
-        #   point, it must be added to the previously computed
-        #   starting point.
-        $ends[$i] = eval( $ends[ 1 - $i ] . $oper[$i] . $ends[$i] );
-
-        # SMELL: if the user specified both start and end as a
-        # time duration, some kind of error must be reported.
-    }
-    return @ends;
+    if ( $first !~ /^P/ ) {
+        # complete with parts from "-01-01T00:00:00"
+        if ( length($first) < length('0000-01-01T00:00:00')) {
+            $first .= substr( '0000-01-01T00:00:00', length( $first ) );
+        }
+        $start = parseTime( $first, 1 );
+    }
+
+    if ($last !~ /^P/) {
+        # complete with parts from "-12-31T23:59:60"
+        # check last day of month
+        # TODO: do we do leap years?
+        if ( length( $last ) == 7 ) {
+            my $month = substr( $last, 5 );
+            $last .= '-'.$MONTHLENS[ $month - 1 ];
+        }
+        if ( length($last) < length('0000-12-31T23:59:59')) {
+            $last .= substr( '0000-12-31T23:59:59', length( $last ) );
+        }
+        $end = parseTime( $last, 1 );
+    }
+
+    if (!defined($start)) {
+        $start = $end - _parseDuration( $first );
+    }
+    if (!defined($end)) {
+        $end = $start + _parseDuration( $last );
+    }
+    return ( $start || 0, $end || 0);
+}
+
+sub _parseDuration {
+    my $s = shift;
+    my $d = 0;
+    $s =~ s/(\d+)y/$d += $1 * 31556925;''/gei;    # tropical year
+    $s =~ s/(\d+)m/$d += $1 * 2592000; ''/ge;     # 1m = 30 days
+    $s =~ s/(\d+)w/$d += $1 * 604800;  ''/gei;    # 1w = 7 days
+    $s =~ s/(\d+)d/$d += $1 * 86400;   ''/gei;    # 1d = 24 hours
+    $s =~ s/(\d+)h/$d += $1 * 3600;    ''/gei;    # 1 hour = 60 mins
+    $s =~ s/(\d+)M/$d += $1 * 60;      ''/ge;     # note: m != M
+    $s =~ s/(\d+)S/$d += $1 * 1;       ''/gei;
+    return $d;
 }