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 {
57 my $dbh = C4::Context->dbh;
58 my $branch = $self->{branchcode};
59 my $cache = Koha::Cache->get_instance();
60 my $cached = $cache->get_from_cache('exception_holidays');
61 return $cached if $cached;
63 my $exception_holidays_sth = $dbh->prepare(
64 'SELECT day, month, year FROM special_holidays WHERE branchcode = ? AND isexception = 1'
66 $exception_holidays_sth->execute( $branch );
68 while ( my ( $day, $month, $year ) = $exception_holidays_sth->fetchrow ) {
74 time_zone => C4::Context->tz()
75 )->truncate( to => 'day' );
77 $self->{exception_holidays} =
78 DateTime::Set->from_datetimes( dates => $dates );
79 $cache->set_in_cache( 'exception_holidays', $self->{exception_holidays} );
80 return $self->{exception_holidays};
84 my ( $self, $date ) = @_;
85 my $branchcode = $self->{branchcode};
86 my $cache = Koha::Cache->get_instance();
87 my $single_holidays = $cache->get_from_cache('single_holidays');
89 # $single_holidays looks like:
98 unless ($single_holidays) {
99 my $dbh = C4::Context->dbh;
100 $single_holidays = {};
102 # push holidays for each branch
104 $dbh->prepare('SELECT distinct(branchcode) FROM special_holidays');
105 $branches_sth->execute();
106 while ( my $br = $branches_sth->fetchrow ) {
107 my $single_holidays_sth = $dbh->prepare(
108 'SELECT day, month, year FROM special_holidays WHERE branchcode = ? AND isexception = 0'
110 $single_holidays_sth->execute($br);
113 while ( my ( $day, $month, $year ) =
114 $single_holidays_sth->fetchrow )
116 my $dt = DateTime->new(
120 time_zone => C4::Context->tz()
121 )->truncate( to => 'day' );
122 push @ymd_arr, $dt->ymd('');
124 $single_holidays->{$br} = \@ymd_arr;
126 $cache->set_in_cache( 'single_holidays', $single_holidays,
129 my $holidays = ( $single_holidays->{$branchcode} );
130 for my $hols (@$holidays ) {
131 return 1 if ( $date == $hols ) #match ymds;
137 my ( $self, $startdate, $add_duration, $unit ) = @_;
139 # Default to days duration (legacy support I guess)
140 if ( ref $add_duration ne 'DateTime::Duration' ) {
141 $add_duration = DateTime::Duration->new( days => $add_duration );
144 $unit ||= 'days'; # default days ?
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);
154 $dt = $self->addDays($startdate, $add_duration);
161 my ( $self, $startdate, $hours_duration, $return_by_hour ) = @_;
162 my $base_date = $startdate->clone();
164 $base_date->add_duration($hours_duration);
166 # If we are using the calendar behave for now as if Datedue
167 # was the chosen option (current intended behaviour)
169 if ( $self->{days_mode} ne 'Days' &&
170 $self->is_holiday($base_date) ) {
172 if ( $hours_duration->is_negative() ) {
173 $base_date = $self->prev_open_day($base_date);
175 $base_date = $self->next_open_day($base_date);
178 $base_date->set_hour($return_by_hour);
186 my ( $self, $startdate, $days_duration ) = @_;
187 my $base_date = $startdate->clone();
189 $self->{days_mode} ||= q{};
191 if ( $self->{days_mode} eq 'Calendar' ) {
192 # use the calendar to skip all days the library is closed
194 my $days = abs $days_duration->in_units('days');
196 if ( $days_duration->is_negative() ) {
198 $base_date = $self->prev_open_day($base_date);
203 $base_date = $self->next_open_day($base_date);
208 } else { # Days or Datedue
209 # use straight days, then use calendar to push
210 # the date to the next open day if Datedue
211 $base_date->add_duration($days_duration);
213 if ( $self->{days_mode} eq 'Datedue' ) {
214 # Datedue, then use the calendar to push
215 # the date to the next open day if holiday
216 if ( $self->is_holiday($base_date) ) {
218 if ( $days_duration->is_negative() ) {
219 $base_date = $self->prev_open_day($base_date);
221 $base_date = $self->next_open_day($base_date);
231 my ( $self, $dt ) = @_;
233 my $localdt = $dt->clone();
234 my $day = $localdt->day;
235 my $month = $localdt->month;
237 $localdt->truncate( to => 'day' );
240 if ( $self->exception_holidays->contains($localdt) ) {
241 # exceptions are not holidays
245 my $dow = $localdt->day_of_week;
247 # DateTime object dow (1-7) where Monday is 1
248 # Arrays are 0-based where 0 = Sunday, not 7.
253 if ( $self->{weekly_closed_days}->[$dow] == 1 ) {
257 if ( exists $self->{day_month_closed_days}->{$month}->{$day} ) {
261 my $ymd = $localdt->ymd('') ;
262 if ($self->single_holidays( $ymd ) == 1 ) {
266 # damn have to go to work after all
271 my ( $self, $dt ) = @_;
272 my $base_date = $dt->clone();
274 $base_date->add(days => 1);
276 while ($self->is_holiday($base_date)) {
277 $base_date->add(days => 1);
284 my ( $self, $dt ) = @_;
285 my $base_date = $dt->clone();
287 $base_date->add(days => -1);
289 while ($self->is_holiday($base_date)) {
290 $base_date->add(days => -1);
298 my $start_dt = shift;
301 if ( $start_dt->compare($end_dt) > 0 ) {
303 my $int_dt = $end_dt;
309 # start and end should not be closed days
310 my $days = $start_dt->delta_days($end_dt)->delta_days;
311 for (my $dt = $start_dt->clone();
315 if ($self->is_holiday($dt)) {
319 return DateTime::Duration->new( days => $days );
324 my ($self, $start_date, $end_date) = @_;
325 my $start_dt = $start_date->clone();
326 my $end_dt = $end_date->clone();
327 my $duration = $end_dt->delta_ms($start_dt);
328 $start_dt->truncate( to => 'day' );
329 $end_dt->truncate( to => 'day' );
330 # NB this is a kludge in that it assumes all days are 24 hours
331 # However for hourly loans the logic should be expanded to
332 # take into account open/close times then it would be a duration
333 # of library open hours
334 my $skipped_days = 0;
335 for (my $dt = $start_dt->clone();
339 if ($self->is_holiday($dt)) {
344 $duration->subtract_duration(DateTime::Duration->new( hours => 24 * $skipped_days));
352 my ( $self, $mode ) = @_;
354 # if not testing this is a no op
355 if ( $self->{test} ) {
356 $self->{days_mode} = $mode;
362 sub clear_weekly_closed_days {
364 $self->{weekly_closed_days} = [ 0, 0, 0, 0, 0, 0, 0 ]; # Sunday only
373 Koha::Calendar - Object containing a branches calendar
379 my $c = Koha::Calendar->new( branchcode => 'MAIN' );
380 my $dt = DateTime->now();
383 $open = $c->is_holiday($dt);
384 # when will item be due if loan period = $dur (a DateTime::Duration object)
385 $duedate = $c->addDate($dt,$dur,'days');
390 Implements those features of C4::Calendar needed for Staffs Rolling Loans
394 =head2 new : Create a calendar object
396 my $calendar = Koha::Calendar->new( branchcode => 'MAIN' );
398 The option branchcode is required
403 my $dt = $calendar->addDate($date, $dur, $unit)
405 C<$date> is a DateTime object representing the starting date of the interval.
407 C<$offset> is a DateTime::Duration to add to it
409 C<$unit> is a string value 'days' or 'hours' toflag granularity of duration
411 Currently unit is only used to invoke Staffs return Monday at 10 am rule this
412 parameter will be removed when issuingrules properly cope with that
417 my $dt = $calendar->addHours($date, $dur, $return_by_hour )
419 C<$date> is a DateTime object representing the starting date of the interval.
421 C<$offset> is a DateTime::Duration to add to it
423 C<$return_by_hour> is an integer value representing the opening hour for the branch
428 my $dt = $calendar->addDays($date, $dur)
430 C<$date> is a DateTime object representing the starting date of the interval.
432 C<$offset> is a DateTime::Duration to add to it
434 C<$unit> is a string value 'days' or 'hours' toflag granularity of duration
436 Currently unit is only used to invoke Staffs return Monday at 10 am rule this
437 parameter will be removed when issuingrules properly cope with that
440 =head2 single_holidays
442 my $rc = $self->single_holidays( $ymd );
444 Passed a $date in Ymd (yyyymmdd) format - returns 1 if date is a single_holiday, or 0 if not.
449 $yesno = $calendar->is_holiday($dt);
451 passed a DateTime object returns 1 if it is a closed day
452 0 if not according to the calendar
456 $duration = $calendar->days_between($start_dt, $end_dt);
458 Passed two dates returns a DateTime::Duration object measuring the length between them
459 ignoring closed days. Always returns a positive number irrespective of the
460 relative order of the parameters
464 $datetime = $calendar->next_open_day($duedate_dt)
466 Passed a Datetime returns another Datetime representing the next open day. It is
467 intended for use to calculate the due date when useDaysMode syspref is set to either
468 'Datedue' or 'Calendar'.
472 $datetime = $calendar->prev_open_day($duedate_dt)
474 Passed a Datetime returns another Datetime representing the previous open day. It is
475 intended for use to calculate the due date when useDaysMode syspref is set to either
476 'Datedue' or 'Calendar'.
480 For testing only allows the calling script to change days mode
482 =head2 clear_weekly_closed_days
484 In test mode changes the testing set of closed days to a new set with
485 no closed days. TODO passing an array of closed days to this would
486 allow testing of more configurations
490 Passed a datetime object this will add it to the calendar's list of
491 closed days. This is for testing so that we can alter the Calenfar object's
492 list of specified dates
496 Will croak if not passed a branchcode in new
498 =head1 BUGS AND LIMITATIONS
500 This only contains a limited subset of the functionality in C4::Calendar
501 Only enough to support Staffs Rolling loans
505 Colin Campbell colin.campbell@ptfs-europe.com
507 =head1 LICENSE AND COPYRIGHT
509 Copyright (c) 2011 PTFS-Europe Ltd All rights reserved
511 This program is free software: you can redistribute it and/or modify
512 it under the terms of the GNU General Public License as published by
513 the Free Software Foundation, either version 2 of the License, or
514 (at your option) any later version.
516 This program is distributed in the hope that it will be useful,
517 but WITHOUT ANY WARRANTY; without even the implied warranty of
518 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
519 GNU General Public License for more details.
521 You should have received a copy of the GNU General Public License
522 along with this program. If not, see <http://www.gnu.org/licenses/>.