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 strict;
  20 use warnings;
  21 use 5.010;
  22 use DateTime;
  23 use DateTime::Format::DateParse;
  24 use C4::Context;
  25
  26 use base 'Exporter';
  27 use version; our $VERSION = qv('1.0.0');
  28
  29 our @EXPORT = (
  30     qw( dt_from_string output_pref format_sqldatetime output_pref_due format_sqlduedatetime)
  31 );
  32
  33 =head1 DateUtils
  34
  35 Koha::DateUtils - Transitional wrappers to ease use of DateTime
  36
  37 =head1 DESCRIPTION
  38
  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
  42
  43 =cut
  44
  45 =head2 dt_ftom_string
  46
  47 $dt = dt_from_string($date_string, [$format, $timezone ]);
  48
  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
  51
  52 =cut
  53
  54 sub dt_from_string {
  55     my ( $date_string, $date_format, $tz ) = @_;
  56     if ( !$tz ) {
  57         $tz = C4::Context->tz;
  58     }
  59     if ( !$date_format ) {
  60         $date_format = C4::Context->preference('dateformat');
  61     }
  62     if ($date_string) {
  63         if ( ref($date_string) eq 'DateTime' ) {    # already a dt return it
  64             return $date_string;
  65         }
  66
  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#;
  71         } else {
  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
  76                 }
  77             } elsif ( $date_format eq 'us' ) {
  78                 $date_string =~ s#-#/#g;
  79                 $date_string =~ s[/00/][/01/];
  80             } elsif ( $date_format eq 'sql' ) {
  81                 $date_string =~
  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/;
  85             }
  86         }
  87         return DateTime::Format::DateParse->parse_datetime( $date_string,
  88             $tz->name() );
  89     }
  90     return DateTime->now( time_zone => $tz );
  91
  92 }
  93
  94 =head2 output_pref
  95
  96 $date_string = output_pref({ dt => $dt [, dateformat => $date_format, timeformat => $time_format, dateonly => 0|1 ] });
  97 $date_string = output_pref( $dt );
  98
  99 Returns a string containing the time & date formatted as per the C4::Context setting,
 100 or C<undef> if C<undef> was provided.
 101
 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
 104
 105 A third parameter allows overriding of the TimeFormat syspref value
 106
 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;
 109
 110 =cut
 111
 112 sub output_pref {
 113     my $params = shift;
 114     my ( $dt, $force_pref, $force_time, $dateonly );
 115     if ( ref $params eq 'HASH' ) {
 116         $dt         = $params->{dt};
 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
 120     } else {
 121         $dt = $params;
 122     }
 123
 124     return unless defined $dt;
 125
 126     $dt->set_time_zone( C4::Context->tz );
 127
 128     my $pref =
 129       defined $force_pref ? $force_pref : C4::Context->preference('dateformat');
 130
 131     my $time_format = $force_time || C4::Context->preference('TimeFormat');
 132     my $time = ( $time_format eq '12hr' ) ? '%I:%M %p' : '%H:%M';
 133
 134     given ($pref) {
 135         when (/^iso/) {
 136             return $dateonly
 137                 ? $dt->strftime("%Y-%m-%d")
 138                 : $dt->strftime("%Y-%m-%d $time");
 139         }
 140         when (/^metric/) {
 141             return $dateonly
 142                 ? $dt->strftime("%d/%m/%Y")
 143                 : $dt->strftime("%d/%m/%Y $time");
 144         }
 145         when (/^us/) {
 146
 147             return $dateonly
 148                 ? $dt->strftime("%m/%d/%Y")
 149                 : $dt->strftime("%m/%d/%Y $time");
 150         }
 151         default {
 152             return $dateonly
 153                 ? $dt->strftime("%Y-%m-%d")
 154                 : $dt->strftime("%Y-%m-%d $time");
 155         }
 156
 157     }
 158     return;
 159 }
 160
 161 =head2 output_pref_due
 162
 163 $date_string = output_pref({ dt => $dt [, dateformat => $date_format, timeformat => $time_format, dateonly => 0|1 ] });
 164
 165 Returns a string containing the time & date formatted as per the C4::Context setting
 166
 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
 169
 170 This is effectivelyt a wrapper around output_pref for due dates
 171 the time portion is stripped if it is '23:59'
 172
 173 =cut
 174
 175 sub output_pref_due {
 176     my $disp_str = output_pref(@_);
 177     $disp_str =~ s/ 23:59//;
 178     return $disp_str;
 179 }
 180
 181 =head2 format_sqldatetime
 182
 183 $string = format_sqldatetime( $string_as_returned_from_db );
 184
 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
 187
 188 =cut
 189
 190 sub format_sqldatetime {
 191     my $str        = shift;
 192     my $force_pref = shift;    # if testing we want to override Context
 193     my $force_time = shift;
 194     my $dateonly   = shift;
 195
 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' );
 200         return output_pref({
 201             dt => $dt,
 202             dateformat => $force_pref,
 203             timeformat => $force_time,
 204             dateonly => $dateonly
 205         });
 206     }
 207     return q{};
 208 }
 209
 210 =head2 format_sqlduedatetime
 211
 212 $string = format_sqldatetime( $string_as_returned_from_db );
 213
 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
 216
 217 =cut
 218
 219 sub format_sqlduedatetime {
 220     my $str        = shift;
 221     my $force_pref = shift;    # if testing we want to override Context
 222     my $force_time = shift;
 223     my $dateonly   = shift;
 224
 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({
 229             dt => $dt,
 230             dateformat => $force_pref,
 231             timeformat => $force_time,
 232             dateonly => $dateonly
 233         });
 234     }
 235     return q{};
 236 }
 237
 238 1;