Bug 26265: (QA follow-up) Remove g option from regex, add few dirs
[koha-equinox.git] / Koha / DateUtils.pm
index 7a98120..9b599e3 100644 (file)
@@ -3,27 +3,25 @@ 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 strict;
-use warnings;
-use 5.010;
+use Modern::Perl;
 use DateTime;
 use C4::Context;
+use Koha::Exceptions;
 
 use base 'Exporter';
-use version; our $VERSION = qv('1.0.0');
 
 our @EXPORT = (
     qw( dt_from_string output_pref format_sqldatetime )
@@ -86,6 +84,16 @@ sub dt_from_string {
             (?<year>\d{4})
         |xms;
     }
+    elsif ( $date_format eq 'dmydot' ) {
+        # dmydot format is "dd.mm.yyyy[ hh:mm:ss]"
+        $regex = qr|
+            (?<day>\d{2})
+            .
+            (?<month>\d{2})
+            .
+            (?<year>\d{4})
+        |xms;
+    }
     elsif ( $date_format eq 'us' ) {
         # us format is "mm/dd/yyyy[ hh:mm:ss]"
         $regex = qr|
@@ -96,6 +104,22 @@ 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])|([\+|\-]([01][0-9]|2[0-3]):[0-5][0-9]))
+        /xms;
+    }
     elsif ( $date_format eq 'iso' or $date_format eq 'sql' ) {
         # iso or sql format are yyyy-dd-mm[ hh:mm:ss]"
         $regex = $fallback_re;
@@ -115,12 +139,17 @@ sub dt_from_string {
                     :
                     (?<second>\d{2})
                 )?
+                (
+                    \s
+                    (?<ampm>\w{2})
+                )?
             )?
     |xms;
     $regex .= $time_re;
     $fallback_re .= $time_re;
 
     my %dt_params;
+    my $ampm;
     if ( $date_string =~ $regex ) {
         %dt_params = (
             year   => $+{year},
@@ -130,6 +159,7 @@ sub dt_from_string {
             minute => $+{minute},
             second => $+{second},
         );
+        $ampm = $+{ampm};
     } elsif ( $date_string =~ $fallback_re ) {
         %dt_params = (
             year   => $+{year},
@@ -139,6 +169,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)";
@@ -152,6 +183,15 @@ sub dt_from_string {
     $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 $dt = eval {
         DateTime->new(
             %dt_params,
@@ -189,9 +229,10 @@ should be returned without the time.
 
 sub output_pref {
     my $params = shift;
-    my ( $dt, $force_pref, $force_time, $dateonly, $as_due_date );
+    my ( $dt, $str, $force_pref, $force_time, $dateonly, $as_due_date );
     if ( ref $params eq 'HASH' ) {
         $dt         = $params->{dt};
+        $str        = $params->{str};
         $force_pref = $params->{dateformat};         # if testing we want to override Context
         $force_time = $params->{timeformat};
         $dateonly   = $params->{dateonly} || 0;    # if you don't want the hours and minutes
@@ -200,7 +241,16 @@ sub output_pref {
         $dt = $params;
     }
 
-    return unless defined $dt;
+    Koha::Exceptions::WrongParameter->throw( 'output_pref should not be called with both dt and str parameter' ) if $dt and $str;
+
+    if ( $str ) {
+        local $@;
+        $dt = eval { dt_from_string( $str ) };
+        Koha::Exceptions::WrongParameter->throw("Invalid date '$str' passed to output_pref" ) if $@;
+    }
+
+    return if !defined $dt; # NULL date
+    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/ ) {
@@ -219,11 +269,26 @@ 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")
           : $dt->strftime("%d/%m/%Y $time");
     }
+    elsif ( $pref =~ m/^dmydot/ ) {
+        $date = $dateonly
+          ? $dt->strftime("%d.%m.%Y")
+          : $dt->strftime("%d.%m.%Y $time");
+    }
+
     elsif ( $pref =~ m/^us/ ) {
         $date = $dateonly
           ? $dt->strftime("%m/%d/%Y")