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 # Doesnt 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
13 # This file is part of Koha.
15 # Koha is free software; you can redistribute it and/or modify it under the
16 # terms of the GNU General Public License as published by the Free Software
17 # Foundation; either version 2 of the License, or (at your option) any later
20 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
21 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
22 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
24 # You should have received a copy of the GNU General Public License along with
25 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
26 # Suite 330, Boston, MA 02111-1307 USA
29 # FIXME: use FinesMode as described or change syspref description
33 # find Koha's Perl modules
34 # test carefully before changing this
36 eval { require "$FindBin::Bin/kohalib.pl" };
39 use Date::Calc qw/Date_to_Days/;
44 use C4::Calendar qw(); # don't need any exports from Calendar
46 use C4::Debug; # supplying $debug and $cgi_debug
53 GetOptions( 'h|help' => \$help,
54 'v|verbose' => \$verbose,
55 'o|out:s' => \$output_dir,
57 my $usage = << 'ENDUSAGE';
59 This script calculates and charges overdue fines
60 to patron accounts. If the Koha System Preference
61 'finesMode' is set to 'production', the fines are charged
62 to the patron accounts. If set to 'test', the fines are
63 calculated but not applied.
65 This script has the following parameters :
66 -h --help: this message
67 -o --out: ouput directory for logs (defaults to env or /tmp if !exist)
74 use vars qw(@borrower_fields @item_fields @other_fields);
75 use vars qw($fldir $libname $control $mode $delim $dbname $today $today_iso $today_days);
76 use vars qw($filename);
79 @borrower_fields = qw(cardnumber categorycode surname firstname email phone address citystate);
80 @item_fields = qw(itemnumber barcode date_due);
81 @other_fields = qw(type days_overdue fine);
82 $libname = C4::Context->preference('LibraryName');
83 $control = C4::Context->preference('CircControl');
84 $mode = C4::Context->preference('finesMode');
85 $dbname = C4::Context->config('database');
86 $delim = "\t"; # ? C4::Context->preference('delimiter') || "\t";
91 $debug and print "Each line will contain the following fields:\n",
92 "From borrowers : ", join(', ', @borrower_fields), "\n",
93 "From items : ", join(', ', @item_fields), "\n",
94 "Per overdue: ", join(', ', @other_fields), "\n",
95 "Delimiter: '$delim'\n";
98 my $data = Getoverdues();
99 my $overdueItemsCounted = 0;
101 $today = C4::Dates->new();
102 $today_iso = $today->output('iso');
103 $today_days = Date_to_Days(split(/-/,$today_iso));
105 $fldir = $output_dir if( -d $output_dir );
107 $fldir = $ENV{TMPDIR} || "/tmp";
108 warn "Could not write to $output_dir ... does not exist!";
112 $filename = $fldir . '/'. $filename . '_' . $today_iso . ".log";
113 print "writing to $filename\n";
114 open (FILE, ">$filename") or die "Cannot write file $filename: $!";
115 print FILE join $delim, (@borrower_fields, @item_fields, @other_fields);
118 for (my $i=0; $i<scalar(@$data); $i++) {
119 my $datedue = C4::Dates->new($data->[$i]->{'date_due'},'iso');
120 my $datedue_days = Date_to_Days(split(/-/,$datedue->output('iso')));
121 my $due_str = $datedue->output();
122 unless (defined $data->[$i]->{'borrowernumber'}) {
123 print STDERR "ERROR in Getoverdues line $i: issues.borrowernumber IS NULL. Repair 'issues' table now! Skipping record.\n";
124 next; # Note: this doesn't solve everything. After NULL borrowernumber, multiple issues w/ real borrowernumbers can pile up.
126 my $borrower = BorType($data->[$i]->{'borrowernumber'});
127 my $branchcode = ($control eq 'ItemHomeLibrary') ? $data->[$i]->{homebranch} :
128 ($control eq 'PatronLibrary' ) ? $borrower->{branchcode} :
129 $data->[$i]->{branchcode} ;
130 # In final case, CircControl must be PickupLibrary. (branchcode comes from issues table here).
132 unless (defined ($calendars{$branchcode})) {
133 $calendars{$branchcode} = C4::Calendar->new(branchcode => $branchcode);
135 $calendar = $calendars{$branchcode};
136 my $isHoliday = $calendar->isHoliday(split '/', $today->output('metric'));
138 ($datedue_days <= $today_days) or next; # or it's not overdue, right?
140 $overdueItemsCounted++;
141 my ($amount,$type,$daycounttotal,$daycount)=
142 CalcFine($data->[$i], $borrower->{'categorycode'}, $branchcode,undef,undef, $datedue, $today);
143 # FIXME: $type NEVER gets populated by anything.
144 (defined $type) or $type = '';
145 # Don't update the fine if today is a holiday.
146 # This ensures that dropbox mode will remove the correct amount of fine.
147 if ($mode eq 'production' and ! $isHoliday) {
148 UpdateFine($data->[$i]->{'itemnumber'},$data->[$i]->{'borrowernumber'},$amount,$type,$due_str) if( $amount > 0 ) ;
151 push @cells, map {$borrower->{$_}} @borrower_fields;
152 push @cells, map {$data->[$i]->{$_}} @item_fields;
153 push @cells, $type, $daycounttotal, $amount;
154 print FILE join($delim, @cells), "\n";
157 my $numOverdueItems = scalar(@$data);
160 Fines assessment -- $today_iso -- Saved to $filename
161 Number of Overdue Items:
162 counted $overdueItemsCounted
163 reported $numOverdueItems