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
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 under the
17 # terms of the GNU General Public License as published by the Free Software
18 # Foundation; either version 2 of the License, or (at your option) any later
21 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
22 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
23 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
25 # You should have received a copy of the GNU General Public License along
26 # with Koha; if not, write to the Free Software Foundation, Inc.,
27 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
49 'v|verbose' => \$verbose,
51 'o|out:s' => \$output_dir,
53 my $usage = << 'ENDUSAGE';
55 This script calculates and charges overdue fines
56 to patron accounts. If the Koha System Preference
57 'finesMode' is set to 'production', the fines are charged
58 to the patron accounts. If set to 'test', the fines are
59 calculated but not applied.
61 This script has the following parameters :
62 -h --help: this message
63 -l --log: log the output to a file (optional if the -o parameter is given)
64 -o --out: ouput directory for logs (defaults to env or /tmp if !exist)
75 qw(cardnumber categorycode surname firstname email phone address citystate);
76 my @item_fields = qw(itemnumber barcode date_due);
77 my @other_fields = qw(type days_overdue fine);
78 my $libname = C4::Context->preference('LibraryName');
79 my $control = C4::Context->preference('CircControl');
80 my $mode = C4::Context->preference('finesMode');
81 my $delim = "\t"; # ? C4::Context->preference('delimiter') || "\t";
84 my $today = DateTime->now( time_zone => C4::Context->tz() );
86 if ($log or $output_dir) {
87 $filename = get_filename($output_dir);
92 open $fh, '>>', $filename or croak "Cannot write file $filename: $!";
93 print {$fh} join $delim, ( @borrower_fields, @item_fields, @other_fields );
97 my $overdues = Getoverdues();
98 for my $overdue ( @{$overdues} ) {
99 if ( !defined $overdue->{borrowernumber} ) {
101 "ERROR in Getoverdues : issues.borrowernumber IS NULL. Repair 'issues' table now! Skipping record.\n";
104 my $borrower = BorType( $overdue->{borrowernumber} );
106 ( $control eq 'ItemHomeLibrary' ) ? $overdue->{homebranch}
107 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
108 : $overdue->{branchcode};
110 # In final case, CircControl must be PickupLibrary. (branchcode comes from issues table here).
111 if ( !exists $is_holiday{$branchcode} ) {
112 $is_holiday{$branchcode} = set_holiday( $branchcode, $today );
115 my $datedue = dt_from_string( $overdue->{date_due} );
116 if ( DateTime->compare( $datedue, $today ) == 1 ) {
121 my ( $amount, $type, $unitcounttotal ) =
122 CalcFine( $overdue, $borrower->{categorycode},
123 $branchcode, $datedue, $today );
126 # Don't update the fine if today is a holiday.
127 # This ensures that dropbox mode will remove the correct amount of fine.
128 if ( $mode eq 'production' && !$is_holiday{$branchcode} ) {
131 $overdue->{itemnumber},
132 $overdue->{borrowernumber},
133 $amount, $type, output_pref($datedue)
140 map { defined $borrower->{$_} ? $borrower->{$_} : q{} }
142 push @cells, map { $overdue->{$_} } @item_fields;
143 push @cells, $type, $unitcounttotal, $amount;
144 say {$fh} join $delim, @cells;
152 my $overdue_items = @{$overdues};
154 Fines assessment -- $today
157 say "Saved to $filename";
160 Number of Overdue Items:
161 counted $overdue_items
168 my ( $branch, $dt ) = @_;
170 my $calendar = Koha::Calendar->new( branchcode => $branch );
171 return $calendar->is_holiday($dt);
175 my $directory = shift;
177 $directory = File::Spec->tmpdir();
179 if ( !-d $directory ) {
180 carp "Could not write to $directory ... does not exist!";
182 my $name = C4::Context->config('database');
184 $name .= join q{}, q{_}, $today->ymd(), '.log';
185 $name = File::Spec->catfile( $directory, $name );
186 if ($verbose && $log) {
187 say "writing to $name";