Koha/DateUtils.pm

   1 package Koha::DateUtils;
   2
   3 # Copyright (c) 2011 PTFS-Europe Ltd.
   4 # This file is part of Koha.
   5 #
   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
   9 # version.
  10 #
  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.
  14 #
  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.
  18
  19 use Modern::Perl;
  20 use DateTime;
  21 use C4::Context;
  22 use Carp;
  23
  24 use base 'Exporter';
  25
  26 our @EXPORT = (
  27     qw( dt_from_string output_pref format_sqldatetime )
  28 );
  29
  30 =head1 DateUtils
  31
  32 Koha::DateUtils - Transitional wrappers to ease use of DateTime
  33
  34 =head1 DESCRIPTION
  35
  36 Koha has historically only used dates not datetimes and been content to
  37 handle these as strings. It also has confused formatting with actual dates
  38 this is a temporary module for wrappers to hide the complexity of switch to DateTime
  39
  40 =cut
  41
  42 =head2 dt_ftom_string
  43
  44 $dt = dt_from_string($date_string, [$format, $timezone ]);
  45
  46 Passed a date string returns a DateTime object format and timezone default
  47 to the system preferences. If the date string is empty DateTime->now is returned
  48
  49 =cut
  50
  51 sub dt_from_string {
  52     my ( $date_string, $date_format, $tz ) = @_;
  53
  54     return if $date_string and $date_string =~ m|^0000-0|;
  55
  56     $tz = C4::Context->tz unless $tz;;
  57
  58     return DateTime->now( time_zone => $tz ) unless $date_string;
  59
  60     $date_format = C4::Context->preference('dateformat') unless $date_format;
  61
  62     if ( ref($date_string) eq 'DateTime' ) {    # already a dt return it
  63         return $date_string;
  64     }
  65
  66     my $regex;
  67
  68     # The fallback format is sql/iso
  69     my $fallback_re = qr|
  70         (?<year>\d{4})
  71         -
  72         (?<month>\d{2})
  73         -
  74         (?<day>\d{2})
  75     |xms;
  76
  77     if ( $date_format eq 'metric' ) {
  78         # metric format is "dd/mm/yyyy[ hh:mm:ss]"
  79         $regex = qr|
  80             (?<day>\d{2})
  81             /
  82             (?<month>\d{2})
  83             /
  84             (?<year>\d{4})
  85         |xms;
  86     }
  87     elsif ( $date_format eq 'dmydot' ) {
  88         # dmydot format is "dd.mm.yyyy[ hh:mm:ss]"
  89         $regex = qr|
  90             (?<day>\d{2})
  91             .
  92             (?<month>\d{2})
  93             .
  94             (?<year>\d{4})
  95         |xms;
  96     }
  97     elsif ( $date_format eq 'us' ) {
  98         # us format is "mm/dd/yyyy[ hh:mm:ss]"
  99         $regex = qr|
 100             (?<month>\d{2})
 101             /
 102             (?<day>\d{2})
 103             /
 104             (?<year>\d{4})
 105         |xms;
 106     }
 107     elsif ( $date_format eq 'iso' or $date_format eq 'sql' ) {
 108         # iso or sql format are yyyy-dd-mm[ hh:mm:ss]"
 109         $regex = $fallback_re;
 110     }
 111     else {
 112         die "Invalid dateformat parameter ($date_format)";
 113     }
 114
 115     # Add the faculative time part [hh:mm[:ss]]
 116     my $time_re .= qr|
 117             (
 118                 \s*
 119                 (?<hour>\d{2})
 120                 :
 121                 (?<minute>\d{2})
 122                 (
 123                     :
 124                     (?<second>\d{2})
 125                 )?
 126             )?
 127     |xms;
 128     $regex .= $time_re;
 129     $fallback_re .= $time_re;
 130
 131     my %dt_params;
 132     if ( $date_string =~ $regex ) {
 133         %dt_params = (
 134             year   => $+{year},
 135             month  => $+{month},
 136             day    => $+{day},
 137             hour   => $+{hour},
 138             minute => $+{minute},
 139             second => $+{second},
 140         );
 141     } elsif ( $date_string =~ $fallback_re ) {
 142         %dt_params = (
 143             year   => $+{year},
 144             month  => $+{month},
 145             day    => $+{day},
 146             hour   => $+{hour},
 147             minute => $+{minute},
 148             second => $+{second},
 149         );
 150     }
 151     else {
 152         die "The given date ($date_string) does not match the date format ($date_format)";
 153     }
 154
 155     # system allows the 0th of the month
 156     $dt_params{day} = '01' if $dt_params{day} eq '00';
 157
 158     # Set default hh:mm:ss to 00:00:00
 159     $dt_params{hour}   = 00 unless defined $dt_params{hour};
 160     $dt_params{minute} = 00 unless defined $dt_params{minute};
 161     $dt_params{second} = 00 unless defined $dt_params{second};
 162
 163     my $dt = eval {
 164         DateTime->new(
 165             %dt_params,
 166             # No TZ for dates 'infinite' => see bug 13242
 167             ( $dt_params{year} < 9999 ? ( time_zone => $tz->name ) : () ),
 168         );
 169     };
 170     if ($@) {
 171         $tz = DateTime::TimeZone->new( name => 'floating' );
 172         $dt = DateTime->new(
 173             %dt_params,
 174             # No TZ for dates 'infinite' => see bug 13242
 175             ( $dt_params{year} < 9999 ? ( time_zone => $tz->name ) : () ),
 176         );
 177     }
 178     return $dt;
 179 }
 180
 181 =head2 output_pref
 182
 183 $date_string = output_pref({ dt => $dt [, dateformat => $date_format, timeformat => $time_format, dateonly => 0|1, as_due_date => 0|1 ] });
 184 $date_string = output_pref( $dt );
 185
 186 Returns a string containing the time & date formatted as per the C4::Context setting,
 187 or C<undef> if C<undef> was provided.
 188
 189 This routine can either be passed a DateTime object or or a hashref.  If it is
 190 passed a hashref, the expected keys are a mandatory 'dt' for the DateTime,
 191 an optional 'dateformat' to override the dateformat system preference, an
 192 optional 'timeformat' to override the TimeFormat system preference value,
 193 and an optional 'dateonly' to specify that only the formatted date string
 194 should be returned without the time.
 195
 196 =cut
 197
 198 sub output_pref {
 199     my $params = shift;
 200     my ( $dt, $str, $force_pref, $force_time, $dateonly, $as_due_date );
 201     if ( ref $params eq 'HASH' ) {
 202         $dt         = $params->{dt};
 203         $str        = $params->{str};
 204         $force_pref = $params->{dateformat};         # if testing we want to override Context
 205         $force_time = $params->{timeformat};
 206         $dateonly   = $params->{dateonly} || 0;    # if you don't want the hours and minutes
 207         $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)
 208     } else {
 209         $dt = $params;
 210     }
 211
 212     carp "output_pref should not be called with both dt and str parameters"
 213         and return
 214             if $dt and $str;
 215
 216     $dt = eval { dt_from_string( $str ) } if $str;
 217     carp "Invalid date '$str' passed to output_pref\n" if $@;
 218
 219     return unless defined $dt;
 220
 221     # FIXME: see bug 13242 => no TZ for dates 'infinite'
 222     if ( $dt->ymd !~ /^9999/ ) {
 223         my $tz = $dateonly ? DateTime::TimeZone->new(name => 'floating') : C4::Context->tz;
 224         $dt->set_time_zone( $tz );
 225     }
 226
 227     my $pref =
 228       defined $force_pref ? $force_pref : C4::Context->preference('dateformat');
 229
 230     my $time_format = $force_time || C4::Context->preference('TimeFormat') || q{};
 231     my $time = ( $time_format eq '12hr' ) ? '%I:%M %p' : '%H:%M';
 232     my $date;
 233     if ( $pref =~ m/^iso/ ) {
 234         $date = $dateonly
 235           ? $dt->strftime("%Y-%m-%d")
 236           : $dt->strftime("%Y-%m-%d $time");
 237     }
 238     elsif ( $pref =~ m/^metric/ ) {
 239         $date = $dateonly
 240           ? $dt->strftime("%d/%m/%Y")
 241           : $dt->strftime("%d/%m/%Y $time");
 242     }
 243     elsif ( $pref =~ m/^dmydot/ ) {
 244         $date = $dateonly
 245           ? $dt->strftime("%d.%m.%Y")
 246           : $dt->strftime("%d.%m.%Y $time");
 247     }
 248
 249     elsif ( $pref =~ m/^us/ ) {
 250         $date = $dateonly
 251           ? $dt->strftime("%m/%d/%Y")
 252           : $dt->strftime("%m/%d/%Y $time");
 253     }
 254     else {
 255         $date = $dateonly
 256           ? $dt->strftime("%Y-%m-%d")
 257           : $dt->strftime("%Y-%m-%d $time");
 258     }
 259
 260     if ( $as_due_date ) {
 261         $time_format eq '12hr'
 262             ? $date =~ s| 11:59 PM$||
 263             : $date =~ s| 23:59$||;
 264     }
 265
 266     return $date;
 267 }
 268
 269 =head2 format_sqldatetime
 270
 271 $string = format_sqldatetime( $string_as_returned_from_db );
 272
 273 a convenience routine for calling dt_from_string and formatting the result
 274 with output_pref as it is a frequent activity in scripts
 275
 276 =cut
 277
 278 sub format_sqldatetime {
 279     my $str        = shift;
 280     my $force_pref = shift;    # if testing we want to override Context
 281     my $force_time = shift;
 282     my $dateonly   = shift;
 283
 284     if ( defined $str && $str =~ m/^\d{4}-\d{2}-\d{2}/ ) {
 285         my $dt = dt_from_string( $str, 'sql' );
 286         return q{} unless $dt;
 287         $dt->truncate( to => 'minute' );
 288         return output_pref({
 289             dt => $dt,
 290             dateformat => $force_pref,
 291             timeformat => $force_time,
 292             dateonly => $dateonly
 293         });
 294     }
 295     return q{};
 296 }
 297
 298 1;