3 # This script loops through each overdue item, determines the fine,
4 # and updates the total amount of fines due by each user. It relies on
5 # the existence of /tmp/fines, which is created by ???
6 # Doesn't really rely on it, it relys on being able to write to /tmp/
7 # It creates the fines file
9 # This script is meant to be run nightly out of cron.
11 # Copyright 2000-2002 Katipo Communications
12 # Copyright 2011 PTFS-Europe Ltd
14 # This file is part of Koha.
16 # Koha is free software; you can redistribute it and/or modify it
17 # under the terms of the GNU General Public License as published by
18 # the Free Software Foundation; either version 3 of the License, or
19 # (at your option) any later version.
21 # Koha is distributed in the hope that it will be useful, but
22 # WITHOUT ANY WARRANTY; without even the implied warranty of
23 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 # GNU General Public License for more details.
26 # You should have received a copy of the GNU General Public License
27 # along with Koha; if not, see <http://www.gnu.org/licenses>.
33 use Koha::Script -cron;
53 'v|verbose' => \$verbose,
55 'o|out:s' => \$output_dir,
56 'm|maxdays:i' => \$maxdays,
58 my $usage = << 'ENDUSAGE';
60 This script calculates and charges overdue fines
61 to patron accounts. The Koha system preference 'finesMode' controls
62 whether the fines are calculated and charged to the patron accounts ("Calculate and charge");
63 or not calculated ("Don't calculate").
65 This script has the following parameters :
66 -h --help: this message
67 -l --log: log the output to a file (optional if the -o parameter is given)
68 -o --out: ouput directory for logs (defaults to env or /tmp if !exist)
70 -m --maxdays: how many days back of overdues to process
82 qw(cardnumber categorycode surname firstname email phone address citystate);
83 my @item_fields = qw(itemnumber barcode date_due);
84 my @other_fields = qw(days_overdue fine);
85 my $libname = C4::Context->preference('LibraryName');
86 my $control = C4::Context->preference('CircControl');
87 my $mode = C4::Context->preference('finesMode');
88 my $delim = "\t"; # ? C4::Context->preference('delimiter') || "\t";
91 my $today = DateTime->now( time_zone => C4::Context->tz() );
93 if ($log or $output_dir) {
94 $filename = get_filename($output_dir);
99 open $fh, '>>', $filename or croak "Cannot write file $filename: $!";
100 print {$fh} join $delim, ( @borrower_fields, @item_fields, @other_fields );
105 $params->{maximumdays} = $maxdays if $maxdays;
106 my $overdues = Getoverdues($params);
107 for my $overdue ( @{$overdues} ) {
108 next if $overdue->{itemlost};
110 if ( !defined $overdue->{borrowernumber} ) {
112 "ERROR in Getoverdues : issues.borrowernumber IS NULL. Repair 'issues' table now! Skipping record.\n";
115 my $patron = Koha::Patrons->find( $overdue->{borrowernumber} );
117 ( $control eq 'ItemHomeLibrary' ) ? $overdue->{homebranch}
118 : ( $control eq 'PatronLibrary' ) ? $patron->branchcode
119 : $overdue->{branchcode};
121 # In final case, CircControl must be PickupLibrary. (branchcode comes from issues table here).
122 if ( !exists $is_holiday{$branchcode} ) {
123 $is_holiday{$branchcode} = set_holiday( $branchcode, $today );
126 my $datedue = dt_from_string( $overdue->{date_due} );
127 if ( DateTime->compare( $datedue, $today ) == 1 ) {
132 my ( $amount, $unitcounttotal, $unitcount ) =
133 CalcFine( $overdue, $patron->categorycode,
134 $branchcode, $datedue, $today );
136 # Don't update the fine if today is a holiday.
137 # This ensures that dropbox mode will remove the correct amount of fine.
138 if ( $mode eq 'production' && !$is_holiday{$branchcode} ) {
139 if ( $amount && $amount > 0 ) {
142 issue_id => $overdue->{issue_id},
143 itemnumber => $overdue->{itemnumber},
144 borrowernumber => $overdue->{borrowernumber},
146 due => output_pref($datedue),
151 my $borrower = $patron->unblessed;
155 map { defined $borrower->{$_} ? $borrower->{$_} : q{} }
157 push @cells, map { $overdue->{$_} } @item_fields;
158 push @cells, $unitcounttotal, $amount;
159 say {$fh} join $delim, @cells;
167 my $overdue_items = @{$overdues};
169 Fines assessment -- $today
172 say "Saved to $filename";
175 Number of Overdue Items:
176 counted $overdue_items
183 my ( $branch, $dt ) = @_;
185 my $calendar = Koha::Calendar->new( branchcode => $branch );
186 return $calendar->is_holiday($dt);
190 my $directory = shift;
192 $directory = C4::Context::temporary_directory;
194 if ( !-d $directory ) {
195 carp "Could not write to $directory ... does not exist!";
197 my $name = C4::Context->config('database');
199 $name .= join q{}, q{_}, $today->ymd(), '.log';
200 $name = File::Spec->catfile( $directory, $name );
201 if ($verbose && $log) {
202 say "writing to $name";