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;
35 use C4::Overdues qw( Getoverdues CalcFine UpdateFine );
36 use Getopt::Long qw( GetOptions );
37 use Carp qw( carp croak );
39 use Try::Tiny qw( catch try );
42 use Koha::DateUtils qw( dt_from_string output_pref );
44 use C4::Log qw( cronlogaction );
54 'v|verbose' => \$verbose,
56 'o|out:s' => \$output_dir,
57 'm|maxdays:i' => \$maxdays,
59 my $usage = << 'ENDUSAGE';
61 This script calculates and charges overdue fines
62 to patron accounts. The Koha system preference 'finesMode' controls
63 whether the fines are calculated and charged to the patron accounts ("Calculate and charge");
64 or not calculated ("Don't calculate").
66 This script has the following parameters :
67 -h --help: this message
68 -l --log: log the output to a file (optional if the -o parameter is given)
69 -o --out: ouput directory for logs (defaults to env or /tmp if !exist)
71 -m --maxdays: how many days back of overdues to process
80 my $script_handler = Koha::Script->new({ script => $0 });
83 $script_handler->lock_exec;
86 my $message = "Skipping execution of $0 ($_)";
87 print STDERR "$message\n"
89 cronlogaction( $message );
96 qw(cardnumber categorycode surname firstname email phone address citystate);
97 my @item_fields = qw(itemnumber barcode date_due);
98 my @other_fields = qw(days_overdue fine);
99 my $libname = C4::Context->preference('LibraryName');
100 my $control = C4::Context->preference('CircControl');
101 my $mode = C4::Context->preference('finesMode');
102 my $delim = "\t"; # ? C4::Context->preference('CSVDelimiter') || "\t";
105 my $today = dt_from_string();
107 if ($log or $output_dir) {
108 $filename = get_filename($output_dir);
113 open $fh, '>>', $filename or croak "Cannot write file $filename: $!";
114 print {$fh} join $delim, ( @borrower_fields, @item_fields, @other_fields );
120 $params->{maximumdays} = $maxdays if $maxdays;
121 my $overdues = Getoverdues($params);
122 for my $overdue ( @{$overdues} ) {
123 next if $overdue->{itemlost};
125 if ( !defined $overdue->{borrowernumber} ) {
127 "ERROR in Getoverdues : issues.borrowernumber IS NULL. Repair 'issues' table now! Skipping record.\n";
130 my $patron = Koha::Patrons->find( $overdue->{borrowernumber} );
132 ( $control eq 'ItemHomeLibrary' ) ? $overdue->{homebranch}
133 : ( $control eq 'PatronLibrary' ) ? $patron->branchcode
134 : $overdue->{branchcode};
136 # In final case, CircControl must be PickupLibrary. (branchcode comes from issues table here).
137 if ( !exists $is_holiday{$branchcode} ) {
138 $is_holiday{$branchcode} = set_holiday( $branchcode, $today );
141 my $datedue = dt_from_string( $overdue->{date_due} );
142 if ( DateTime->compare( $datedue, $today ) == 1 ) {
147 my ( $amount, $unitcounttotal, $unitcount ) =
148 CalcFine( $overdue, $patron->categorycode,
149 $branchcode, $datedue, $today );
151 # Don't update the fine if today is a holiday.
152 # This ensures that dropbox mode will remove the correct amount of fine.
154 $mode eq 'production'
155 && ( !$is_holiday{$branchcode}
156 || C4::Context->preference('ChargeFinesOnClosedDays') )
157 && ( $amount && $amount > 0 )
162 issue_id => $overdue->{issue_id},
163 itemnumber => $overdue->{itemnumber},
164 borrowernumber => $overdue->{borrowernumber},
166 due => output_pref($datedue),
171 my $borrower = $patron->unblessed;
175 map { defined $borrower->{$_} ? $borrower->{$_} : q{} }
177 push @cells, map { $overdue->{$_} } @item_fields;
178 push @cells, $unitcounttotal, $amount;
179 say {$fh} join $delim, @cells;
187 my $overdue_items = @{$overdues};
189 Fines assessment -- $today
192 say "Saved to $filename";
195 Number of Overdue Items:
196 counted $overdue_items
204 my ( $branch, $dt ) = @_;
206 my $calendar = Koha::Calendar->new( branchcode => $branch );
207 return $calendar->is_holiday($dt);
211 my $directory = shift;
213 $directory = C4::Context::temporary_directory;
215 if ( !-d $directory ) {
216 carp "Could not write to $directory ... does not exist!";
218 my $name = C4::Context->config('database');
220 $name .= join q{}, q{_}, $today->ymd(), '.log';
221 $name = File::Spec->catfile( $directory, $name );
222 if ($verbose && $log) {
223 say "writing to $name";