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 );
53 my $command_line_options = join(" ",@ARGV);
57 'v|verbose' => \$verbose,
59 'o|out:s' => \$output_dir,
60 'm|maxdays:i' => \$maxdays,
61 'i|verifyissue' => \$verify_issue,
63 my $usage = << 'ENDUSAGE';
65 This script calculates and charges overdue fines
66 to patron accounts. The Koha system preference 'finesMode' controls
67 whether the fines are calculated and charged to the patron accounts ("Calculate and charge");
68 or not calculated ("Don't calculate").
70 This script has the following parameters :
71 -h --help: this message
72 -l --log: log the output to a file (optional if the -o parameter is given)
73 -o --out: ouput directory for logs (defaults to env or /tmp if !exist)
75 -m --maxdays: how many days back of overdues to process
76 -i --verifyissue: verify the issue before updating the fine in case the
77 item is returned while the fines job is running
86 my $script_handler = Koha::Script->new({ script => $0 });
89 $script_handler->lock_exec;
92 my $message = "Skipping execution of $0 ($_)";
93 print STDERR "$message\n"
95 cronlogaction({ info => $message });
99 cronlogaction({ info => $command_line_options });
101 my @borrower_fields =
102 qw(cardnumber categorycode surname firstname email phone address citystate);
103 my @item_fields = qw(itemnumber barcode date_due);
104 my @other_fields = qw(days_overdue fine);
105 my $libname = C4::Context->preference('LibraryName');
106 my $control = C4::Context->preference('CircControl');
107 my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
108 my $mode = C4::Context->preference('finesMode');
109 my $delim = "\t"; # ? C4::Context->preference('CSVDelimiter') || "\t";
112 my $today = dt_from_string();
114 if ($log or $output_dir) {
115 $filename = get_filename($output_dir);
120 open $fh, '>>', $filename or croak "Cannot write file $filename: $!";
121 print {$fh} join $delim, ( @borrower_fields, @item_fields, @other_fields );
127 $params->{maximumdays} = $maxdays if $maxdays;
128 my $overdues = Getoverdues($params);
129 for my $overdue ( @{$overdues} ) {
130 next if $overdue->{itemlost};
132 if ( !defined $overdue->{borrowernumber} ) {
134 "ERROR in Getoverdues : issues.borrowernumber IS NULL. Repair 'issues' table now! Skipping record.\n";
137 my $patron = Koha::Patrons->find( $overdue->{borrowernumber} );
139 ( $control eq 'ItemHomeLibrary' ) ? $overdue->{$branch_type}
140 : ( $control eq 'PatronLibrary' ) ? $patron->branchcode
141 : $overdue->{branchcode};
143 # In final case, CircControl must be PickupLibrary. (branchcode comes from issues table here).
144 if ( !exists $is_holiday{$branchcode} ) {
145 $is_holiday{$branchcode} = set_holiday( $branchcode, $today );
148 my $datedue = dt_from_string( $overdue->{date_due} );
149 if ( DateTime->compare( $datedue, $today ) == 1 ) {
154 my ( $amount, $unitcounttotal, $unitcount ) =
155 CalcFine( $overdue, $patron->categorycode,
156 $branchcode, $datedue, $today );
158 # Don't update the fine if today is a holiday.
159 # This ensures that dropbox mode will remove the correct amount of fine.
161 $mode eq 'production'
162 && ( !$is_holiday{$branchcode}
163 || C4::Context->preference('ChargeFinesOnClosedDays') )
164 && ( $amount && $amount > 0 )
167 if ( $verify_issue ) {
168 # if the issue changed before the script got to it, then pass on it.
169 my $issue = Koha::Checkouts->find({ issue_id => $overdue->{issue_id} });
170 if ( ! $issue or $issue->date_due ne $overdue->{date_due} ) {
177 issue_id => $overdue->{issue_id},
178 itemnumber => $overdue->{itemnumber},
179 borrowernumber => $overdue->{borrowernumber},
186 my $borrower = $patron->unblessed;
190 map { defined $borrower->{$_} ? $borrower->{$_} : q{} }
192 push @cells, map { $overdue->{$_} } @item_fields;
193 push @cells, $unitcounttotal, $amount;
194 say {$fh} join $delim, @cells;
202 my $overdue_items = @{$overdues};
204 Fines assessment -- $today
207 say "Saved to $filename";
210 Number of Overdue Items:
211 counted $overdue_items
218 cronlogaction({ action => 'End', info => "COMPLETED" });
221 my ( $branch, $dt ) = @_;
223 my $calendar = Koha::Calendar->new( branchcode => $branch );
224 return $calendar->is_holiday($dt);
228 my $directory = shift;
230 $directory = C4::Context::temporary_directory;
232 if ( !-d $directory ) {
233 carp "Could not write to $directory ... does not exist!";
235 my $name = C4::Context->config('database');
237 $name .= join q{}, q{_}, $today->ymd(), '.log';
238 $name = File::Spec->catfile( $directory, $name );
239 if ($verbose && $log) {
240 say "writing to $name";