# 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 DateTime::Format::DateParse;
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 output_pref_due format_sqlduedatetime)
+ qw( dt_from_string output_pref format_sqldatetime )
);
=head1 DateUtils
sub dt_from_string {
my ( $date_string, $date_format, $tz ) = @_;
- if ( !$tz ) {
- $tz = C4::Context->tz;
+
+ return if $date_string and $date_string =~ m|^0000-0|;
+
+ $tz = C4::Context->tz unless $tz;;
+
+ return DateTime->now( time_zone => $tz ) unless $date_string;
+
+ $date_format = C4::Context->preference('dateformat') unless $date_format;
+
+ if ( ref($date_string) eq 'DateTime' ) { # already a dt return it
+ return $date_string;
}
- if ( !$date_format ) {
- $date_format = C4::Context->preference('dateformat');
+
+ 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|
+ (?<day>\d{2})
+ /
+ (?<month>\d{2})
+ /
+ (?<year>\d{4})
+ |xms;
}
- if ($date_string) {
- if ( ref($date_string) eq 'DateTime' ) { # already a dt return it
- return $date_string;
- }
+ 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|
+ (?<month>\d{2})
+ /
+ (?<day>\d{2})
+ /
+ (?<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;
+ }
+ else {
+ die "Invalid dateformat parameter ($date_format)";
+ }
+
+ # Add the faculative time part [hh:mm[:ss]]
+ my $time_re .= qr|
+ (
+ \s*
+ (?<hour>\d{2})
+ :
+ (?<minute>\d{2})
+ (
+ :
+ (?<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},
+ month => $+{month},
+ day => $+{day},
+ hour => $+{hour},
+ minute => $+{minute},
+ second => $+{second},
+ );
+ $ampm = $+{ampm};
+ } elsif ( $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)";
+ }
+
+ # system allows the 0th of the month
+ $dt_params{day} = '01' if $dt_params{day} eq '00';
+
+ # Set default hh:mm:ss to 00:00:00
+ $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 ( $date_format eq 'metric' ) {
- $date_string =~ s#-#/#g;
- $date_string =~ s/^00/01/; # system allows the 0th of the month
- $date_string =~ s#^(\d{1,2})/(\d{1,2})#$2/$1#;
- } else {
- if ( $date_format eq 'iso' ) {
- $date_string =~ s/-00/-01/;
- if ( $date_string =~ m/^0000-0/ ) {
- return; # invalid date in db
- }
- } elsif ( $date_format eq 'us' ) {
- $date_string =~ s#-#/#g;
- $date_string =~ s[/00/][/01/];
- } elsif ( $date_format eq 'sql' ) {
- $date_string =~
-s/(\d{4})(\d{2})(\d{2})\s+(\d{2})(\d{2})(\d{2})/$1-$2-$3T$4:$5:$6/;
- return if ($date_string =~ /^0000-00-00/);
- $date_string =~ s/00T/01T/;
- }
+ 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;
}
- return DateTime::Format::DateParse->parse_datetime( $date_string,
- $tz->name() );
}
- return DateTime->now( time_zone => $tz );
+ my $dt = eval {
+ DateTime->new(
+ %dt_params,
+ # No TZ for dates 'infinite' => see bug 13242
+ ( $dt_params{year} < 9999 ? ( time_zone => $tz->name ) : () ),
+ );
+ };
+ if ($@) {
+ $tz = DateTime::TimeZone->new( name => 'floating' );
+ $dt = DateTime->new(
+ %dt_params,
+ # No TZ for dates 'infinite' => see bug 13242
+ ( $dt_params{year} < 9999 ? ( time_zone => $tz->name ) : () ),
+ );
+ }
+ return $dt;
}
=head2 output_pref
-$date_string = output_pref({ dt => $dt [, dateformat => $date_format, timeformat => $time_format, dateonly => 0|1 ] });
+$date_string = output_pref({ dt => $dt [, dateformat => $date_format, timeformat => $time_format, dateonly => 0|1, as_due_date => 0|1 ] });
$date_string = output_pref( $dt );
Returns a string containing the time & date formatted as per the C4::Context setting,
or C<undef> if C<undef> was provided.
-A second parameter allows overriding of the syspref value. This is for testing only
-In usage use the DateTime objects own methods for non standard formatting
-
-A third parameter allows overriding of the TimeFormat syspref value
-
-A fourth parameter allows to specify if the output format contains the hours and minutes.
-If it is not defined, the default value is 0;
+This routine can either be passed a DateTime object or or a hashref. If it is
+passed a hashref, the expected keys are a mandatory 'dt' for the DateTime,
+an optional 'dateformat' to override the dateformat system preference, an
+optional 'timeformat' to override the TimeFormat system preference value,
+and an optional 'dateonly' to specify that only the formatted date string
+should be returned without the time.
=cut
sub output_pref {
my $params = shift;
- my ( $dt, $force_pref, $force_time, $dateonly );
+ 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
+ $as_due_date = $params->{as_due_date} || 0; # don't display the hours and minutes if eq to 23:59 or 11:59 (depending the TimeFormat value)
} else {
$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';
- $dt->set_time_zone( C4::Context->tz );
+ # 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 );
+ }
my $pref =
defined $force_pref ? $force_pref : C4::Context->preference('dateformat');
- my $time_format = $force_time || C4::Context->preference('TimeFormat');
+ my $time_format = $force_time || C4::Context->preference('TimeFormat') || q{};
my $time = ( $time_format eq '12hr' ) ? '%I:%M %p' : '%H:%M';
-
- given ($pref) {
- when (/^iso/) {
- return $dateonly
- ? $dt->strftime("%Y-%m-%d")
- : $dt->strftime("%Y-%m-%d $time");
- }
- when (/^metric/) {
- return $dateonly
- ? $dt->strftime("%d/%m/%Y")
- : $dt->strftime("%d/%m/%Y $time");
- }
- when (/^us/) {
-
- return $dateonly
- ? $dt->strftime("%m/%d/%Y")
- : $dt->strftime("%m/%d/%Y $time");
+ my $date;
+ if ( $pref =~ m/^iso/ ) {
+ $date = $dateonly
+ ? $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"
}
- default {
- return $dateonly
- ? $dt->strftime("%Y-%m-%d")
- : $dt->strftime("%Y-%m-%d $time");
+ else {
+ $date = $dt->strftime("%Y-%m-%d");
}
-
}
- return;
-}
-
-=head2 output_pref_due
-
-$date_string = output_pref({ dt => $dt [, dateformat => $date_format, timeformat => $time_format, dateonly => 0|1 ] });
-
-Returns a string containing the time & date formatted as per the C4::Context setting
-
-A second parameter allows overriding of the syspref value. This is for testing only
-In usage use the DateTime objects own methods for non standard formatting
+ 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");
+ }
-This is effectivelyt a wrapper around output_pref for due dates
-the time portion is stripped if it is '23:59'
+ elsif ( $pref =~ m/^us/ ) {
+ $date = $dateonly
+ ? $dt->strftime("%m/%d/%Y")
+ : $dt->strftime("%m/%d/%Y $time");
+ }
+ else {
+ $date = $dateonly
+ ? $dt->strftime("%Y-%m-%d")
+ : $dt->strftime("%Y-%m-%d $time");
+ }
-=cut
+ if ( $as_due_date ) {
+ $time_format eq '12hr'
+ ? $date =~ s| 11:59 PM$||
+ : $date =~ s| 23:59$||;
+ }
-sub output_pref_due {
- my $disp_str = output_pref(@_);
- $disp_str =~ s/ 23:59//;
- return $disp_str;
+ return $date;
}
=head2 format_sqldatetime
return q{};
}
-=head2 format_sqlduedatetime
-
-$string = format_sqldatetime( $string_as_returned_from_db );
-
-a convenience routine for calling dt_from_string and formatting the result
-with output_pref_due as it is a frequent activity in scripts
-
-=cut
-
-sub format_sqlduedatetime {
- my $str = shift;
- my $force_pref = shift; # if testing we want to override Context
- my $force_time = shift;
- my $dateonly = shift;
-
- if ( defined $str && $str =~ m/^\d{4}-\d{2}-\d{2}/ ) {
- my $dt = dt_from_string( $str, 'sql' );
- $dt->truncate( to => 'minute' );
- return output_pref_due({
- dt => $dt,
- dateformat => $force_pref,
- timeformat => $force_time,
- dateonly => $dateonly
- });
- }
- return q{};
-}
-
1;
projects / koha-equinox.git / blobdiff