3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
20 use vars
qw($VERSION @EXPORT);
23 use Date::Calc qw( Date_to_Days Today);
28 use constant ISO_DATE_FORMAT
=> "%04d-%02d-%02d";
32 C4::Calendar::Calendar - Koha module dealing with holidays.
36 use C4::Calendar::Calendar;
40 This package is used to deal with holidays. Through this package, you can set
41 all kind of holidays for the library.
47 $calendar = C4::Calendar->new(branchcode => $branchcode);
49 Each library branch has its own Calendar.
50 C<$branchcode> specifies which Calendar you want.
55 my $classname = shift @_;
57 my $self = bless({}, $classname);
58 foreach my $optionName (keys %options) {
59 $self->{lc($optionName)} = $options{$optionName};
61 defined($self->{branchcode
}) or croak
"No branchcode argument to new. Should be C4::Calendar->new(branchcode => \$branchcode)";
62 $self->_init($self->{branchcode
});
69 defined($branch) or die "No branchcode sent to _init"; # must test for defined here and above to allow ""
70 my $dbh = C4
::Context
->dbh();
71 my $repeatable = $dbh->prepare( 'SELECT *
72 FROM repeatable_holidays
73 WHERE ( branchcode = ? )
74 AND (ISNULL(weekday) = ?)' );
75 $repeatable->execute($branch,0);
76 my %week_days_holidays;
77 while (my $row = $repeatable->fetchrow_hashref) {
78 my $key = $row->{weekday
};
79 $week_days_holidays{$key}{title
} = $row->{title
};
80 $week_days_holidays{$key}{description
} = $row->{description
};
82 $self->{'week_days_holidays'} = \
%week_days_holidays;
84 $repeatable->execute($branch,1);
85 my %day_month_holidays;
86 while (my $row = $repeatable->fetchrow_hashref) {
87 my $key = $row->{month
} . "/" . $row->{day
};
88 $day_month_holidays{$key}{title
} = $row->{title
};
89 $day_month_holidays{$key}{description
} = $row->{description
};
90 $day_month_holidays{$key}{day
} = sprintf("%02d", $row->{day
});
91 $day_month_holidays{$key}{month
} = sprintf("%02d", $row->{month
});
93 $self->{'day_month_holidays'} = \
%day_month_holidays;
95 my $special = $dbh->prepare( 'SELECT day, month, year, title, description
97 WHERE ( branchcode = ? )
98 AND (isexception = ?)' );
99 $special->execute($branch,1);
100 my %exception_holidays;
101 while (my ($day, $month, $year, $title, $description) = $special->fetchrow) {
102 $exception_holidays{"$year/$month/$day"}{title
} = $title;
103 $exception_holidays{"$year/$month/$day"}{description
} = $description;
104 $exception_holidays{"$year/$month/$day"}{date
} =
105 sprintf(ISO_DATE_FORMAT
, $year, $month, $day);
107 $self->{'exception_holidays'} = \
%exception_holidays;
109 $special->execute($branch,0);
111 while (my ($day, $month, $year, $title, $description) = $special->fetchrow) {
112 $single_holidays{"$year/$month/$day"}{title
} = $title;
113 $single_holidays{"$year/$month/$day"}{description
} = $description;
114 $single_holidays{"$year/$month/$day"}{date
} =
115 sprintf(ISO_DATE_FORMAT
, $year, $month, $day);
117 $self->{'single_holidays'} = \
%single_holidays;
121 =head2 get_week_days_holidays
123 $week_days_holidays = $calendar->get_week_days_holidays();
125 Returns a hash reference to week days holidays.
129 sub get_week_days_holidays
{
131 my $week_days_holidays = $self->{'week_days_holidays'};
132 return $week_days_holidays;
135 =head2 get_day_month_holidays
137 $day_month_holidays = $calendar->get_day_month_holidays();
139 Returns a hash reference to day month holidays.
143 sub get_day_month_holidays
{
145 my $day_month_holidays = $self->{'day_month_holidays'};
146 return $day_month_holidays;
149 =head2 get_exception_holidays
151 $exception_holidays = $calendar->exception_holidays();
153 Returns a hash reference to exception holidays. This kind of days are those
154 which stands for a holiday, but you wanted to make an exception for this particular
159 sub get_exception_holidays
{
161 my $exception_holidays = $self->{'exception_holidays'};
162 return $exception_holidays;
165 =head2 get_single_holidays
167 $single_holidays = $calendar->get_single_holidays();
169 Returns a hash reference to single holidays. This kind of holidays are those which
170 happened just one time.
174 sub get_single_holidays
{
176 my $single_holidays = $self->{'single_holidays'};
177 return $single_holidays;
180 =head2 insert_week_day_holiday
182 insert_week_day_holiday(weekday => $weekday,
184 description => $description);
186 Inserts a new week day for $self->{branchcode}.
188 C<$day> Is the week day to make holiday.
190 C<$title> Is the title to store for the holiday formed by $year/$month/$day.
192 C<$description> Is the description to store for the holiday formed by $year/$month/$day.
196 sub insert_week_day_holiday
{
200 my $weekday = $options{weekday
};
201 croak
"Invalid weekday $weekday" unless $weekday =~ m/^[0-6]$/;
203 my $dbh = C4
::Context
->dbh();
204 my $insertHoliday = $dbh->prepare("insert into repeatable_holidays (id,branchcode,weekday,day,month,title,description) values ( '',?,?,NULL,NULL,?,? )");
205 $insertHoliday->execute( $self->{branchcode
}, $weekday, $options{title
}, $options{description
});
206 $self->{'week_days_holidays'}->{$weekday}{title
} = $options{title
};
207 $self->{'week_days_holidays'}->{$weekday}{description
} = $options{description
};
211 =head2 insert_day_month_holiday
213 insert_day_month_holiday(day => $day,
216 description => $description);
218 Inserts a new day month holiday for $self->{branchcode}.
220 C<$day> Is the day month to make the date to insert.
222 C<$month> Is month to make the date to insert.
224 C<$title> Is the title to store for the holiday formed by $year/$month/$day.
226 C<$description> Is the description to store for the holiday formed by $year/$month/$day.
230 sub insert_day_month_holiday
{
234 my $dbh = C4
::Context
->dbh();
235 my $insertHoliday = $dbh->prepare("insert into repeatable_holidays (id,branchcode,weekday,day,month,title,description) values ('', ?, NULL, ?, ?, ?,? )");
236 $insertHoliday->execute( $self->{branchcode
}, $options{day
},$options{month
},$options{title
}, $options{description
});
237 $self->{'day_month_holidays'}->{"$options{month}/$options{day}"}{title
} = $options{title
};
238 $self->{'day_month_holidays'}->{"$options{month}/$options{day}"}{description
} = $options{description
};
242 =head2 insert_single_holiday
244 insert_single_holiday(day => $day,
248 description => $description);
250 Inserts a new single holiday for $self->{branchcode}.
252 C<$day> Is the day month to make the date to insert.
254 C<$month> Is month to make the date to insert.
256 C<$year> Is year to make the date to insert.
258 C<$title> Is the title to store for the holiday formed by $year/$month/$day.
260 C<$description> Is the description to store for the holiday formed by $year/$month/$day.
264 sub insert_single_holiday
{
267 @options{qw(year month day)} = ( $options{date
} =~ m/(\d+)-(\d+)-(\d+)/o )
268 if $options{date
} && !$options{day
};
270 my $dbh = C4
::Context
->dbh();
272 my $insertHoliday = $dbh->prepare("insert into special_holidays (id,branchcode,day,month,year,isexception,title,description) values ('', ?,?,?,?,?,?,?)");
273 $insertHoliday->execute( $self->{branchcode
}, $options{day
},$options{month
},$options{year
}, $isexception, $options{title
}, $options{description
});
274 $self->{'single_holidays'}->{"$options{year}/$options{month}/$options{day}"}{title
} = $options{title
};
275 $self->{'single_holidays'}->{"$options{year}/$options{month}/$options{day}"}{description
} = $options{description
};
278 # changed the 'single_holidays' table, lets force/reset its cache
279 my $cache = Koha
::Cache
->get_instance();
280 $cache->clear_from_cache( 'single_holidays') ;
281 $cache->clear_from_cache( 'exception_holidays') ;
287 =head2 insert_exception_holiday
289 insert_exception_holiday(day => $day,
293 description => $description);
295 Inserts a new exception holiday for $self->{branchcode}.
297 C<$day> Is the day month to make the date to insert.
299 C<$month> Is month to make the date to insert.
301 C<$year> Is year to make the date to insert.
303 C<$title> Is the title to store for the holiday formed by $year/$month/$day.
305 C<$description> Is the description to store for the holiday formed by $year/$month/$day.
309 sub insert_exception_holiday
{
313 @options{qw(year month day)} = ( $options{date
} =~ m/(\d+)-(\d+)-(\d+)/o )
314 if $options{date
} && !$options{day
};
316 my $dbh = C4
::Context
->dbh();
318 my $insertException = $dbh->prepare("insert into special_holidays (id,branchcode,day,month,year,isexception,title,description) values ('', ?,?,?,?,?,?,?)");
319 $insertException->execute( $self->{branchcode
}, $options{day
},$options{month
},$options{year
}, $isexception, $options{title
}, $options{description
});
320 $self->{'exception_holidays'}->{"$options{year}/$options{month}/$options{day}"}{title
} = $options{title
};
321 $self->{'exception_holidays'}->{"$options{year}/$options{month}/$options{day}"}{description
} = $options{description
};
323 # changed the 'single_holidays' table, lets force/reset its cache
324 my $cache = Koha
::Cache
->get_instance();
325 $cache->clear_from_cache( 'single_holidays') ;
326 $cache->clear_from_cache( 'exception_holidays') ;
331 =head2 ModWeekdayholiday
333 ModWeekdayholiday(weekday =>$weekday,
335 description => $description)
337 Modifies the title and description of a weekday for $self->{branchcode}.
339 C<$weekday> Is the title to update for the holiday.
341 C<$description> Is the description to update for the holiday.
345 sub ModWeekdayholiday
{
349 my $dbh = C4
::Context
->dbh();
350 my $updateHoliday = $dbh->prepare("UPDATE repeatable_holidays SET title = ?, description = ? WHERE branchcode = ? AND weekday = ?");
351 $updateHoliday->execute( $options{title
},$options{description
},$self->{branchcode
},$options{weekday
});
352 $self->{'week_days_holidays'}->{$options{weekday
}}{title
} = $options{title
};
353 $self->{'week_days_holidays'}->{$options{weekday
}}{description
} = $options{description
};
357 =head2 ModDaymonthholiday
359 ModDaymonthholiday(day => $day,
362 description => $description);
364 Modifies the title and description for a day/month holiday for $self->{branchcode}.
366 C<$day> The day of the month for the update.
368 C<$month> The month to be used for the update.
370 C<$title> The title to be updated for the holiday.
372 C<$description> The description to be update for the holiday.
376 sub ModDaymonthholiday
{
380 my $dbh = C4
::Context
->dbh();
381 my $updateHoliday = $dbh->prepare("UPDATE repeatable_holidays SET title = ?, description = ? WHERE month = ? AND day = ? AND branchcode = ?");
382 $updateHoliday->execute( $options{title
},$options{description
},$options{month
},$options{day
},$self->{branchcode
});
383 $self->{'day_month_holidays'}->{"$options{month}/$options{day}"}{title
} = $options{title
};
384 $self->{'day_month_holidays'}->{"$options{month}/$options{day}"}{description
} = $options{description
};
388 =head2 ModSingleholiday
390 ModSingleholiday(day => $day,
394 description => $description);
396 Modifies the title and description for a single holiday for $self->{branchcode}.
398 C<$day> Is the day of the month to make the update.
400 C<$month> Is the month to make the update.
402 C<$year> Is the year to make the update.
404 C<$title> Is the title to update for the holiday formed by $year/$month/$day.
406 C<$description> Is the description to update for the holiday formed by $year/$month/$day.
410 sub ModSingleholiday
{
414 my $dbh = C4
::Context
->dbh();
417 my $updateHoliday = $dbh->prepare("
418 UPDATE special_holidays SET title = ?, description = ?
419 WHERE day = ? AND month = ? AND year = ? AND branchcode = ? AND isexception = ?");
420 $updateHoliday->execute($options{title
},$options{description
},$options{day
},$options{month
},$options{year
},$self->{branchcode
},$isexception);
421 $self->{'single_holidays'}->{"$options{year}/$options{month}/$options{day}"}{title
} = $options{title
};
422 $self->{'single_holidays'}->{"$options{year}/$options{month}/$options{day}"}{description
} = $options{description
};
424 # changed the 'single_holidays' table, lets force/reset its cache
425 my $cache = Koha
::Cache
->get_instance();
426 $cache->clear_from_cache( 'single_holidays') ;
427 $cache->clear_from_cache( 'exception_holidays') ;
432 =head2 ModExceptionholiday
434 ModExceptionholiday(day => $day,
438 description => $description);
440 Modifies the title and description for an exception holiday for $self->{branchcode}.
442 C<$day> Is the day of the month for the holiday.
444 C<$month> Is the month for the holiday.
446 C<$year> Is the year for the holiday.
448 C<$title> Is the title to be modified for the holiday formed by $year/$month/$day.
450 C<$description> Is the description to be modified for the holiday formed by $year/$month/$day.
454 sub ModExceptionholiday
{
458 my $dbh = C4
::Context
->dbh();
460 my $updateHoliday = $dbh->prepare("
461 UPDATE special_holidays SET title = ?, description = ?
462 WHERE day = ? AND month = ? AND year = ? AND branchcode = ? AND isexception = ?");
463 $updateHoliday->execute($options{title
},$options{description
},$options{day
},$options{month
},$options{year
},$self->{branchcode
},$isexception);
464 $self->{'exception_holidays'}->{"$options{year}/$options{month}/$options{day}"}{title
} = $options{title
};
465 $self->{'exception_holidays'}->{"$options{year}/$options{month}/$options{day}"}{description
} = $options{description
};
467 # changed the 'single_holidays' table, lets force/reset its cache
468 my $cache = Koha
::Cache
->get_instance();
469 $cache->clear_from_cache( 'single_holidays') ;
470 $cache->clear_from_cache( 'exception_holidays') ;
475 =head2 delete_holiday
477 delete_holiday(weekday => $weekday
482 Delete a holiday for $self->{branchcode}.
484 C<$weekday> Is the week day to delete.
486 C<$day> Is the day month to make the date to delete.
488 C<$month> Is month to make the date to delete.
490 C<$year> Is year to make the date to delete.
498 # Verify what kind of holiday that day is. For example, if it is
499 # a repeatable holiday, this should check if there are some exception
500 # for that holiday rule. Otherwise, if it is a regular holiday, it´s
501 # ok just deleting it.
503 my $dbh = C4
::Context
->dbh();
504 my $isSingleHoliday = $dbh->prepare("SELECT id FROM special_holidays WHERE (branchcode = ?) AND (day = ?) AND (month = ?) AND (year = ?)");
505 $isSingleHoliday->execute($self->{branchcode
}, $options{day
}, $options{month
}, $options{year
});
506 if ($isSingleHoliday->rows) {
507 my $id = $isSingleHoliday->fetchrow;
508 $isSingleHoliday->finish; # Close the last query
510 my $deleteHoliday = $dbh->prepare("DELETE FROM special_holidays WHERE id = ?");
511 $deleteHoliday->execute($id);
512 delete($self->{'single_holidays'}->{"$options{year}/$options{month}/$options{day}"});
514 $isSingleHoliday->finish; # Close the last query
516 my $isWeekdayHoliday = $dbh->prepare("SELECT id FROM repeatable_holidays WHERE branchcode = ? AND weekday = ?");
517 $isWeekdayHoliday->execute($self->{branchcode
}, $options{weekday
});
518 if ($isWeekdayHoliday->rows) {
519 my $id = $isWeekdayHoliday->fetchrow;
520 $isWeekdayHoliday->finish; # Close the last query
522 my $updateExceptions = $dbh->prepare("UPDATE special_holidays SET isexception = 0 WHERE (WEEKDAY(CONCAT(special_holidays.year,'-',special_holidays.month,'-',special_holidays.day)) = ?) AND (branchcode = ?)");
523 $updateExceptions->execute($options{weekday
}, $self->{branchcode
});
524 $updateExceptions->finish; # Close the last query
526 my $deleteHoliday = $dbh->prepare("DELETE FROM repeatable_holidays WHERE id = ?");
527 $deleteHoliday->execute($id);
528 delete($self->{'week_days_holidays'}->{$options{weekday
}});
530 $isWeekdayHoliday->finish; # Close the last query
532 my $isDayMonthHoliday = $dbh->prepare("SELECT id FROM repeatable_holidays WHERE (branchcode = ?) AND (day = ?) AND (month = ?)");
533 $isDayMonthHoliday->execute($self->{branchcode
}, $options{day
}, $options{month
});
534 if ($isDayMonthHoliday->rows) {
535 my $id = $isDayMonthHoliday->fetchrow;
536 $isDayMonthHoliday->finish;
537 my $updateExceptions = $dbh->prepare("UPDATE special_holidays SET isexception = 0 WHERE (special_holidays.branchcode = ?) AND (special_holidays.day = ?) and (special_holidays.month = ?)");
538 $updateExceptions->execute($self->{branchcode
}, $options{day
}, $options{month
});
539 $updateExceptions->finish; # Close the last query
541 my $deleteHoliday = $dbh->prepare("DELETE FROM repeatable_holidays WHERE (id = ?)");
542 $deleteHoliday->execute($id);
543 delete($self->{'day_month_holidays'}->{"$options{month}/$options{day}"});
548 # changed the 'single_holidays' table, lets force/reset its cache
549 my $cache = Koha
::Cache
->get_instance();
550 $cache->clear_from_cache( 'single_holidays') ;
551 $cache->clear_from_cache( 'exception_holidays') ;
555 =head2 delete_holiday_range
557 delete_holiday_range(day => $day,
561 Delete a holiday range of dates for $self->{branchcode}.
563 C<$day> Is the day month to make the date to delete.
565 C<$month> Is month to make the date to delete.
567 C<$year> Is year to make the date to delete.
571 sub delete_holiday_range
{
575 my $dbh = C4
::Context
->dbh();
576 my $sth = $dbh->prepare("DELETE FROM special_holidays WHERE (branchcode = ?) AND (day = ?) AND (month = ?) AND (year = ?)");
577 $sth->execute($self->{branchcode
}, $options{day
}, $options{month
}, $options{year
});
579 # changed the 'single_holidays' table, lets force/reset its cache
580 my $cache = Koha
::Cache
->get_instance();
581 $cache->clear_from_cache( 'single_holidays') ;
582 $cache->clear_from_cache( 'exception_holidays') ;
586 =head2 delete_holiday_range_repeatable
588 delete_holiday_range_repeatable(day => $day,
591 Delete a holiday for $self->{branchcode}.
593 C<$day> Is the day month to make the date to delete.
595 C<$month> Is month to make the date to delete.
599 sub delete_holiday_range_repeatable
{
603 my $dbh = C4
::Context
->dbh();
604 my $sth = $dbh->prepare("DELETE FROM repeatable_holidays WHERE (branchcode = ?) AND (day = ?) AND (month = ?)");
605 $sth->execute($self->{branchcode
}, $options{day
}, $options{month
});
608 =head2 delete_exception_holiday_range
610 delete_exception_holiday_range(weekday => $weekday
615 Delete a holiday for $self->{branchcode}.
617 C<$day> Is the day month to make the date to delete.
619 C<$month> Is month to make the date to delete.
621 C<$year> Is year to make the date to delete.
625 sub delete_exception_holiday_range
{
629 my $dbh = C4
::Context
->dbh();
630 my $sth = $dbh->prepare("DELETE FROM special_holidays WHERE (branchcode = ?) AND (isexception = 1) AND (day = ?) AND (month = ?) AND (year = ?)");
631 $sth->execute($self->{branchcode
}, $options{day
}, $options{month
}, $options{year
});
633 # changed the 'single_holidays' table, lets force/reset its cache
634 my $cache = Koha
::Cache
->get_instance();
635 $cache->clear_from_cache( 'single_holidays') ;
636 $cache->clear_from_cache( 'exception_holidays') ;
641 $isHoliday = isHoliday($day, $month $year);
643 C<$day> Is the day to check whether if is a holiday or not.
645 C<$month> Is the month to check whether if is a holiday or not.
647 C<$year> Is the year to check whether if is a holiday or not.
652 my ($self, $day, $month, $year) = @_;
653 # FIXME - date strings are stored in non-padded metric format. should change to iso.
657 my $weekday = &Date
::Calc
::Day_of_Week
($year, $month, $day) % 7;
658 my $weekDays = $self->get_week_days_holidays();
659 my $dayMonths = $self->get_day_month_holidays();
660 my $exceptions = $self->get_exception_holidays();
661 my $singles = $self->get_single_holidays();
662 if (defined($exceptions->{"$year/$month/$day"})) {
665 if ((exists($weekDays->{$weekday})) ||
666 (exists($dayMonths->{"$month/$day"})) ||
667 (exists($singles->{"$year/$month/$day"}))) {
676 =head2 copy_to_branch
678 $calendar->copy_to_branch($target_branch)
683 my ($self, $target_branch) = @_;
685 croak
"No target_branch" unless $target_branch;
687 my $target_calendar = C4
::Calendar
->new(branchcode
=> $target_branch);
689 my ($y, $m, $d) = Today
();
690 my $today = sprintf ISO_DATE_FORMAT
, $y,$m,$d;
692 my $wdh = $self->get_week_days_holidays;
693 $target_calendar->insert_week_day_holiday( weekday
=> $_, %{ $wdh->{$_} } )
695 $target_calendar->insert_day_month_holiday(%$_)
696 foreach values %{ $self->get_day_month_holidays };
697 $target_calendar->insert_exception_holiday(%$_)
698 foreach grep { $_->{date
} gt $today } values %{ $self->get_exception_holidays };
699 $target_calendar->insert_single_holiday(%$_)
700 foreach grep { $_->{date
} gt $today } values %{ $self->get_single_holidays };
711 Koha Physics Library UNLP <matias_veleda@hotmail.com>