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 # Doesnt really rely on it, it relys 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 Getopt::Long;
  47 use List::MoreUtils qw/none/;
  48 use Koha::DateUtils;
  49
  50 my $help    = 0;
  51 my $verbose = 0;
  52 my @pcategories;
  53 my @categories;
  54 my %catamounts;
  55 my @libraries;
  56 my $delay;
  57 my $useborrowerlibrary;
  58 my $borrowernumberlimit;
  59 my $borrowersalreadyapplied; # hashref of borrowers for whom we already applied the fine, so it's only applied once
  60 my $debug = $ENV{'DEBUG'} || 0;
  61 my $bigdebug = 0;
  62
  63 GetOptions(
  64     'h|help'      => \$help,
  65     'v|verbose'   => \$verbose,
  66     'c|category:s'=> \@pcategories,
  67     'l|library:s' => \@libraries,
  68     'd|delay:i'   => \$delay,
  69     'u|use-borrower-library' => \$useborrowerlibrary,
  70     'b|borrower:i' => \$borrowernumberlimit
  71 );
  72 my $usage = << 'ENDUSAGE';
  73
  74 This script calculates and charges overdue fines to patron accounts.
  75
  76 If the Koha System Preference 'finesMode' is set to 'production', the fines are charged to the patron accounts.
  77 If set to 'test', the fines are calculated but not applied.
  78
  79 Please note that the fines won't be applied on a holiday.
  80
  81 This script has the following parameters :
  82     -h --help: this message
  83     -v --verbose
  84     -c --category borrower_category,amount (repeatable)
  85     -l --library (repeatable)
  86     -d --delay
  87     -u --use-borrower-library: use borrower's library, regardless of the CircControl syspref
  88     -b --borrower borrowernumber: only for one given borrower
  89
  90 ENDUSAGE
  91 die $usage if $help;
  92
  93 my $dbh = C4::Context->dbh;
  94
  95 # Processing categories
  96 foreach (@pcategories) {
  97     my ($category, $amount) = split(',', $_);
  98     push @categories, $category;
  99     $catamounts{$category} = $amount;
 100 }
 101
 102 use vars qw(@borrower_fields @item_fields @other_fields);
 103 use vars qw($fldir $libname $control $mode $delim $dbname $today $today_iso $today_days);
 104 use vars qw($filename);
 105
 106 CHECK {
 107     @borrower_fields = qw(cardnumber categorycode surname firstname email phone address citystate);
 108     @item_fields     = qw(itemnumber barcode date_due);
 109     @other_fields    = qw(type days_overdue fine);
 110     $libname         = C4::Context->preference('LibraryName');
 111     $control         = C4::Context->preference('CircControl');
 112     $mode            = C4::Context->preference('finesMode');
 113     $dbname          = C4::Context->config('database');
 114     $delim           = "\t";                                                                          # ?  C4::Context->preference('delimiter') || "\t";
 115
 116 }
 117
 118 INIT {
 119     $debug and print "Each line will contain the following fields:\n",
 120       "From borrowers : ", join( ', ', @borrower_fields ), "\n",
 121       "From items : ",     join( ', ', @item_fields ),     "\n",
 122       "Per overdue: ",     join( ', ', @other_fields ),    "\n",
 123       "Delimiter: '$delim'\n";
 124 }
 125 $debug and (defined $borrowernumberlimit) and print "--borrower limitation: borrower $borrowernumberlimit\n";
 126 my ($numOverdueItems, $data);
 127 if (defined $borrowernumberlimit) {
 128     ($numOverdueItems, $data) = checkoverdues($borrowernumberlimit);
 129 } else {
 130     $data = Getoverdues();
 131     $numOverdueItems = scalar @$data;
 132 }
 133 my $overdueItemsCounted = 0;
 134 my %calendars           = ();
 135 $today      = C4::Dates->new();
 136 $today_iso  = $today->output('iso');
 137 my ($tyear, $tmonth, $tday) = split( /-/, $today_iso );
 138 $today_days = Date_to_Days( $tyear, $tmonth, $tday );
 139
 140 for ( my $i = 0 ; $i < scalar(@$data) ; $i++ ) {
 141     next if $data->[$i]->{'itemlost'};
 142     my $datedue;
 143     my $datedue_days;
 144     eval {
 145     $datedue = C4::Dates->new( $data->[$i]->{'date_due'}, 'iso' );
 146     $datedue_days = Date_to_Days( split( /-/, $datedue->output('iso') ) );
 147     };
 148     if ($@) {
 149     warn "Error on date for borrower " . $data->[$i]->{'borrowernumber'} .  ": $@date_due: " . $data->[$i]->{'date_due'} . "\ndatedue_days: " . $datedue_days . "\nSkipping";
 150     next;
 151     }
 152     my $due_str = $datedue->output();
 153     unless ( defined $data->[$i]->{'borrowernumber'} ) {
 154         print STDERR "ERROR in Getoverdues line $i: issues.borrowernumber IS NULL.  Repair 'issues' table now!  Skipping record.\n";
 155         next;    # Note: this doesn't solve everything.  After NULL borrowernumber, multiple issues w/ real borrowernumbers can pile up.
 156     }
 157     my $borrower = BorType( $data->[$i]->{'borrowernumber'} );
 158
 159     # Skipping borrowers that are not in @categories
 160     $bigdebug and warn "Skipping borrower from category " . $borrower->{categorycode} if none { $borrower->{categorycode} eq $_ } @categories;
 161     next if none { $borrower->{categorycode} eq $_ } @categories;
 162
 163     my $branchcode =
 164         ( $useborrowerlibrary )           ? $borrower->{branchcode}
 165       : ( $control eq 'ItemHomeLibrary' ) ? $data->[$i]->{homebranch}
 166       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
 167       :                                     $data->[$i]->{branchcode};
 168     # In final case, CircControl must be PickupLibrary. (branchcode comes from issues table here).
 169
 170     # Skipping branchcodes that are not in @libraries
 171     $bigdebug and warn "Skipping library $branchcode" if none { $branchcode eq $_ } @libraries;
 172     next if none { $branchcode eq $_ } @libraries;
 173
 174     my $calendar;
 175     unless ( defined( $calendars{$branchcode} ) ) {
 176         $calendars{$branchcode} = C4::Calendar->new( branchcode => $branchcode );
 177     }
 178     $calendar = $calendars{$branchcode};
 179     my $isHoliday = $calendar->isHoliday( $tday, $tmonth, $tyear );
 180
 181     # Reassing datedue_days if -delay specified in commandline
 182     $bigdebug and warn "Using commandline supplied delay : $delay" if ($delay);
 183     $datedue_days += $delay if ($delay);
 184
 185     ( $datedue_days <= $today_days ) or next;    # or it's not overdue, right?
 186
 187     $overdueItemsCounted++;
 188     my ( $amount, $type, $unitcounttotal, $unitcount ) = CalcFine(
 189         $data->[$i],
 190         $borrower->{'categorycode'},
 191         $branchcode,
 192         dt_from_string($datedue->output('iso')),
 193         dt_from_string($today->output('iso')),
 194     );
 195
 196     # Reassign fine's amount if specified in command-line
 197     $amount = $catamounts{$borrower->{'categorycode'}} if (defined $catamounts{$borrower->{'categorycode'}});
 198
 199     # We check if there is already a fine for the given borrower
 200     my $fine = GetFine(undef, $data->[$i]->{'borrowernumber'});
 201     if ($fine > 0) {
 202         $debug and warn "There is already a fine for borrower " . $data->[$i]->{'borrowernumber'} . ". Nothing to do here. Skipping this borrower";
 203         next;
 204     }
 205
 206     # FIXME: $type NEVER gets populated by anything.
 207     ( defined $type ) or $type = '';
 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