misc/cronjobs/staticfines.pl

   1 #!/usr/bin/perl
   2
   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 relies on being able to write to /tmp/
   7 # It creates the fines file
   8 #
   9 #  This script is meant to be run nightly out of cron.
  10
  11 # Copyright 2011-2012 BibLibre
  12 #
  13 # This file is part of Koha.
  14 #
  15 # Koha is free software; you can redistribute it and/or modify it
  16 # under the terms of the GNU General Public License as published by
  17 # the Free Software Foundation; either version 3 of the License, or
  18 # (at your option) any later version.
  19 #
  20 # Koha is distributed in the hope that it will be useful, but
  21 # WITHOUT ANY WARRANTY; without even the implied warranty of
  22 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  23 # GNU General Public License for more details.
  24 #
  25 # You should have received a copy of the GNU General Public License
  26 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  27
  28 use Modern::Perl;
  29
  30 BEGIN {
  31
  32     # find Koha's Perl modules
  33     # test carefully before changing this
  34     use FindBin;
  35     eval { require "$FindBin::Bin/kohalib.pl" };
  36 }
  37
  38 use Date::Calc qw/Date_to_Days/;
  39
  40 use C4::Context;
  41 use C4::Circulation;
  42 use C4::Overdues;
  43 use C4::Calendar qw();    # don't need any exports from Calendar
  44 use C4::Biblio;
  45 use C4::Debug;            # supplying $debug and $cgi_debug
  46 use C4::Log;
  47 use Getopt::Long;
  48 use List::MoreUtils qw/none/;
  49 use Koha::DateUtils;
  50
  51 my $help    = 0;
  52 my $verbose = 0;
  53 my @pcategories;
  54 my @categories;
  55 my %catamounts;
  56 my @libraries;
  57 my $delay;
  58 my $useborrowerlibrary;
  59 my $borrowernumberlimit;
  60 my $borrowersalreadyapplied; # hashref of borrowers for whom we already applied the fine, so it's only applied once
  61 my $debug = $ENV{'DEBUG'} || 0;
  62 my $bigdebug = 0;
  63
  64 GetOptions(
  65     'h|help'      => \$help,
  66     'v|verbose'   => \$verbose,
  67     'c|category:s'=> \@pcategories,
  68     'l|library:s' => \@libraries,
  69     'd|delay:i'   => \$delay,
  70     'u|use-borrower-library' => \$useborrowerlibrary,
  71     'b|borrower:i' => \$borrowernumberlimit
  72 );
  73 my $usage = << 'ENDUSAGE';
  74
  75 This script calculates and charges overdue fines to patron accounts.
  76
  77 If the Koha System Preference 'finesMode' is set to 'production', the fines are charged to the patron accounts.
  78 If set to 'test', the fines are calculated but not applied.
  79
  80 Please note that the fines won't be applied on a holiday.
  81
  82 This script has the following parameters :
  83     -h --help: this message
  84     -v --verbose
  85     -c --category borrower_category,amount (repeatable)
  86     -l --library (repeatable)
  87     -d --delay
  88     -u --use-borrower-library: use borrower's library, regardless of the CircControl syspref
  89     -b --borrower borrowernumber: only for one given borrower
  90
  91 ENDUSAGE
  92 die $usage if $help;
  93
  94 cronlogaction();
  95
  96 my $dbh = C4::Context->dbh;
  97
  98 # Processing categories
  99 foreach (@pcategories) {
 100     my ($category, $amount) = split(',', $_);
 101     push @categories, $category;
 102     $catamounts{$category} = $amount;
 103 }
 104
 105 use vars qw(@borrower_fields @item_fields @other_fields);
 106 use vars qw($fldir $libname $control $mode $delim $dbname $today $today_iso $today_days);
 107 use vars qw($filename);
 108
 109 CHECK {
 110     @borrower_fields = qw(cardnumber categorycode surname firstname email phone address citystate);
 111     @item_fields     = qw(itemnumber barcode date_due);
 112     @other_fields    = qw(type days_overdue fine);
 113     $libname         = C4::Context->preference('LibraryName');
 114     $control         = C4::Context->preference('CircControl');
 115     $mode            = C4::Context->preference('finesMode');
 116     $dbname          = C4::Context->config('database');
 117     $delim           = "\t";                                                                          # ?  C4::Context->preference('delimiter') || "\t";
 118
 119 }
 120
 121 INIT {
 122     $debug and print "Each line will contain the following fields:\n",
 123       "From borrowers : ", join( ', ', @borrower_fields ), "\n",
 124       "From items : ",     join( ', ', @item_fields ),     "\n",
 125       "Per overdue: ",     join( ', ', @other_fields ),    "\n",
 126       "Delimiter: '$delim'\n";
 127 }
 128 $debug and (defined $borrowernumberlimit) and print "--borrower limitation: borrower $borrowernumberlimit\n";
 129 my ($numOverdueItems, $data);
 130 if (defined $borrowernumberlimit) {
 131     ($numOverdueItems, $data) = checkoverdues($borrowernumberlimit);
 132 } else {
 133     $data = Getoverdues();
 134     $numOverdueItems = scalar @$data;
 135 }
 136 my $overdueItemsCounted = 0;
 137 my %calendars           = ();
 138 $today      = dt_from_string;
 139 $today_iso  = output_pref( { dt => $today, dateonly => 1, dateformat => 'iso' } );
 140 my ($tyear, $tmonth, $tday) = split( /-/, $today_iso );
 141 $today_days = Date_to_Days( $tyear, $tmonth, $tday );
 142
 143 for ( my $i = 0 ; $i < scalar(@$data) ; $i++ ) {
 144     next if $data->[$i]->{'itemlost'};
 145     my ( $datedue, $datedue_days );
 146     eval {
 147         $datedue = dt_from_string( $data->[$i]->{'date_due'} );
 148         my $datedue_iso = output_pref( { dt => $datedue, dateonly => 1, dateformat => 'iso' } );
 149         $datedue_days = Date_to_Days( split( /-/, $datedue_iso ) );
 150     };
 151     if ($@) {
 152     warn "Error on date for borrower " . $data->[$i]->{'borrowernumber'} .  ": $@date_due: " . $data->[$i]->{'date_due'} . "\ndatedue_days: " . $datedue_days . "\nSkipping";
 153     next;
 154     }
 155     my $due_str = output_pref( { dt => $datedue, dateonly => 1 } );
 156     unless ( defined $data->[$i]->{'borrowernumber'} ) {
 157         print STDERR "ERROR in Getoverdues line $i: issues.borrowernumber IS NULL.  Repair 'issues' table now!  Skipping record.\n";
 158         next;    # Note: this doesn't solve everything.  After NULL borrowernumber, multiple issues w/ real borrowernumbers can pile up.
 159     }
 160     my $borrower = BorType( $data->[$i]->{'borrowernumber'} );
 161
 162     # Skipping borrowers that are not in @categories
 163     $bigdebug and warn "Skipping borrower from category " . $borrower->{categorycode} if none { $borrower->{categorycode} eq $_ } @categories;
 164     next if none { $borrower->{categorycode} eq $_ } @categories;
 165
 166     my $branchcode =
 167         ( $useborrowerlibrary )           ? $borrower->{branchcode}
 168       : ( $control eq 'ItemHomeLibrary' ) ? $data->[$i]->{homebranch}
 169       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
 170       :                                     $data->[$i]->{branchcode};
 171     # In final case, CircControl must be PickupLibrary. (branchcode comes from issues table here).
 172
 173     # Skipping branchcodes that are not in @libraries
 174     $bigdebug and warn "Skipping library $branchcode" if none { $branchcode eq $_ } @libraries;
 175     next if none { $branchcode eq $_ } @libraries;
 176
 177     my $calendar;
 178     unless ( defined( $calendars{$branchcode} ) ) {
 179         $calendars{$branchcode} = C4::Calendar->new( branchcode => $branchcode );
 180     }
 181     $calendar = $calendars{$branchcode};
 182     my $isHoliday = $calendar->isHoliday( $tday, $tmonth, $tyear );
 183
 184     # Reassing datedue_days if -delay specified in commandline
 185     $bigdebug and warn "Using commandline supplied delay : $delay" if ($delay);
 186     $datedue_days += $delay if ($delay);
 187
 188     ( $datedue_days <= $today_days ) or next;    # or it's not overdue, right?
 189
 190     $overdueItemsCounted++;
 191     my ( $amount, $unitcounttotal, $unitcount ) = CalcFine(
 192         $data->[$i],
 193         $borrower->{'categorycode'},
 194         $branchcode,
 195         $datedue,
 196         $today,
 197     );
 198
 199     # Reassign fine's amount if specified in command-line
 200     $amount = $catamounts{$borrower->{'categorycode'}} if (defined $catamounts{$borrower->{'categorycode'}});
 201
 202     # We check if there is already a fine for the given borrower
 203     my $fine = GetFine(undef, $data->[$i]->{'borrowernumber'});
 204     if ($fine > 0) {
 205         $debug and warn "There is already a fine for borrower " . $data->[$i]->{'borrowernumber'} . ". Nothing to do here. Skipping this borrower";
 206         next;
 207     }
 208
 209     # Don't update the fine if today is a holiday.
 210     # This ensures that dropbox mode will remove the correct amount of fine.
 211     if ( $mode eq 'production' and !$borrowersalreadyapplied->{$data->[$i]->{'borrowernumber'}}) {
 212         # If we're on a holiday, warn the user (if debug) that no fine will be applied
 213         if($isHoliday) {
 214             $debug and warn "Today is a holiday. The fine for borrower " . $data->[$i]->{'borrowernumber'} . " will not be applied";
 215         } else {
 216             $debug and warn "Creating fine for borrower " . $data->[$i]->{'borrowernumber'} . " with amount : $amount";
 217
 218             # We mark this borrower as already processed
 219             $borrowersalreadyapplied->{$data->[$i]->{'borrowernumber'}} = 1;
 220
 221             my $borrowernumber = $data->[$i]->{'borrowernumber'};
 222             my $itemnumber     = $data->[$i]->{'itemnumber'};
 223
 224             # And we create the fine
 225             my $sth4 = $dbh->prepare( "SELECT title FROM biblio LEFT JOIN items ON biblio.biblionumber=items.biblionumber WHERE items.itemnumber=?" );
 226             $sth4->execute($itemnumber);
 227             my $title = $sth4->fetchrow;
 228
 229             my $nextaccntno = C4::Accounts::getnextacctno($borrowernumber);
 230             my $desc        = "staticfine";
 231             my $query       = "INSERT INTO accountlines
 232                         (borrowernumber,itemnumber,date,amount,description,accounttype,amountoutstanding,lastincrement,accountno)
 233                                 VALUES (?,?,now(),?,?,'F',?,?,?)";
 234             my $sth2 = $dbh->prepare($query);
 235             $bigdebug and warn "query: $query\nw/ args: $borrowernumber, $itemnumber, $amount, $desc, $amount, $amount, $nextaccntno\n";
 236             $sth2->execute( $borrowernumber, $itemnumber, $amount, $desc, $amount, $amount, $nextaccntno );
 237
 238         }
 239     }
 240 }
 241
 242 if ($verbose) {
 243     print <<EOM;
 244 Fines assessment -- $today_iso
 245 Number of Overdue Items:
 246      counted $overdueItemsCounted
 247     reported $numOverdueItems
 248
 249 EOM
 250 }
 251