Bug 24305: (follow-up) Add small comment for square brackets in get_prepped_report
[koha.git] / Koha / Calendar.pm
blob7382fb8ce45278b35c3184c7483b0f21bbd143f6
1 package Koha::Calendar;
2 use strict;
3 use warnings;
4 use 5.010;
6 use DateTime;
7 use DateTime::Set;
8 use DateTime::Duration;
9 use C4::Context;
10 use Koha::Caches;
11 use Carp;
13 sub new {
14 my ( $classname, %options ) = @_;
15 my $self = {};
16 bless $self, $classname;
17 for my $o_name ( keys %options ) {
18 my $o = lc $o_name;
19 $self->{$o} = $options{$o_name};
21 if ( !defined $self->{branchcode} ) {
22 croak 'No branchcode argument passed to Koha::Calendar->new';
24 $self->_init();
25 return $self;
28 sub _init {
29 my $self = shift;
30 my $branch = $self->{branchcode};
31 my $dbh = C4::Context->dbh();
32 my $weekly_closed_days_sth = $dbh->prepare(
33 'SELECT weekday FROM repeatable_holidays WHERE branchcode = ? AND weekday IS NOT NULL'
35 $weekly_closed_days_sth->execute( $branch );
36 $self->{weekly_closed_days} = [ 0, 0, 0, 0, 0, 0, 0 ];
37 while ( my $tuple = $weekly_closed_days_sth->fetchrow_hashref ) {
38 $self->{weekly_closed_days}->[ $tuple->{weekday} ] = 1;
40 my $day_month_closed_days_sth = $dbh->prepare(
41 'SELECT day, month FROM repeatable_holidays WHERE branchcode = ? AND weekday IS NULL'
43 $day_month_closed_days_sth->execute( $branch );
44 $self->{day_month_closed_days} = {};
45 while ( my $tuple = $day_month_closed_days_sth->fetchrow_hashref ) {
46 $self->{day_month_closed_days}->{ $tuple->{month} }->{ $tuple->{day} } =
50 $self->{days_mode} ||= C4::Context->preference('useDaysMode');
51 $self->{test} = 0;
52 return;
55 sub exception_holidays {
56 my ( $self ) = @_;
58 my $cache = Koha::Caches->get_instance();
59 my $cached = $cache->get_from_cache('exception_holidays');
60 return $cached if $cached;
62 my $dbh = C4::Context->dbh;
63 my $branch = $self->{branchcode};
64 my $exception_holidays_sth = $dbh->prepare(
65 'SELECT day, month, year FROM special_holidays WHERE branchcode = ? AND isexception = 1'
67 $exception_holidays_sth->execute( $branch );
68 my $dates = [];
69 while ( my ( $day, $month, $year ) = $exception_holidays_sth->fetchrow ) {
70 push @{$dates},
71 DateTime->new(
72 day => $day,
73 month => $month,
74 year => $year,
75 time_zone => "floating",
76 )->truncate( to => 'day' );
78 $self->{exception_holidays} =
79 DateTime::Set->from_datetimes( dates => $dates );
80 $cache->set_in_cache( 'exception_holidays', $self->{exception_holidays} );
81 return $self->{exception_holidays};
84 sub single_holidays {
85 my ( $self, $date ) = @_;
86 my $branchcode = $self->{branchcode};
87 my $cache = Koha::Caches->get_instance();
88 my $single_holidays = $cache->get_from_cache('single_holidays');
90 # $single_holidays looks like:
91 # {
92 # CPL => [
93 # [0] 20131122,
94 # ...
95 # ],
96 # ...
97 # }
99 unless ($single_holidays) {
100 my $dbh = C4::Context->dbh;
101 $single_holidays = {};
103 # push holidays for each branch
104 my $branches_sth =
105 $dbh->prepare('SELECT distinct(branchcode) FROM special_holidays');
106 $branches_sth->execute();
107 while ( my $br = $branches_sth->fetchrow ) {
108 my $single_holidays_sth = $dbh->prepare(
109 'SELECT day, month, year FROM special_holidays WHERE branchcode = ? AND isexception = 0'
111 $single_holidays_sth->execute($br);
113 my @ymd_arr;
114 while ( my ( $day, $month, $year ) =
115 $single_holidays_sth->fetchrow )
117 my $dt = DateTime->new(
118 day => $day,
119 month => $month,
120 year => $year,
121 time_zone => 'floating',
122 )->truncate( to => 'day' );
123 push @ymd_arr, $dt->ymd('');
125 $single_holidays->{$br} = \@ymd_arr;
126 } # br
127 $cache->set_in_cache( 'single_holidays', $single_holidays,
128 { expiry => 76800 } ) #24 hrs ;
130 my $holidays = ( $single_holidays->{$branchcode} );
131 for my $hols (@$holidays ) {
132 return 1 if ( $date == $hols ) #match ymds;
134 return 0;
137 sub addDate {
138 my ( $self, $startdate, $add_duration, $unit ) = @_;
140 # Default to days duration (legacy support I guess)
141 if ( ref $add_duration ne 'DateTime::Duration' ) {
142 $add_duration = DateTime::Duration->new( days => $add_duration );
145 $unit ||= 'days'; # default days ?
146 my $dt;
147 if ( $unit eq 'hours' ) {
148 # Fixed for legacy support. Should be set as a branch parameter
149 my $return_by_hour = 10;
151 $dt = $self->addHours($startdate, $add_duration, $return_by_hour);
152 } else {
153 # days
154 $dt = $self->addDays($startdate, $add_duration);
156 return $dt;
159 sub addHours {
160 my ( $self, $startdate, $hours_duration, $return_by_hour ) = @_;
161 my $base_date = $startdate->clone();
163 $base_date->add_duration($hours_duration);
165 # If we are using the calendar behave for now as if Datedue
166 # was the chosen option (current intended behaviour)
168 if ( $self->{days_mode} ne 'Days' &&
169 $self->is_holiday($base_date) ) {
171 if ( $hours_duration->is_negative() ) {
172 $base_date = $self->prev_open_days($base_date, 1);
173 } else {
174 $base_date = $self->next_open_days($base_date, 1);
177 $base_date->set_hour($return_by_hour);
181 return $base_date;
184 sub addDays {
185 my ( $self, $startdate, $days_duration ) = @_;
186 my $base_date = $startdate->clone();
188 $self->{days_mode} ||= q{};
190 if ( $self->{days_mode} eq 'Calendar' ) {
191 # use the calendar to skip all days the library is closed
192 # when adding
193 my $days = abs $days_duration->in_units('days');
195 if ( $days_duration->is_negative() ) {
196 while ($days) {
197 $base_date = $self->prev_open_days($base_date, 1);
198 --$days;
200 } else {
201 while ($days) {
202 $base_date = $self->next_open_days($base_date, 1);
203 --$days;
207 } else { # Days, Datedue or Dayweek
208 # use straight days, then use calendar to push
209 # the date to the next open day as appropriate
210 # if Datedue or Dayweek
211 $base_date->add_duration($days_duration);
213 if ( $self->{days_mode} eq 'Datedue' ||
214 $self->{days_mode} eq 'Dayweek') {
215 # Datedue or Dayweek, then use the calendar to push
216 # the date to the next open day if holiday
217 if ( $self->is_holiday($base_date) ) {
218 my $dow = $base_date->day_of_week;
219 my $days = $days_duration->in_units('days');
220 # Is it a period based on weeks
221 my $push_amt = $days % 7 == 0 ?
222 $self->get_push_amt($base_date) : 1;
223 if ( $days_duration->is_negative() ) {
224 $base_date = $self->prev_open_days($base_date, $push_amt);
225 } else {
226 $base_date = $self->next_open_days($base_date, $push_amt);
232 return $base_date;
235 sub get_push_amt {
236 my ( $self, $base_date) = @_;
238 my $dow = $base_date->day_of_week;
239 return (
240 # We're using Dayweek useDaysMode option
241 $self->{days_mode} eq 'Dayweek' &&
242 # It's not a permanently closed day
243 !$self->{weekly_closed_days}->[$dow] == 1
244 ) ? 7 : 1;
247 sub is_holiday {
248 my ( $self, $dt ) = @_;
250 my $localdt = $dt->clone();
251 my $day = $localdt->day;
252 my $month = $localdt->month;
254 #Change timezone to "floating" before doing any calculations or comparisons
255 $localdt->set_time_zone("floating");
256 $localdt->truncate( to => 'day' );
259 if ( $self->exception_holidays->contains($localdt) ) {
260 # exceptions are not holidays
261 return 0;
264 my $dow = $localdt->day_of_week;
265 # Representation fix
266 # DateTime object dow (1-7) where Monday is 1
267 # Arrays are 0-based where 0 = Sunday, not 7.
268 if ( $dow == 7 ) {
269 $dow = 0;
272 if ( $self->{weekly_closed_days}->[$dow] == 1 ) {
273 return 1;
276 if ( exists $self->{day_month_closed_days}->{$month}->{$day} ) {
277 return 1;
280 my $ymd = $localdt->ymd('') ;
281 if ($self->single_holidays( $ymd ) == 1 ) {
282 return 1;
285 # damn have to go to work after all
286 return 0;
289 sub next_open_days {
290 my ( $self, $dt, $to_add ) = @_;
291 my $base_date = $dt->clone();
293 $base_date->add(days => $to_add);
294 while ($self->is_holiday($base_date)) {
295 my $add_next = $self->get_push_amt($base_date);
296 $base_date->add(days => $add_next);
298 return $base_date;
301 sub prev_open_days {
302 my ( $self, $dt, $to_sub ) = @_;
303 my $base_date = $dt->clone();
305 # It feels logical to be passed a positive number, though we're
306 # subtracting, so do the right thing
307 $to_sub = $to_sub > 0 ? 0 - $to_sub : $to_sub;
309 $base_date->add(days => $to_sub);
311 while ($self->is_holiday($base_date)) {
312 my $sub_next = $self->get_push_amt($base_date);
313 # Ensure we're subtracting when we need to be
314 $sub_next = $sub_next > 0 ? 0 - $sub_next : $sub_next;
315 $base_date->add(days => $sub_next);
318 return $base_date;
321 sub days_forward {
322 my $self = shift;
323 my $start_dt = shift;
324 my $num_days = shift;
326 return $start_dt unless $num_days > 0;
328 my $base_dt = $start_dt->clone();
330 while ($num_days--) {
331 $base_dt = $self->next_open_days($base_dt, 1);
334 return $base_dt;
337 sub days_between {
338 my $self = shift;
339 my $start_dt = shift;
340 my $end_dt = shift;
342 # Change time zone for date math and swap if needed
343 $start_dt = $start_dt->clone->set_time_zone('floating');
344 $end_dt = $end_dt->clone->set_time_zone('floating');
345 if( $start_dt->compare($end_dt) > 0 ) {
346 ( $start_dt, $end_dt ) = ( $end_dt, $start_dt );
349 # start and end should not be closed days
350 my $delta_days = $start_dt->delta_days($end_dt)->delta_days;
351 while( $start_dt->compare($end_dt) < 1 ) {
352 $delta_days-- if $self->is_holiday($start_dt);
353 $start_dt->add( days => 1 );
355 return DateTime::Duration->new( days => $delta_days );
358 sub hours_between {
359 my ($self, $start_date, $end_date) = @_;
360 my $start_dt = $start_date->clone()->set_time_zone('floating');
361 my $end_dt = $end_date->clone()->set_time_zone('floating');
363 my $duration = $end_dt->delta_ms($start_dt);
364 $start_dt->truncate( to => 'day' );
365 $end_dt->truncate( to => 'day' );
367 # NB this is a kludge in that it assumes all days are 24 hours
368 # However for hourly loans the logic should be expanded to
369 # take into account open/close times then it would be a duration
370 # of library open hours
371 my $skipped_days = 0;
372 while( $start_dt->compare($end_dt) < 1 ) {
373 $skipped_days++ if $self->is_holiday($start_dt);
374 $start_dt->add( days => 1 );
377 if ($skipped_days) {
378 $duration->subtract_duration(DateTime::Duration->new( hours => 24 * $skipped_days));
381 return $duration;
384 sub set_daysmode {
385 my ( $self, $mode ) = @_;
387 # if not testing this is a no op
388 if ( $self->{test} ) {
389 $self->{days_mode} = $mode;
392 return;
395 sub clear_weekly_closed_days {
396 my $self = shift;
397 $self->{weekly_closed_days} = [ 0, 0, 0, 0, 0, 0, 0 ]; # Sunday only
398 return;
402 __END__
404 =head1 NAME
406 Koha::Calendar - Object containing a branches calendar
408 =head1 SYNOPSIS
410 use Koha::Calendar
412 my $c = Koha::Calendar->new( branchcode => 'MAIN' );
413 my $dt = DateTime->now();
415 # are we open
416 $open = $c->is_holiday($dt);
417 # when will item be due if loan period = $dur (a DateTime::Duration object)
418 $duedate = $c->addDate($dt,$dur,'days');
421 =head1 DESCRIPTION
423 Implements those features of C4::Calendar needed for Staffs Rolling Loans
425 =head1 METHODS
427 =head2 new : Create a calendar object
429 my $calendar = Koha::Calendar->new( branchcode => 'MAIN' );
431 The option branchcode is required
434 =head2 addDate
436 my $dt = $calendar->addDate($date, $dur, $unit)
438 C<$date> is a DateTime object representing the starting date of the interval.
440 C<$offset> is a DateTime::Duration to add to it
442 C<$unit> is a string value 'days' or 'hours' toflag granularity of duration
444 Currently unit is only used to invoke Staffs return Monday at 10 am rule this
445 parameter will be removed when issuingrules properly cope with that
448 =head2 addHours
450 my $dt = $calendar->addHours($date, $dur, $return_by_hour )
452 C<$date> is a DateTime object representing the starting date of the interval.
454 C<$offset> is a DateTime::Duration to add to it
456 C<$return_by_hour> is an integer value representing the opening hour for the branch
458 =head2 get_push_amt
460 my $amt = $calendar->get_push_amt($date)
462 C<$date> is a DateTime object representing a closed return date
464 Using the days_mode syspref value and the nature of the closed return
465 date, return how many days we should jump forward to find another return date
467 =head2 addDays
469 my $dt = $calendar->addDays($date, $dur)
471 C<$date> is a DateTime object representing the starting date of the interval.
473 C<$offset> is a DateTime::Duration to add to it
475 C<$unit> is a string value 'days' or 'hours' toflag granularity of duration
477 Currently unit is only used to invoke Staffs return Monday at 10 am rule this
478 parameter will be removed when issuingrules properly cope with that
481 =head2 single_holidays
483 my $rc = $self->single_holidays( $ymd );
485 Passed a $date in Ymd (yyyymmdd) format - returns 1 if date is a single_holiday, or 0 if not.
488 =head2 is_holiday
490 $yesno = $calendar->is_holiday($dt);
492 passed a DateTime object returns 1 if it is a closed day
493 0 if not according to the calendar
495 =head2 days_between
497 $duration = $calendar->days_between($start_dt, $end_dt);
499 Passed two dates returns a DateTime::Duration object measuring the length between them
500 ignoring closed days. Always returns a positive number irrespective of the
501 relative order of the parameters.
503 Note: This routine assumes neither the passed start_dt nor end_dt can be a closed day
505 =head2 hours_between
507 $duration = $calendar->hours_between($start_dt, $end_dt);
509 Passed two dates returns a DateTime::Duration object measuring the length between them
510 ignoring closed days. Always returns a positive number irrespective of the
511 relative order of the parameters.
513 Note: This routine assumes neither the passed start_dt nor end_dt can be a closed day
515 =head2 next_open_days
517 $datetime = $calendar->next_open_days($duedate_dt, $to_add)
519 Passed a Datetime and number of days, returns another Datetime representing
520 the next open day after adding the passed number of days. It is intended for
521 use to calculate the due date when useDaysMode syspref is set to either
522 'Datedue', 'Calendar' or 'Dayweek'.
524 =head2 prev_open_days
526 $datetime = $calendar->prev_open_days($duedate_dt, $to_sub)
528 Passed a Datetime and a number of days, returns another Datetime
529 representing the previous open day after subtracting the number of passed
530 days. It is intended for use to calculate the due date when useDaysMode
531 syspref is set to either 'Datedue', 'Calendar' or 'Dayweek'.
533 =head2 set_daysmode
535 For testing only allows the calling script to change days mode
537 =head2 clear_weekly_closed_days
539 In test mode changes the testing set of closed days to a new set with
540 no closed days. TODO passing an array of closed days to this would
541 allow testing of more configurations
543 =head2 add_holiday
545 Passed a datetime object this will add it to the calendar's list of
546 closed days. This is for testing so that we can alter the Calenfar object's
547 list of specified dates
549 =head1 DIAGNOSTICS
551 Will croak if not passed a branchcode in new
553 =head1 BUGS AND LIMITATIONS
555 This only contains a limited subset of the functionality in C4::Calendar
556 Only enough to support Staffs Rolling loans
558 =head1 AUTHOR
560 Colin Campbell colin.campbell@ptfs-europe.com
562 =head1 LICENSE AND COPYRIGHT
564 Copyright (c) 2011 PTFS-Europe Ltd All rights reserved
566 This program is free software: you can redistribute it and/or modify
567 it under the terms of the GNU General Public License as published by
568 the Free Software Foundation, either version 2 of the License, or
569 (at your option) any later version.
571 This program is distributed in the hope that it will be useful,
572 but WITHOUT ANY WARRANTY; without even the implied warranty of
573 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
574 GNU General Public License for more details.
576 You should have received a copy of the GNU General Public License
577 along with this program. If not, see <http://www.gnu.org/licenses/>.