C4/Circulation/Fines.pm

   1 package C4::Circulation::Fines;
   2
   3 # $Id$
   4
   5 # Copyright 2000-2002 Katipo Communications
   6 #
   7 # This file is part of Koha.
   8 #
   9 # Koha is free software; you can redistribute it and/or modify it under the
  10 # terms of the GNU General Public License as published by the Free Software
  11 # Foundation; either version 2 of the License, or (at your option) any later
  12 # version.
  13 #
  14 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  15 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License along with
  19 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  20 # Suite 330, Boston, MA  02111-1307 USA
  21
  22 use strict;
  23 require Exporter;
  24 use DBI;
  25 use C4::Context;
  26 use vars qw($VERSION @ISA @EXPORT);
  27
  28 # set the version for version checking
  29 $VERSION = 0.01;
  30
  31 =head1 NAME
  32
  33 C4::Circulation::Fines - Koha module dealing with fines
  34
  35 =head1 SYNOPSIS
  36
  37   use C4::Circulation::Fines;
  38
  39 =head1 DESCRIPTION
  40
  41 This module contains several functions for dealing with fines for
  42 overdue items. It is primarily used by the 'misc/fines2.pl' script.
  43
  44 =head1 FUNCTIONS
  45
  46 =over 2
  47
  48 =cut
  49
  50 @ISA = qw(Exporter);
  51 @EXPORT = qw(&Getoverdues &CalcFine &BorType &UpdateFine &ReplacementCost);
  52
  53 =item Getoverdues
  54
  55   ($count, $overdues) = &Getoverdues();
  56
  57 Returns the list of all overdue books.
  58
  59 C<$count> is the number of elements in C<@{$overdues}>.
  60
  61 C<$overdues> is a reference-to-array. Each element is a
  62 reference-to-hash whose keys are the fields of the issues table in the
  63 Koha database.
  64
  65 =cut
  66 #'
  67 sub Getoverdues{
  68   my $dbh = C4::Context->dbh;
  69   my $sth=$dbh->prepare("Select * from issues where date_due < now() and returndate is
  70   NULL order by borrowernumber");
  71   $sth->execute;
  72   # FIXME - Use push @results
  73   my $i=0;
  74   my @results;
  75   while (my $data=$sth->fetchrow_hashref){
  76     $results[$i]=$data;
  77     $i++;
  78   }
  79   $sth->finish;
  80 #  print @results;
  81   # FIXME - Bogus API.
  82   return($i,\@results);
  83 }
  84
  85 =item CalcFine
  86
  87   ($amount, $chargename, $message) =
  88         &CalcFine($itemnumber, $borrowercode, $days_overdue);
  89
  90 Calculates the fine for a book.
  91
  92 The issuingrules table in the Koha database is a fine matrix, listing
  93 the penalties for each type of patron for each type of item and each branch (e.g., the
  94 standard fine for books might be $0.50, but $1.50 for DVDs, or staff
  95 members might get a longer grace period between the first and second
  96 reminders that a book is overdue).
  97
  98 The fine is calculated as follows: if it is time for the first
  99 reminder, the fine is the value listed for the given (branch, item type,
 100 borrower code) combination. If it is time for the second reminder, the
 101 fine is doubled. Finally, if it is time to send the account to a
 102 collection agency, the fine is set to 5 local monetary units (a really
 103 good deal for the patron if the library is in Italy). Otherwise, the
 104 fine is 0.
 105
 106 Note that the way this function is currently implemented, it only
 107 returns a nonzero value on the notable days listed above. That is, if
 108 the categoryitems entry says to send a first reminder 7 days after the
 109 book is due, then if you call C<&CalcFine> 7 days after the book is
 110 due, it will give a nonzero fine. If you call C<&CalcFine> the next
 111 day, however, it will say that the fine is 0.
 112
 113 C<$itemnumber> is the book's item number.
 114
 115 C<$borrowercode> is the borrower code of the patron who currently has
 116 the book.
 117
 118 C<$days_overdue> is the number of days elapsed since the book's due
 119 date.
 120
 121 C<&CalcFine> returns a list of three values:
 122
 123 C<$amount> is the fine owed by the patron (see above).
 124
 125 C<$chargename> is the chargename field from the applicable record in
 126 the categoryitem table, whatever that is.
 127
 128 C<$message> is a text message, either "First Notice", "Second Notice",
 129 or "Final Notice".
 130
 131 =cut
 132 #'
 133 sub CalcFine {
 134   my ($itemnumber,$bortype,$difference)=@_;
 135   my $dbh = C4::Context->dbh;
 136
 137   # Look up the categoryitem record for this book's item type and the
 138   # given borrwer type.
 139   # The reason this query is so messy is that it's a messy question:
 140   # given the barcode, we can find the book's items record. This gives
 141   # us the biblioitems record, which gives us a set of categoryitem
 142   # records. Then we select the one that corresponds to the desired
 143   # borrower type.
 144
 145   # FIXME - Is it really necessary to get absolutely everything from
 146   # all four tables? It looks as if this code only wants
 147   # firstremind, chargeperiod, accountsent, and chargename from the
 148   # categoryitem table.
 149
 150   my $sth=$dbh->prepare("Select * from items,biblioitems,itemtypes,categoryitem where items.itemnumber=?
 151   and items.biblioitemnumber=biblioitems.biblioitemnumber and
 152   biblioitems.itemtype=itemtypes.itemtype and
 153   categoryitem.itemtype=itemtypes.itemtype and
 154   categoryitem.categorycode='?' and (items.itemlost <> 1 or items.itemlost is NULL)");
 155 #  print $query;
 156   $sth->execute($itemnumber,$bortype);
 157   my $data=$sth->fetchrow_hashref;
 158         # FIXME - Error-checking: the item might be lost, or there
 159         # might not be an entry in 'categoryitem' for this item type
 160         # or borrower type.
 161   $sth->finish;
 162   my $amount=0;
 163   my $printout;
 164
 165   # Is it time to send out the first reminder?
 166   # FIXME - I'm not sure the "=="s are correct here. Let's say that
 167   # $data->{firstremind} is today, but 'fines2.pl' doesn't run for
 168   # some reason (the cron daemon died, the server crashed, the
 169   # sysadmin had the machine down for maintenance, or whatever).
 170   #
 171   # Then the next day, the book is $data->{firstremind}+1 days
 172   # overdue. But this function returns $amount == 0, $printout ==
 173   # undef, on the assumption that 'fines2.pl' ran the previous day. So
 174   # the first thing the patron gets is a second notice, but that's a
 175   # week after the server crash, so people may not connect the two
 176   # events.
 177   if ($difference == $data->{'firstremind'}){
 178     # Yes. Set the fine as listed.
 179     $amount=$data->{'fine'};
 180     $printout="First Notice";
 181   }
 182
 183   # Is it time to send out a second reminder?
 184   my $second=$data->{'firstremind'}+$data->{'chargeperiod'};
 185   if ($difference == $second){
 186     # Yes. The fine is double.
 187     $amount=$data->{'fine'}*2;
 188     $printout="Second Notice";
 189   }
 190
 191   # Is it time to send the account to a collection agency?
 192   # FIXME - At least, I *think* that's what this code is doing.
 193   if ($difference == $data->{'accountsent'} && $data->{'fine'} > 0){
 194     # Yes. Set the fine at 5 local monetary units.
 195     # FIXME - This '5' shouldn't be hard-wired.
 196     $amount=5;
 197     $printout="Final Notice";
 198   }
 199   return($amount,$data->{'chargename'},$printout);
 200 }
 201
 202 =item UpdateFine
 203
 204   &UpdateFine($itemnumber, $borrowernumber, $amount, $type, $description);
 205
 206 (Note: the following is mostly conjecture and guesswork.)
 207
 208 Updates the fine owed on an overdue book.
 209
 210 C<$itemnumber> is the book's item number.
 211
 212 C<$borrowernumber> is the borrower number of the patron who currently
 213 has the book on loan.
 214
 215 C<$amount> is the current amount owed by the patron.
 216
 217 C<$type> will be used in the description of the fine.
 218
 219 C<$description> is a string that must be present in the description of
 220 the fine. I think this is expected to be a date in DD/MM/YYYY format.
 221
 222 C<&UpdateFine> looks up the amount currently owed on the given item
 223 and sets it to C<$amount>, creating, if necessary, a new entry in the
 224 accountlines table of the Koha database.
 225
 226 =cut
 227 #'
 228 # FIXME - This API doesn't look right: why should the caller have to
 229 # specify both the item number and the borrower number? A book can't
 230 # be on loan to two different people, so the item number should be
 231 # sufficient.
 232 sub UpdateFine {
 233   my ($itemnum,$bornum,$amount,$type,$due)=@_;
 234   my $dbh = C4::Context->dbh;
 235   # FIXME - What exactly is this query supposed to do? It looks up an
 236   # entry in accountlines that matches the given item and borrower
 237   # numbers, where the description contains $due, and where the
 238   # account type has one of several values, but what does this _mean_?
 239   # Does it look up existing fines for this item?
 240   # FIXME - What are these various account types? ("FU", "O", "F", "M")
 241   my $sth=$dbh->prepare("Select * from accountlines where itemnumber=? and
 242   borrowernumber=? and (accounttype='FU' or accounttype='O' or
 243   accounttype='F' or accounttype='M') and description like ?");
 244   $sth->execute($itemnum,$bornum,"%$due%");
 245
 246   if (my $data=$sth->fetchrow_hashref){
 247     # I think this if-clause deals with the case where we're updating
 248     # an existing fine.
 249 #    print "in accounts ...";
 250     if ($data->{'amount'} != $amount){
 251
 252 #      print "updating";
 253       my $diff=$amount - $data->{'amount'};
 254       my $out=$data->{'amountoutstanding'}+$diff;
 255       my $sth2=$dbh->prepare("update accountlines set date=now(), amount=?,
 256       amountoutstanding=?,accounttype='FU' where
 257       borrowernumber=? and itemnumber=?
 258       and (accounttype='FU' or accounttype='O') and description like ?");
 259       $sth2->execute($amount,$out,$data->{'borrowernumber'},$data->{'itemnumber'},"%$due%");
 260       $sth2->finish;
 261     } else {
 262 #      print "no update needed $data->{'amount'}"
 263     }
 264   } else {
 265     # I think this else-clause deals with the case where we're adding
 266     # a new fine.
 267     my $sth4=$dbh->prepare("select title from biblio,items where items.itemnumber=?
 268     and biblio.biblionumber=items.biblionumber");
 269     $sth4->execute($itemnum);
 270     my $title=$sth4->fetchrow_hashref;
 271     $sth4->finish;
 272  #   print "not in account";
 273     my $sth3=$dbh->prepare("Select max(accountno) from accountlines");
 274     $sth3->execute;
 275     # FIXME - Make $accountno a scalar.
 276     my @accountno=$sth3->fetchrow_array;
 277     $sth3->finish;
 278     $accountno[0]++;
 279     my $sth2=$dbh->prepare("Insert into accountlines
 280     (borrowernumber,itemnumber,date,amount,
 281     description,accounttype,amountoutstanding,accountno) values
 282     (?,?,now(),?,?,'FU',?,?)");
 283     $sth2->execute($bornum,$itemnum,$amount,"$type $title->{'title'} $due",$amount,$accountno[0]);
 284     $sth2->finish;
 285   }
 286   $sth->finish;
 287 }
 288
 289 =item BorType
 290
 291   $borrower = &BorType($borrowernumber);
 292
 293 Looks up a patron by borrower number.
 294
 295 C<$borrower> is a reference-to-hash whose keys are all of the fields
 296 from the borrowers and categories tables of the Koha database. Thus,
 297 C<$borrower> contains all information about both the borrower and
 298 category he or she belongs to.
 299
 300 =cut
 301 #'
 302 sub BorType {
 303   my ($borrowernumber)=@_;
 304   my $dbh = C4::Context->dbh;
 305   my $sth=$dbh->prepare("Select * from borrowers,categories where
 306   borrowernumber=? and
 307 borrowers.categorycode=categories.categorycode");
 308   $sth->execute($borrowernumber);
 309   my $data=$sth->fetchrow_hashref;
 310   $sth->finish;
 311   return($data);
 312 }
 313
 314 =item ReplacementCost
 315
 316   $cost = &ReplacementCost($itemnumber);
 317
 318 Returns the replacement cost of the item with the given item number.
 319
 320 =cut
 321 #'
 322 sub ReplacementCost{
 323   my ($itemnum)=@_;
 324   my $dbh = C4::Context->dbh;
 325   my $sth=$dbh->prepare("Select replacementprice from items where itemnumber=?");
 326   $sth->execute($itemnum);
 327   # FIXME - Use fetchrow_array or something.
 328   my $data=$sth->fetchrow_hashref;
 329   $sth->finish;
 330   return($data->{'replacementprice'});
 331 }
 332
 333 1;
 334 __END__
 335
 336 =back
 337
 338 =head1 AUTHOR
 339
 340 Koha Developement team <info@koha.org>
 341
 342 =cut