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 ( exists $options{TEST_MODE} ) {
25 if ( !defined $self->{branchcode} ) {
26 croak 'No branchcode argument passed to Koha::Calendar->new';
34 my $branch = $self->{branchcode};
35 my $dbh = C4::Context->dbh();
36 my $repeat_sth = $dbh->prepare(
37 'SELECT * from repeatable_holidays WHERE branchcode = ? AND ISNULL(weekday) = ?'
39 $repeat_sth->execute( $branch, 0 );
40 $self->{weekly_closed_days} = [ 0, 0, 0, 0, 0, 0, 0 ];
41 Readonly::Scalar my $sunday => 7;
42 while ( my $tuple = $repeat_sth->fetchrow_hashref ) {
43 $self->{weekly_closed_days}->[ $tuple->{weekday} ] = 1;
45 $repeat_sth->execute( $branch, 1 );
46 $self->{day_month_closed_days} = {};
47 while ( my $tuple = $repeat_sth->fetchrow_hashref ) {
48 $self->{day_month_closed_days}->{ $tuple->{month} }->{ $tuple->{day} } =
52 my $special = $dbh->prepare(
53 'SELECT day, month, year FROM special_holidays WHERE branchcode = ? AND isexception = ?'
55 $special->execute( $branch, 1 );
57 while ( my ( $day, $month, $year ) = $special->fetchrow ) {
63 time_zone => C4::Context->tz()
64 )->truncate( to => 'day' );
66 $self->{exception_holidays} =
67 DateTime::Set->from_datetimes( dates => $dates );
69 $special->execute( $branch, 0 );
71 while ( my ( $day, $month, $year ) = $special->fetchrow ) {
77 time_zone => C4::Context->tz()
78 )->truncate( to => 'day' );
80 $self->{single_holidays} = DateTime::Set->from_datetimes( dates => $dates );
81 $self->{days_mode} = C4::Context->preference('useDaysMode');
87 my ( $self, $startdate, $add_duration, $unit ) = @_;
89 # Default to days duration (legacy support I guess)
90 if ( ref $add_duration ne 'DateTime::Duration' ) {
91 $add_duration = DateTime::Duration->new( days => $add_duration );
94 $unit ||= 'days'; # default days ?
97 if ( $unit eq 'hours' ) {
98 # Fixed for legacy support. Should be set as a branch parameter
99 Readonly::Scalar my $return_by_hour => 10;
101 $dt = $self->addHours($startdate, $add_duration, $return_by_hour);
104 $dt = $self->addDays($startdate, $add_duration);
111 my ( $self, $startdate, $hours_duration, $return_by_hour ) = @_;
112 my $base_date = $startdate->clone();
114 $base_date->add_duration($hours_duration);
116 # If we are using the calendar behave for now as if Datedue
117 # was the chosen option (current intended behaviour)
119 if ( $self->{days_mode} ne 'Days' &&
120 $self->is_holiday($base_date) ) {
122 if ( $hours_duration->is_negative() ) {
123 $base_date = $self->prev_open_day($base_date);
125 $base_date = $self->next_open_day($base_date);
128 $base_date->set_hour($return_by_hour);
136 my ( $self, $startdate, $days_duration ) = @_;
137 my $base_date = $startdate->clone();
139 if ( $self->{days_mode} eq 'Calendar' ) {
140 # use the calendar to skip all days the library is closed
142 my $days = abs $days_duration->in_units('days');
144 if ( $days_duration->is_negative() ) {
146 $base_date = $self->prev_open_day($base_date);
151 $base_date = $self->next_open_day($base_date);
156 } else { # Days or Datedue
157 # use straight days, then use calendar to push
158 # the date to the next open day if Datedue
159 $base_date->add_duration($days_duration);
161 if ( $self->{days_mode} eq 'Datedue' ) {
162 # Datedue, then use the calendar to push
163 # the date to the next open day if holiday
164 if ( $self->is_holiday($base_date) ) {
165 if ( $days_duration->is_negative() ) {
166 $base_date = $self->prev_open_day($base_date);
168 $base_date = $self->next_open_day($base_date);
178 my ( $self, $dt ) = @_;
179 my $localdt = $dt->clone();
180 my $day = $localdt->day;
181 my $month = $localdt->month;
183 $localdt->truncate( to => 'day' );
185 if ( $self->{exception_holidays}->contains($localdt) ) {
186 # exceptions are not holidays
190 my $dow = $localdt->day_of_week;
192 # TODO: Shouldn't we shift the rest of the $dow also?
197 if ( $self->{weekly_closed_days}->[$dow] == 1 ) {
201 if ( exists $self->{day_month_closed_days}->{$month}->{$day} ) {
205 if ( $self->{single_holidays}->contains($localdt) ) {
209 # damn have to go to work after all
214 my ( $self, $dt ) = @_;
215 my $base_date = $dt->clone();
217 $base_date->add(days => 1);
219 while ($self->is_holiday($base_date)) {
220 $base_date->add(days => 1);
227 my ( $self, $dt ) = @_;
228 my $base_date = $dt->clone();
230 $base_date->add(days => -1);
232 while ($self->is_holiday($base_date)) {
233 $base_date->add(days => -1);
241 my $start_dt = shift;
245 # start and end should not be closed days
246 my $days = $start_dt->delta_days($end_dt)->delta_days;
247 for (my $dt = $start_dt->clone();
251 if ($self->is_holiday($dt)) {
255 return DateTime::Duration->new( days => $days );
260 my ($self, $start_date, $end_date) = @_;
261 my $start_dt = $start_date->clone();
262 my $end_dt = $end_date->clone();
263 my $duration = $end_dt->delta_ms($start_dt);
264 $start_dt->truncate( to => 'day' );
265 $end_dt->truncate( to => 'day' );
266 # NB this is a kludge in that it assumes all days are 24 hours
267 # However for hourly loans the logic should be expanded to
268 # take into account open/close times then it would be a duration
269 # of library open hours
270 my $skipped_days = 0;
271 for (my $dt = $start_dt->clone();
275 if ($self->is_holiday($dt)) {
280 $duration->subtract_duration(DateTime::Duration->new( hours => 24 * $skipped_days));
289 $self->{weekly_closed_days} = [ 1, 0, 0, 0, 0, 0, 0 ]; # Sunday only
290 $self->{day_month_closed_days} = { 6 => { 16 => 1, } };
292 $self->{exception_holidays} =
293 DateTime::Set->from_datetimes( dates => $dates );
294 my $special = DateTime->new(
298 time_zone => 'Europe/London',
300 push @{$dates}, $special;
301 $self->{single_holidays} = DateTime::Set->from_datetimes( dates => $dates );
303 # if not defined, days_mode defaults to 'Calendar'
304 if ( !defined($self->{days_mode}) ) {
305 $self->{days_mode} = 'Calendar';
313 my ( $self, $mode ) = @_;
315 # if not testing this is a no op
316 if ( $self->{test} ) {
317 $self->{days_mode} = $mode;
323 sub clear_weekly_closed_days {
325 $self->{weekly_closed_days} = [ 0, 0, 0, 0, 0, 0, 0 ]; # Sunday only
332 my @dt = $self->{single_holidays}->as_list;
334 $self->{single_holidays} =
335 DateTime::Set->from_datetimes( dates => \@dt );
345 Koha::Calendar - Object containing a branches calendar
349 This documentation refers to Koha::Calendar version 0.0.1
355 my $c = Koha::Calendar->new( branchcode => 'MAIN' );
356 my $dt = DateTime->now();
359 $open = $c->is_holiday($dt);
360 # when will item be due if loan period = $dur (a DateTime::Duration object)
361 $duedate = $c->addDate($dt,$dur,'days');
366 Implements those features of C4::Calendar needed for Staffs Rolling Loans
370 =head2 new : Create a calendar object
372 my $calendar = Koha::Calendar->new( branchcode => 'MAIN' );
374 The option branchcode is required
379 my $dt = $calendar->addDate($date, $dur, $unit)
381 C<$date> is a DateTime object representing the starting date of the interval.
383 C<$offset> is a DateTime::Duration to add to it
385 C<$unit> is a string value 'days' or 'hours' toflag granularity of duration
387 Currently unit is only used to invoke Staffs return Monday at 10 am rule this
388 parameter will be removed when issuingrules properly cope with that
393 my $dt = $calendar->addHours($date, $dur, $return_by_hour )
395 C<$date> is a DateTime object representing the starting date of the interval.
397 C<$offset> is a DateTime::Duration to add to it
399 C<$return_by_hour> is an integer value representing the opening hour for the branch
404 my $dt = $calendar->addDays($date, $dur)
406 C<$date> is a DateTime object representing the starting date of the interval.
408 C<$offset> is a DateTime::Duration to add to it
410 C<$unit> is a string value 'days' or 'hours' toflag granularity of duration
412 Currently unit is only used to invoke Staffs return Monday at 10 am rule this
413 parameter will be removed when issuingrules properly cope with that
418 $yesno = $calendar->is_holiday($dt);
420 passed a DateTime object returns 1 if it is a closed day
421 0 if not according to the calendar
425 $duration = $calendar->days_between($start_dt, $end_dt);
427 Passed two dates returns a DateTime::Duration object measuring the length between them
428 ignoring closed days. Always returns a positive number irrespective of the
429 relative order of the parameters
433 $datetime = $calendar->next_open_day($duedate_dt)
435 Passed a Datetime returns another Datetime representing the next open day. It is
436 intended for use to calculate the due date when useDaysMode syspref is set to either
437 'Datedue' or 'Calendar'.
441 $datetime = $calendar->prev_open_day($duedate_dt)
443 Passed a Datetime returns another Datetime representing the previous open day. It is
444 intended for use to calculate the due date when useDaysMode syspref is set to either
445 'Datedue' or 'Calendar'.
449 For testing only allows the calling script to change days mode
451 =head2 clear_weekly_closed_days
453 In test mode changes the testing set of closed days to a new set with
454 no closed days. TODO passing an array of closed days to this would
455 allow testing of more configurations
459 Passed a datetime object this will add it to the calendar's list of
460 closed days. This is for testing so that we can alter the Calenfar object's
461 list of specified dates
465 Will croak if not passed a branchcode in new
467 =head1 BUGS AND LIMITATIONS
469 This only contains a limited subset of the functionality in C4::Calendar
470 Only enough to support Staffs Rolling loans
474 Colin Campbell colin.campbell@ptfs-europe.com
476 =head1 LICENSE AND COPYRIGHT
478 Copyright (c) 2011 PTFS-Europe Ltd All rights reserved
480 This program is free software: you can redistribute it and/or modify
481 it under the terms of the GNU General Public License as published by
482 the Free Software Foundation, either version 2 of the License, or
483 (at your option) any later version.
485 This program is distributed in the hope that it will be useful,
486 but WITHOUT ANY WARRANTY; without even the implied warranty of
487 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
488 GNU General Public License for more details.
490 You should have received a copy of the GNU General Public License
491 along with this program. If not, see <http://www.gnu.org/licenses/>.