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 under the
7 # terms of the GNU General Public License as published by the Free Software
8 # Foundation; either version 2 of the License, or (at your option) any later
11 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
12 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License along with
16 # Koha; if not, write to the Free Software Foundation, Inc.,
17 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 use DateTime::Format::DateParse;
27 use version; our $VERSION = qv('1.0.0');
30 qw( dt_from_string output_pref format_sqldatetime output_pref_due format_sqlduedatetime)
35 Koha::DateUtils - Transitional wrappers to ease use of DateTime
39 Koha has historically only used dates not datetimes and been content to
40 handle these as strings. It also has confused formatting with actual dates
41 this is a temporary module for wrappers to hide the complexity of switch to DateTime
47 $dt = dt_from_string($date_string, [$format, $timezone ]);
49 Passed a date string returns a DateTime object format and timezone default
50 to the system preferences. If the date string is empty DateTime->now is returned
55 my ( $date_string, $date_format, $tz ) = @_;
57 $tz = C4::Context->tz;
59 if ( !$date_format ) {
60 $date_format = C4::Context->preference('dateformat');
63 if ( ref($date_string) eq 'DateTime' ) { # already a dt return it
67 if ( $date_format eq 'metric' ) {
68 $date_string =~ s#-#/#g;
69 $date_string =~ s/^00/01/; # system allows the 0th of the month
70 $date_string =~ s#^(\d{1,2})/(\d{1,2})#$2/$1#;
72 if ( $date_format eq 'iso' ) {
73 $date_string =~ s/-00/-01/;
74 if ( $date_string =~ m/^0000-0/ ) {
75 return; # invalid date in db
77 } elsif ( $date_format eq 'us' ) {
78 $date_string =~ s#-#/#g;
79 $date_string =~ s[/00/][/01/];
80 } elsif ( $date_format eq 'sql' ) {
82 s/(\d{4})(\d{2})(\d{2})\s+(\d{2})(\d{2})(\d{2})/$1-$2-$3T$4:$5:$6/;
83 return if ($date_string =~ /^0000-00-00/);
84 $date_string =~ s/00T/01T/;
87 return DateTime::Format::DateParse->parse_datetime( $date_string,
90 return DateTime->now( time_zone => $tz );
96 $date_string = output_pref({ dt => $dt [, dateformat => $date_format, timeformat => $time_format, dateonly => 0|1 ] });
97 $date_string = output_pref( $dt );
99 Returns a string containing the time & date formatted as per the C4::Context setting,
100 or C<undef> if C<undef> was provided.
102 A second parameter allows overriding of the syspref value. This is for testing only
103 In usage use the DateTime objects own methods for non standard formatting
105 A third parameter allows overriding of the TimeFormat syspref value
107 A fourth parameter allows to specify if the output format contains the hours and minutes.
108 If it is not defined, the default value is 0;
114 my ( $dt, $force_pref, $force_time, $dateonly );
115 if ( ref $params eq 'HASH' ) {
117 $force_pref = $params->{dateformat}; # if testing we want to override Context
118 $force_time = $params->{timeformat};
119 $dateonly = $params->{dateonly} || 0; # if you don't want the hours and minutes
124 return unless defined $dt;
126 $dt->set_time_zone( C4::Context->tz );
129 defined $force_pref ? $force_pref : C4::Context->preference('dateformat');
131 my $time_format = $force_time || C4::Context->preference('TimeFormat');
132 my $time = ( $time_format eq '12hr' ) ? '%I:%M %p' : '%H:%M';
137 ? $dt->strftime("%Y-%m-%d")
138 : $dt->strftime("%Y-%m-%d $time");
142 ? $dt->strftime("%d/%m/%Y")
143 : $dt->strftime("%d/%m/%Y $time");
148 ? $dt->strftime("%m/%d/%Y")
149 : $dt->strftime("%m/%d/%Y $time");
153 ? $dt->strftime("%Y-%m-%d")
154 : $dt->strftime("%Y-%m-%d $time");
161 =head2 output_pref_due
163 $date_string = output_pref({ dt => $dt [, dateformat => $date_format, timeformat => $time_format, dateonly => 0|1 ] });
165 Returns a string containing the time & date formatted as per the C4::Context setting
167 A second parameter allows overriding of the syspref value. This is for testing only
168 In usage use the DateTime objects own methods for non standard formatting
170 This is effectivelyt a wrapper around output_pref for due dates
171 the time portion is stripped if it is '23:59'
175 sub output_pref_due {
176 my $disp_str = output_pref(@_);
177 $disp_str =~ s/ 23:59//;
181 =head2 format_sqldatetime
183 $string = format_sqldatetime( $string_as_returned_from_db );
185 a convenience routine for calling dt_from_string and formatting the result
186 with output_pref as it is a frequent activity in scripts
190 sub format_sqldatetime {
192 my $force_pref = shift; # if testing we want to override Context
193 my $force_time = shift;
194 my $dateonly = shift;
196 if ( defined $str && $str =~ m/^\d{4}-\d{2}-\d{2}/ ) {
197 my $dt = dt_from_string( $str, 'sql' );
198 return q{} unless $dt;
199 $dt->truncate( to => 'minute' );
202 dateformat => $force_pref,
203 timeformat => $force_time,
204 dateonly => $dateonly
210 =head2 format_sqlduedatetime
212 $string = format_sqldatetime( $string_as_returned_from_db );
214 a convenience routine for calling dt_from_string and formatting the result
215 with output_pref_due as it is a frequent activity in scripts
219 sub format_sqlduedatetime {
221 my $force_pref = shift; # if testing we want to override Context
222 my $force_time = shift;
223 my $dateonly = shift;
225 if ( defined $str && $str =~ m/^\d{4}-\d{2}-\d{2}/ ) {
226 my $dt = dt_from_string( $str, 'sql' );
227 $dt->truncate( to => 'minute' );
228 return output_pref_due({
230 dateformat => $force_pref,
231 timeformat => $force_time,
232 dateonly => $dateonly