Skip to content
Fetching contributors…
Cannot retrieve contributors at this time
executable file 186 lines (158 sloc) 6.57 KB
#!/usr/bin/env perl
# This script loops through each overdue item, determines the fine,
# and updates the total amount of fines due by each user. It relies on
# the existence of /tmp/fines, which is created by ???
# Doesnt really rely on it, it relys on being able to write to /tmp/
# It creates the fines file
# This script is meant to be run nightly out of cron.
# Copyright 2000-2002 Katipo Communications
# This file is part of Koha.
# Koha is free software; you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation; either version 2 of the License, or (at your option) any later
# version.
# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
# You should have received a copy of the GNU General Public License along with
# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
# Suite 330, Boston, MA 02111-1307 USA
# FIXME: use FinesMode as described or change syspref description
use strict;
# find Koha's Perl modules
# test carefully before changing this
use FindBin;
eval { require "$FindBin::Bin/" };
use Date::Calc qw/Date_to_Days/;
use Koha;
use C4::Context;
use C4::Circulation;
use C4::Overdues;
use C4::Calendar qw(); # don't need any exports from Calendar
use C4::Biblio;
use C4::Debug; # supplying $debug and $cgi_debug
use Getopt::Long;
my $spoof = '';
my $help = 0;
my $verbose = 0;
my $output_dir;
GetOptions( 'h|help' => \$help,
'v|verbose' => \$verbose,
'o|out:s' => \$output_dir,
'd|spoof:s' => \$spoof,
my $usage = << 'ENDUSAGE';
This script calculates and charges overdue fines
to patron accounts. If the Koha System Preference
'finesMode' is set to 'production', the fines are charged
to the patron accounts. If set to 'test', the fines are
calculated but not applied.
This script has the following parameters :
-h --help: this message
-o --out: ouput directory for logs (defaults to env or /tmp if !exist)
-v --verbose
-d --date: spoof a date other than today, ISO format YYYY-MM-DD
die $usage if $help;
use vars qw(@borrower_fields @item_fields @other_fields);
use vars qw($fldir $libname $control $mode $delim $dbname $today $today_iso $today_days);
use vars qw($filename);
@borrower_fields = qw(cardnumber categorycode surname firstname email phone address citystate);
@item_fields = qw(itemnumber barcode date_due itemlost);
@other_fields = qw(type days_overdue fine);
$libname = C4::Context->preference('LibraryName');
$control = C4::Context->preference('CircControl');
$mode = C4::Context->preference('finesMode');
$dbname = C4::Context->config('database');
$delim = "\t"; # ? C4::Context->preference('delimiter') || "\t";
$debug and print "Each line will contain the following fields:\n",
"From borrowers : ", join(', ', @borrower_fields), "\n",
"From items : ", join(', ', @item_fields), "\n",
"Per overdue: ", join(', ', @other_fields), "\n",
"Delimiter: '$delim'\n";
my $data = Getoverdues();
my $overdueItemsCounted = 0;
my %calendars = ();
$today = C4::Dates->new();
if ($spoof =~ /^\d{4}-\d\d-\d\d$/) {
$today = C4::Dates->new($spoof,'iso');
$today_iso = $today->output('iso');
$today_days = Date_to_Days(split(/-/,$today_iso));
$fldir = $output_dir if( -d $output_dir );
} else {
$fldir = $ENV{TMPDIR} || "/tmp";
if (!-d $fldir) {
warn "Could not write to $fldir ... does not exist!";
$filename = $dbname;
$filename =~ s/\W//;
$filename = $fldir . '/'. $filename . '_' . $today_iso . ".log";
print "writing to $filename\n" if $verbose;
open (FILE, ">$filename") or die "Cannot write file $filename: $!";
print FILE join $delim, (@borrower_fields, @item_fields, @other_fields);
print FILE "\n";
for (my $i=0; $i<scalar(@$data); $i++) {
my $datedue = C4::Dates->new($data->[$i]->{'date_due'},'iso');
my $datedue_days = Date_to_Days(split(/-/,$datedue->output('iso')));
my $due_str = $datedue->output();
unless (defined $data->[$i]->{'borrowernumber'}) {
print STDERR "ERROR in Getoverdues line $i: issues.borrowernumber IS NULL. Repair 'issues' table now! Skipping record.\n";
next; # Note: this doesn't solve everything. After NULL borrowernumber, multiple issues w/ real borrowernumbers can pile up.
my $borrower = BorType($data->[$i]->{'borrowernumber'});
my $branchcode = ($control eq 'ItemHomeLibrary') ? $data->[$i]->{homebranch} :
($control eq 'PatronLibrary' ) ? $borrower->{branchcode} :
$data->[$i]->{branchcode} ;
# In final case, CircControl must be PickupLibrary. (branchcode comes from issues table here).
my $calendar;
unless (defined ($calendars{$branchcode})) {
$calendars{$branchcode} = C4::Calendar->new(branchcode => $branchcode);
$calendar = $calendars{$branchcode};
my $isHoliday = $calendar->isHoliday(split '/', $today->output('metric'));
($datedue_days <= $today_days) or next; # or it's not overdue, right?
my $claimret_item=0;
if ($data->[$i]->{'itemlost'} == C4::Context->preference('ClaimsReturnedValue')){ #this item is claims-returned, don't add more fines
my ($amount,$type,$daycounttotal,$daycount,$ismax)=
CalcFine($data->[$i], $borrower->{'categorycode'}, $branchcode,undef,undef, $datedue, $today);
# FIXME: $type NEVER gets populated by anything.
(defined $type) or $type = '';
# Don't update the fine if today is a holiday.
# This ensures that dropbox mode will remove the correct amount of fine.
if ($mode eq 'production' and ! $isHoliday and ! $claimret_item) {
if( $amount > 0 ) ;
my @cells = ();
push @cells, map {$borrower->{$_} // ''} @borrower_fields;
push @cells, map {$data->[$i]->{$_} // ''} @item_fields;
push @cells, $type, $daycounttotal, $amount;
print FILE join($delim, @cells), "\n";
my $numOverdueItems = scalar(@$data);
if ($verbose) {
print <<EOM;
Fines assessment -- $today_iso -- Saved to $filename
Number of Overdue Items:
counted $overdueItemsCounted
reported $numOverdueItems
close FILE;
Jump to Line
Something went wrong with that request. Please try again.