1 package Koha::DateUtils;
3 # Copyright (c) 2011 PTFS-Europe Ltd.
4 # This file is part of Koha.
6 # Koha is free software; you can redistribute it and/or modify it
7 # under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 3 of the License, or
9 # (at your option) any later version.
11 # Koha is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with Koha; if not, see <http://www.gnu.org/licenses>.
24 use vars qw(@ISA @EXPORT_OK);
39 Koha::DateUtils - Transitional wrappers to ease use of DateTime
43 Koha has historically only used dates not datetimes and been content to
44 handle these as strings. It also has confused formatting with actual dates
45 this is a temporary module for wrappers to hide the complexity of switch to DateTime
51 $dt = dt_from_string($date_string, [$format, $timezone ]);
53 Passed a date string returns a DateTime object format and timezone default
54 to the system preferences. If the date string is empty DateTime->now is returned
59 my ( $date_string, $date_format, $tz ) = @_;
61 return if $date_string and $date_string =~ m|^0000-0|;
63 my $do_fallback = defined($date_format) ? 0 : 1;
64 my $server_tz = C4::Context->tz;
65 $tz = C4::Context->tz unless $tz;
67 return DateTime->now( time_zone => $tz ) unless $date_string;
69 $date_format = C4::Context->preference('dateformat') unless $date_format;
71 if ( ref($date_string) eq 'DateTime' ) { # already a dt return a clone
72 return $date_string->clone();
77 # The fallback format is sql/iso
86 if ( $date_format eq 'metric' ) {
87 # metric format is "dd/mm/yyyy[ hh:mm:ss]"
96 elsif ( $date_format eq 'dmydot' ) {
97 # dmydot format is "dd.mm.yyyy[ hh:mm:ss]"
106 elsif ( $date_format eq 'us' ) {
107 # us format is "mm/dd/yyyy[ hh:mm:ss]"
116 elsif ( $date_format eq 'rfc3339' ) {
129 (\.\d{1,3})?(([Zz]$)|((?<offset>[\+|\-])(?<hours>[01][0-9]|2[0-3]):(?<minutes>[0-5][0-9])))
132 # Default to UTC (when 'Z' is passed) for inbound timezone.
133 # The regex above succeeds for both 'z', 'Z' and '+/-' offset.
134 # We set tz as though Z was passed by default and then correct it later if an offset is detected
135 # by the presence fo the <offset> variable.
136 $tz = DateTime::TimeZone->new( name => 'UTC' );
138 elsif ( $date_format eq 'iso' or $date_format eq 'sql' ) {
139 # iso or sql format are yyyy-dd-mm[ hh:mm:ss]"
140 $regex = $fallback_re;
143 die "Invalid dateformat parameter ($date_format)";
146 # Add the facultative time part including time zone offset; ISO8601 allows +02 or +0200 too
163 (?<utc>[Zz]$)|((?<offset>[\+|\-])(?<hours>[01][0-9]|2[0-3]):?(?<minutes>[0-5][0-9])?)
167 $regex .= $time_re unless ( $date_format eq 'rfc3339' );
168 $fallback_re .= $time_re;
170 # Ensure we only accept date strings and not other characters.
171 $regex = '^' . $regex . '$';
172 $fallback_re = '^' . $fallback_re . '$';
176 if ( $date_string =~ $regex ) {
182 minute => $+{minute},
183 second => $+{second},
187 $tz = DateTime::TimeZone->new( name => 'UTC' );
190 # If offset given, set inbound timezone using it.
191 $tz = DateTime::TimeZone->new( name => $+{offset} . $+{hours} . ( $+{minutes} || '00' ) );
193 } elsif ( $do_fallback && $date_string =~ $fallback_re ) {
199 minute => $+{minute},
200 second => $+{second},
205 die "The given date ($date_string) does not match the date format ($date_format)";
208 # system allows the 0th of the month
209 $dt_params{day} = '01' if $dt_params{day} eq '00';
211 # Set default hh:mm:ss to 00:00:00
212 my $date_only = ( !defined( $dt_params{hour} )
213 && !defined( $dt_params{minute} )
214 && !defined( $dt_params{second} ) );
215 $dt_params{hour} = 00 unless defined $dt_params{hour};
216 $dt_params{minute} = 00 unless defined $dt_params{minute};
217 $dt_params{second} = 00 unless defined $dt_params{second};
220 if ( $ampm eq 'AM' ) {
221 $dt_params{hour} = 00 if $dt_params{hour} == 12;
222 } elsif ( $dt_params{hour} != 12 ) { # PM
223 $dt_params{hour} += 12;
224 $dt_params{hour} = 00 if $dt_params{hour} == 24;
232 # No TZ for dates 'infinite' => see bug 13242
233 ( $dt_params{year} < 9999 ? ( time_zone => $tz ) : () ),
237 $tz = DateTime::TimeZone->new( name => 'floating' );
241 # No TZ for dates 'infinite' => see bug 13242
242 ( $dt_params{year} < 9999 ? ( time_zone => $tz ) : () ),
246 # Convert to configured timezone (unless we started with a dateonly string or had to drop to floating time)
247 $dt->set_time_zone($server_tz) unless ( $date_only || $floating );
254 $date_string = output_pref({ dt => $dt [, dateformat => $date_format, timeformat => $time_format, dateonly => 0|1, as_due_date => 0|1 ] });
255 $date_string = output_pref( $dt );
257 Returns a string containing the time & date formatted as per the C4::Context setting,
258 or C<undef> if C<undef> was provided.
260 This routine can either be passed a DateTime object or or a hashref. If it is
261 passed a hashref, the expected keys are a mandatory 'dt' for the DateTime,
262 an optional 'dateformat' to override the dateformat system preference, an
263 optional 'timeformat' to override the TimeFormat system preference value,
264 and an optional 'dateonly' to specify that only the formatted date string
265 should be returned without the time.
271 my ( $dt, $str, $force_pref, $force_time, $dateonly, $as_due_date );
272 if ( ref $params eq 'HASH' ) {
274 $str = $params->{str};
275 $force_pref = $params->{dateformat}; # if testing we want to override Context
276 $force_time = $params->{timeformat};
277 $dateonly = $params->{dateonly} || 0; # if you don't want the hours and minutes
278 $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)
283 Koha::Exceptions::WrongParameter->throw( 'output_pref should not be called with both dt and str parameter' ) if $dt and $str;
287 $dt = eval { dt_from_string( $str ) };
288 Koha::Exceptions::WrongParameter->throw("Invalid date '$str' passed to output_pref" ) if $@;
291 return if !defined $dt; # NULL date
292 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';
294 # FIXME: see bug 13242 => no TZ for dates 'infinite'
295 if ( $dt->ymd !~ /^9999/ ) {
296 my $tz = $dateonly ? DateTime::TimeZone->new(name => 'floating') : C4::Context->tz;
297 eval { $dt->set_time_zone( $tz ); }
301 defined $force_pref ? $force_pref : C4::Context->preference('dateformat');
303 my $time_format = $force_time || C4::Context->preference('TimeFormat') || q{};
304 my $time = ( $time_format eq '12hr' ) ? '%I:%M %p' : '%H:%M';
306 if ( $pref =~ m/^iso/ ) {
308 ? $dt->strftime("%Y-%m-%d")
309 : $dt->strftime("%Y-%m-%d $time");
311 elsif ( $pref =~ m/^rfc3339/ ) {
313 $date = $dt->strftime('%FT%T%z');
314 substr($date, -2, 0, ':'); # timezone "HHmm" => "HH:mm"
317 $date = $dt->strftime("%Y-%m-%d");
320 elsif ( $pref =~ m/^metric/ ) {
322 ? $dt->strftime("%d/%m/%Y")
323 : $dt->strftime("%d/%m/%Y $time");
325 elsif ( $pref =~ m/^dmydot/ ) {
327 ? $dt->strftime("%d.%m.%Y")
328 : $dt->strftime("%d.%m.%Y $time");
331 elsif ( $pref =~ m/^us/ ) {
333 ? $dt->strftime("%m/%d/%Y")
334 : $dt->strftime("%m/%d/%Y $time");
338 ? $dt->strftime("%Y-%m-%d")
339 : $dt->strftime("%Y-%m-%d $time");
342 if ( $as_due_date ) {
343 $time_format eq '12hr'
344 ? $date =~ s| 11:59 PM$||
345 : $date =~ s| 23:59$||;
351 =head2 format_sqldatetime
353 $string = format_sqldatetime( $string_as_returned_from_db );
355 a convenience routine for calling dt_from_string and formatting the result
356 with output_pref as it is a frequent activity in scripts
360 sub format_sqldatetime {
362 my $force_pref = shift; # if testing we want to override Context
363 my $force_time = shift;
364 my $dateonly = shift;
366 if ( defined $str && $str =~ m/^\d{4}-\d{2}-\d{2}/ ) {
367 my $dt = dt_from_string( $str, 'sql' );
368 return q{} unless $dt;
369 $dt->truncate( to => 'minute' );
372 dateformat => $force_pref,
373 timeformat => $force_time,
374 dateonly => $dateonly
380 =head2 flatpickr_date_format
382 $date_format = flatpickr_date_format( $koha_date_format );
384 Converts Koha's date format to Flatpickr's. E.g. 'us' returns 'm/d/Y'.
386 If no argument is given, the dateformat preference is assumed.
388 Returns undef if format is unknown.
392 sub flatpickr_date_format {
393 my $arg = shift // C4::Context->preference('dateformat');