1 package Koha
::Calendar
;
8 use DateTime
::Duration
;
14 my ( $classname, %options ) = @_;
16 bless $self, $classname;
17 for my $o_name ( keys %options ) {
19 $self->{$o} = $options{$o_name};
21 if ( !defined $self->{branchcode
} ) {
22 croak
'No branchcode argument passed to Koha::Calendar->new';
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');
55 sub exception_holidays
{
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 );
69 while ( my ( $day, $month, $year ) = $exception_holidays_sth->fetchrow ) {
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
};
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:
99 unless ($single_holidays) {
100 my $dbh = C4
::Context
->dbh;
101 $single_holidays = {};
103 # push holidays for each branch
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);
114 while ( my ( $day, $month, $year ) =
115 $single_holidays_sth->fetchrow )
117 my $dt = DateTime
->new(
121 time_zone
=> 'floating',
122 )->truncate( to
=> 'day' );
123 push @ymd_arr, $dt->ymd('');
125 $single_holidays->{$br} = \
@ymd_arr;
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;
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 ?
148 if ( $unit eq 'hours' ) {
149 # Fixed for legacy support. Should be set as a branch parameter
150 my $return_by_hour = 10;
152 $dt = $self->addHours($startdate, $add_duration, $return_by_hour);
155 $dt = $self->addDays($startdate, $add_duration);
162 my ( $self, $startdate, $hours_duration, $return_by_hour ) = @_;
163 my $base_date = $startdate->clone();
165 $base_date->add_duration($hours_duration);
167 # If we are using the calendar behave for now as if Datedue
168 # was the chosen option (current intended behaviour)
170 if ( $self->{days_mode
} ne 'Days' &&
171 $self->is_holiday($base_date) ) {
173 if ( $hours_duration->is_negative() ) {
174 $base_date = $self->prev_open_day($base_date);
176 $base_date = $self->next_open_day($base_date);
179 $base_date->set_hour($return_by_hour);
187 my ( $self, $startdate, $days_duration ) = @_;
188 my $base_date = $startdate->clone();
190 $self->{days_mode
} ||= q{};
192 if ( $self->{days_mode
} eq 'Calendar' ) {
193 # use the calendar to skip all days the library is closed
195 my $days = abs $days_duration->in_units('days');
197 if ( $days_duration->is_negative() ) {
199 $base_date = $self->prev_open_day($base_date);
204 $base_date = $self->next_open_day($base_date);
209 } else { # Days or Datedue
210 # use straight days, then use calendar to push
211 # the date to the next open day if Datedue
212 $base_date->add_duration($days_duration);
214 if ( $self->{days_mode
} eq 'Datedue' ) {
215 # Datedue, then use the calendar to push
216 # the date to the next open day if holiday
217 if ( $self->is_holiday($base_date) ) {
219 if ( $days_duration->is_negative() ) {
220 $base_date = $self->prev_open_day($base_date);
222 $base_date = $self->next_open_day($base_date);
232 my ( $self, $dt ) = @_;
234 my $localdt = $dt->clone();
235 my $day = $localdt->day;
236 my $month = $localdt->month;
238 #Change timezone to "floating" before doing any calculations or comparisons
239 $localdt->set_time_zone("floating");
240 $localdt->truncate( to
=> 'day' );
243 if ( $self->exception_holidays->contains($localdt) ) {
244 # exceptions are not holidays
248 my $dow = $localdt->day_of_week;
250 # DateTime object dow (1-7) where Monday is 1
251 # Arrays are 0-based where 0 = Sunday, not 7.
256 if ( $self->{weekly_closed_days
}->[$dow] == 1 ) {
260 if ( exists $self->{day_month_closed_days
}->{$month}->{$day} ) {
264 my $ymd = $localdt->ymd('') ;
265 if ($self->single_holidays( $ymd ) == 1 ) {
269 # damn have to go to work after all
274 my ( $self, $dt ) = @_;
275 my $base_date = $dt->clone();
277 $base_date->add(days
=> 1);
279 while ($self->is_holiday($base_date)) {
280 $base_date->add(days
=> 1);
287 my ( $self, $dt ) = @_;
288 my $base_date = $dt->clone();
290 $base_date->add(days
=> -1);
292 while ($self->is_holiday($base_date)) {
293 $base_date->add(days
=> -1);
301 my $start_dt = shift;
302 my $num_days = shift;
304 return $start_dt unless $num_days > 0;
306 my $base_dt = $start_dt->clone();
308 while ($num_days--) {
309 $base_dt = $self->next_open_day($base_dt);
317 my $start_dt = shift;
320 if ( $start_dt->compare($end_dt) > 0 ) {
322 my $int_dt = $end_dt;
328 # start and end should not be closed days
329 my $days = $start_dt->delta_days($end_dt)->delta_days;
330 for (my $dt = $start_dt->clone();
334 if ($self->is_holiday($dt)) {
338 return DateTime
::Duration
->new( days
=> $days );
343 my ($self, $start_date, $end_date) = @_;
344 my $start_dt = $start_date->clone();
345 my $end_dt = $end_date->clone();
346 my $duration = $end_dt->delta_ms($start_dt);
347 $start_dt->truncate( to
=> 'day' );
348 $end_dt->truncate( to
=> 'day' );
349 # NB this is a kludge in that it assumes all days are 24 hours
350 # However for hourly loans the logic should be expanded to
351 # take into account open/close times then it would be a duration
352 # of library open hours
353 my $skipped_days = 0;
354 for (my $dt = $start_dt->clone();
358 if ($self->is_holiday($dt)) {
363 $duration->subtract_duration(DateTime
::Duration
->new( hours
=> 24 * $skipped_days));
371 my ( $self, $mode ) = @_;
373 # if not testing this is a no op
374 if ( $self->{test
} ) {
375 $self->{days_mode
} = $mode;
381 sub clear_weekly_closed_days
{
383 $self->{weekly_closed_days
} = [ 0, 0, 0, 0, 0, 0, 0 ]; # Sunday only
392 Koha::Calendar - Object containing a branches calendar
398 my $c = Koha::Calendar->new( branchcode => 'MAIN' );
399 my $dt = DateTime->now();
402 $open = $c->is_holiday($dt);
403 # when will item be due if loan period = $dur (a DateTime::Duration object)
404 $duedate = $c->addDate($dt,$dur,'days');
409 Implements those features of C4::Calendar needed for Staffs Rolling Loans
413 =head2 new : Create a calendar object
415 my $calendar = Koha::Calendar->new( branchcode => 'MAIN' );
417 The option branchcode is required
422 my $dt = $calendar->addDate($date, $dur, $unit)
424 C<$date> is a DateTime object representing the starting date of the interval.
426 C<$offset> is a DateTime::Duration to add to it
428 C<$unit> is a string value 'days' or 'hours' toflag granularity of duration
430 Currently unit is only used to invoke Staffs return Monday at 10 am rule this
431 parameter will be removed when issuingrules properly cope with that
436 my $dt = $calendar->addHours($date, $dur, $return_by_hour )
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<$return_by_hour> is an integer value representing the opening hour for the branch
447 my $dt = $calendar->addDays($date, $dur)
449 C<$date> is a DateTime object representing the starting date of the interval.
451 C<$offset> is a DateTime::Duration to add to it
453 C<$unit> is a string value 'days' or 'hours' toflag granularity of duration
455 Currently unit is only used to invoke Staffs return Monday at 10 am rule this
456 parameter will be removed when issuingrules properly cope with that
459 =head2 single_holidays
461 my $rc = $self->single_holidays( $ymd );
463 Passed a $date in Ymd (yyyymmdd) format - returns 1 if date is a single_holiday, or 0 if not.
468 $yesno = $calendar->is_holiday($dt);
470 passed a DateTime object returns 1 if it is a closed day
471 0 if not according to the calendar
475 $duration = $calendar->days_between($start_dt, $end_dt);
477 Passed two dates returns a DateTime::Duration object measuring the length between them
478 ignoring closed days. Always returns a positive number irrespective of the
479 relative order of the parameters
483 $datetime = $calendar->next_open_day($duedate_dt)
485 Passed a Datetime returns another Datetime representing the next open day. It is
486 intended for use to calculate the due date when useDaysMode syspref is set to either
487 'Datedue' or 'Calendar'.
491 $datetime = $calendar->prev_open_day($duedate_dt)
493 Passed a Datetime returns another Datetime representing the previous open day. It is
494 intended for use to calculate the due date when useDaysMode syspref is set to either
495 'Datedue' or 'Calendar'.
499 For testing only allows the calling script to change days mode
501 =head2 clear_weekly_closed_days
503 In test mode changes the testing set of closed days to a new set with
504 no closed days. TODO passing an array of closed days to this would
505 allow testing of more configurations
509 Passed a datetime object this will add it to the calendar's list of
510 closed days. This is for testing so that we can alter the Calenfar object's
511 list of specified dates
515 Will croak if not passed a branchcode in new
517 =head1 BUGS AND LIMITATIONS
519 This only contains a limited subset of the functionality in C4::Calendar
520 Only enough to support Staffs Rolling loans
524 Colin Campbell colin.campbell@ptfs-europe.com
526 =head1 LICENSE AND COPYRIGHT
528 Copyright (c) 2011 PTFS-Europe Ltd All rights reserved
530 This program is free software: you can redistribute it and/or modify
531 it under the terms of the GNU General Public License as published by
532 the Free Software Foundation, either version 2 of the License, or
533 (at your option) any later version.
535 This program is distributed in the hope that it will be useful,
536 but WITHOUT ANY WARRANTY; without even the implied warranty of
537 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
538 GNU General Public License for more details.
540 You should have received a copy of the GNU General Public License
541 along with this program. If not, see <http://www.gnu.org/licenses/>.