Bug 30110: Fix concatenation during assignements
[srvgit] / Koha / DateUtils.pm
index 66ad264..222aa16 100644 (file)
@@ -3,29 +3,35 @@ package Koha::DateUtils;
 # Copyright (c) 2011 PTFS-Europe Ltd.
 # This file is part of Koha.
 #
-# Koha is free software; you can redistribute it and/or modify it under the
-# terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
 #
-# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
-# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
-# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
 #
-# You should have received a copy of the GNU General Public License along with
-# Koha; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
 use Modern::Perl;
 use DateTime;
 use C4::Context;
 use Koha::Exceptions;
 
-use base 'Exporter';
+use vars qw(@ISA @EXPORT_OK);
+BEGIN {
+    require Exporter;
+    @ISA = qw(Exporter);
 
-our @EXPORT = (
-    qw( dt_from_string output_pref format_sqldatetime )
-);
+    @EXPORT_OK = qw(
+        dt_from_string
+        output_pref
+        format_sqldatetime
+    );
+}
 
 =head1 DateUtils
 
@@ -53,7 +59,9 @@ sub dt_from_string {
 
     return if $date_string and $date_string =~ m|^0000-0|;
 
-    $tz = C4::Context->tz unless $tz;;
+    my $do_fallback = defined($date_format) ? 0 : 1;
+    my $server_tz = C4::Context->tz;
+    $tz = C4::Context->tz unless $tz;
 
     return DateTime->now( time_zone => $tz ) unless $date_string;
 
@@ -104,6 +112,28 @@ sub dt_from_string {
             (?<year>\d{4})
         |xms;
     }
+    elsif ( $date_format eq 'rfc3339' ) {
+        $regex = qr/
+            (?<year>\d{4})
+            -
+            (?<month>\d{2})
+            -
+            (?<day>\d{2})
+            ([Tt\s])
+            (?<hour>\d{2})
+            :
+            (?<minute>\d{2})
+            :
+            (?<second>\d{2})
+            (\.\d{1,3})?(([Zz]$)|((?<offset>[\+|\-])(?<hours>[01][0-9]|2[0-3]):(?<minutes>[0-5][0-9])))
+        /xms;
+
+        # Default to UTC (when 'Z' is passed) for inbound timezone.
+        # The regex above succeeds for both 'z', 'Z' and '+/-' offset.
+        # We set tz as though Z was passed by default and then correct it later if an offset is detected
+        # by the presence fo the <offset> variable.
+        $tz = DateTime::TimeZone->new( name => 'UTC' );
+    }
     elsif ( $date_format eq 'iso' or $date_format eq 'sql' ) {
         # iso or sql format are yyyy-dd-mm[ hh:mm:ss]"
         $regex = $fallback_re;
@@ -112,9 +142,10 @@ sub dt_from_string {
         die "Invalid dateformat parameter ($date_format)";
     }
 
-    # Add the faculative time part [hh:mm[:ss]]
-    my $time_re .= qr|
+    # Add the facultative time part including time zone offset; ISO8601 allows +02 or +0200 too
+    my $time_re = qr{
             (
+                [Tt]?
                 \s*
                 (?<hour>\d{2})
                 :
@@ -123,12 +154,24 @@ sub dt_from_string {
                     :
                     (?<second>\d{2})
                 )?
+                (
+                    \s
+                    (?<ampm>\w{2})
+                )?
+                (
+                    (?<utc>[Zz]$)|((?<offset>[\+|\-])(?<hours>[01][0-9]|2[0-3]):?(?<minutes>[0-5][0-9])?)
+                )?
             )?
-    |xms;
-    $regex .= $time_re;
+    }xms;
+    $regex .= $time_re unless ( $date_format eq 'rfc3339' );
     $fallback_re .= $time_re;
 
+    # Ensure we only accept date strings and not other characters.
+    $regex = '^' . $regex . '$';
+    $fallback_re = '^' . $fallback_re . '$';
+
     my %dt_params;
+    my $ampm;
     if ( $date_string =~ $regex ) {
         %dt_params = (
             year   => $+{year},
@@ -138,7 +181,15 @@ sub dt_from_string {
             minute => $+{minute},
             second => $+{second},
         );
-    } elsif ( $date_string =~ $fallback_re ) {
+        $ampm = $+{ampm};
+        if ( $+{utc} ) {
+            $tz = DateTime::TimeZone->new( name => 'UTC' );
+        }
+        if ( $+{offset} ) {
+            # If offset given, set inbound timezone using it.
+            $tz = DateTime::TimeZone->new( name => $+{offset} . $+{hours} . ( $+{minutes} || '00' ) );
+        }
+    } elsif ( $do_fallback && $date_string =~ $fallback_re ) {
         %dt_params = (
             year   => $+{year},
             month  => $+{month},
@@ -147,6 +198,7 @@ sub dt_from_string {
             minute => $+{minute},
             second => $+{second},
         );
+        $ampm = $+{ampm};
     }
     else {
         die "The given date ($date_string) does not match the date format ($date_format)";
@@ -156,25 +208,43 @@ sub dt_from_string {
     $dt_params{day} = '01' if $dt_params{day} eq '00';
 
     # Set default hh:mm:ss to 00:00:00
+    my $date_only = ( !defined( $dt_params{hour} )
+        && !defined( $dt_params{minute} )
+        && !defined( $dt_params{second} ) );
     $dt_params{hour}   = 00 unless defined $dt_params{hour};
     $dt_params{minute} = 00 unless defined $dt_params{minute};
     $dt_params{second} = 00 unless defined $dt_params{second};
 
+    if ( $ampm ) {
+        if ( $ampm eq 'AM' ) {
+            $dt_params{hour} = 00 if $dt_params{hour} == 12;
+        } elsif ( $dt_params{hour} != 12 ) { # PM
+            $dt_params{hour} += 12;
+            $dt_params{hour} = 00 if $dt_params{hour} == 24;
+        }
+    }
+
+    my $floating = 0;
     my $dt = eval {
         DateTime->new(
             %dt_params,
             # No TZ for dates 'infinite' => see bug 13242
-            ( $dt_params{year} < 9999 ? ( time_zone => $tz->name ) : () ),
+            ( $dt_params{year} < 9999 ? ( time_zone => $tz ) : () ),
         );
     };
     if ($@) {
         $tz = DateTime::TimeZone->new( name => 'floating' );
+        $floating = 1;
         $dt = DateTime->new(
             %dt_params,
             # No TZ for dates 'infinite' => see bug 13242
-            ( $dt_params{year} < 9999 ? ( time_zone => $tz->name ) : () ),
+            ( $dt_params{year} < 9999 ? ( time_zone => $tz ) : () ),
         );
     }
+
+    # Convert to configured timezone (unless we started with a dateonly string or had to drop to floating time)
+    $dt->set_time_zone($server_tz) unless ( $date_only || $floating );
+
     return $dt;
 }
 
@@ -218,7 +288,7 @@ sub output_pref {
     }
 
     return if !defined $dt; # NULL date
-    Koha::Exceptions::WrongParameter->throw( 'dt is not a datetime' )  if ref($dt) ne 'DateTime';
+    Koha::Exceptions::WrongParameter->throw( "output_pref is called with '$dt' (ref ". ( ref($dt) ? ref($dt):'SCALAR')."), not a DateTime object")  if ref($dt) ne 'DateTime';
 
     # FIXME: see bug 13242 => no TZ for dates 'infinite'
     if ( $dt->ymd !~ /^9999/ ) {
@@ -237,6 +307,15 @@ sub output_pref {
           ? $dt->strftime("%Y-%m-%d")
           : $dt->strftime("%Y-%m-%d $time");
     }
+    elsif ( $pref =~ m/^rfc3339/ ) {
+        if (!$dateonly) {
+            $date = $dt->strftime('%FT%T%z');
+            substr($date, -2, 0, ':'); # timezone "HHmm" => "HH:mm"
+        }
+        else {
+            $date = $dt->strftime("%Y-%m-%d");
+        }
+    }
     elsif ( $pref =~ m/^metric/ ) {
         $date = $dateonly
           ? $dt->strftime("%d/%m/%Y")