# 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 base 'Exporter';
-use version; our $VERSION = qv('1.0.0');
-
-our @EXPORT = (
- qw( dt_from_string output_pref format_sqldatetime )
-);
+use Koha::Exceptions;
+
+use vars qw(@ISA @EXPORT_OK);
+BEGIN {
+ require Exporter;
+ @ISA = qw(Exporter);
+
+ @EXPORT_OK = qw(
+ dt_from_string
+ output_pref
+ format_sqldatetime
+ flatpickr_date_format
+ );
+}
=head1 DateUtils
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;
}
my $regex;
+
+ # The fallback format is sql/iso
+ my $fallback_re = qr|
+ (?<year>\d{4})
+ -
+ (?<month>\d{2})
+ -
+ (?<day>\d{2})
+ |xms;
+
if ( $date_format eq 'metric' ) {
# metric format is "dd/mm/yyyy[ hh:mm:ss]"
$regex = qr|
(?<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|
(?<year>\d{4})
|xms;
}
- elsif ( $date_format eq 'iso' or $date_format eq 'sql' ) {
- # iso format is yyyy-dd-mm[ hh:mm:ss]"
- $regex = qr|
+ elsif ( $date_format eq 'rfc3339' ) {
+ $regex = qr/
(?<year>\d{4})
-
(?<month>\d{2})
-
(?<day>\d{2})
- |xms;
+ ([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;
}
else {
die "Invalid dateformat parameter ($date_format)";
}
- # Add the faculative time part [hh:mm[:ss]]
- $regex .= 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})
:
:
(?<second>\d{2})
)?
+ (
+ \s
+ (?<ampm>\w{2})
+ )?
+ (
+ (?<utc>[Zz]$)|((?<offset>[\+|\-])(?<hours>[01][0-9]|2[0-3]):?(?<minutes>[0-5][0-9])?)
+ )?
)?
- |xms;
+ }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},
minute => $+{minute},
second => $+{second},
);
+ $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},
+ day => $+{day},
+ hour => $+{hour},
+ minute => $+{minute},
+ second => $+{second},
+ );
+ $ampm = $+{ampm};
}
else {
die "The given date ($date_string) does not match the date format ($date_format)";
$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;
}
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
$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/ ) {
my $tz = $dateonly ? DateTime::TimeZone->new(name => 'floating') : C4::Context->tz;
- $dt->set_time_zone( $tz );
+ eval { $dt->set_time_zone( $tz ); }
}
my $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")
return q{};
}
+=head2 flatpickr_date_format
+
+$date_format = flatpickr_date_format( $koha_date_format );
+
+Converts Koha's date format to Flatpickr's. E.g. 'us' returns 'm/d/Y'.
+
+If no argument is given, the dateformat preference is assumed.
+
+Returns undef if format is unknown.
+
+=cut
+
+sub flatpickr_date_format {
+ my $arg = shift // C4::Context->preference('dateformat');
+ return {
+ us => 'm/d/Y',
+ metric => 'd/m/Y',
+ dmydot => 'd.m.Y',
+ iso => 'Y-m-d',
+ }->{$arg};
+}
+
1;