# 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., 59 Temple Place,
-# Suite 330, Boston, MA 02111-1307 USA
+# Koha; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
use strict;
use warnings;
use base 'Exporter';
use version; our $VERSION = qv('1.0.0');
-our @EXPORT = (qw( dt_from_string output_pref));
+our @EXPORT = (
+ 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;
- }
+
+ # FIXME: see bug 13242 => no TZ for dates 'infinite'
+ return DateTime::Format::DateParse->parse_datetime($date_string)
+ if $date_string and $date_string =~ /^9999-/;
+
+ my $dt;
+ $tz ||= C4::Context->tz;
if ( !$date_format ) {
$date_format = C4::Context->preference('dateformat');
}
} 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/;
}
}
- return DateTime::Format::DateParse->parse_datetime( $date_string,
- $tz->name() );
+
+ $dt = eval {
+ DateTime::Format::DateParse->parse_datetime( $date_string,
+ $tz->name() );
+ };
+ if ($@) {
+ $tz = DateTime::TimeZone->new( name => 'floating' );
+ $dt = DateTime::Format::DateParse->parse_datetime( $date_string,
+ $tz->name() );
+ }
+ } else {
+ $dt = DateTime->now( time_zone => $tz );
}
- return DateTime->now( time_zone => $tz );
+
+ return $dt;
}
=head2 output_pref
-$date_string = output_pref($dt, [$format] );
+$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
+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
+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 $dt = shift;
- my $force_pref = shift; # if testing we want to override Context
+ my $params = shift;
+ my ( $dt, $force_pref, $force_time, $dateonly, $as_due_date );
+ if ( ref $params eq 'HASH' ) {
+ $dt = $params->{dt};
+ $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;
+
+ # 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');
- given ($pref) {
- when (/^iso/) {
- return $dt->strftime('%Y-%m-%d %H:%M');
- }
- when (/^metric/) {
- return $dt->strftime('%d/%m/%Y %H:%M');
- }
- when (/^us/) {
- return $dt->strftime('%m/%d/%Y %H:%M');
- }
- default {
- return $dt->strftime('%Y-%m-%d %H:%M');
- }
+ my $time_format = $force_time || C4::Context->preference('TimeFormat') || q{};
+ my $time = ( $time_format eq '12hr' ) ? '%I:%M %p' : '%H:%M';
+ my $date;
+ if ( $pref =~ m/^iso/ ) {
+ $date = $dateonly
+ ? $dt->strftime("%Y-%m-%d")
+ : $dt->strftime("%Y-%m-%d $time");
+ }
+ elsif ( $pref =~ m/^metric/ ) {
+ $date = $dateonly
+ ? $dt->strftime("%d/%m/%Y")
+ : $dt->strftime("%d/%m/%Y $time");
+ }
+ 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");
+ }
+
+ if ( $as_due_date ) {
+ $time_format eq '12hr'
+ ? $date =~ s| 11:59 PM$||
+ : $date =~ s| 23:59$||;
+ }
+
+ return $date;
+}
+
+=head2 format_sqldatetime
+
+$string = format_sqldatetime( $string_as_returned_from_db );
+
+a convenience routine for calling dt_from_string and formatting the result
+with output_pref as it is a frequent activity in scripts
+
+=cut
+
+sub format_sqldatetime {
+ 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' );
+ return q{} unless $dt;
+ $dt->truncate( to => 'minute' );
+ return output_pref({
+ dt => $dt,
+ dateformat => $force_pref,
+ timeformat => $force_time,
+ dateonly => $dateonly
+ });
}
- return;
+ return q{};
}
1;