use C4::Context;
use C4::Accounts;
use C4::Log; # logaction
+use C4::Debug;
use vars qw($VERSION @ISA @EXPORT);
=head1 FUNCTIONS
-=over 2
+=head2 Getoverdues
-=item Getoverdues
-
- ($overdues) = &Getoverdues();
+ $overdues = Getoverdues( { minimumdays => 1, maximumdays => 30 } );
Returns the list of all overdue books, with their itemtype.
#'
sub Getoverdues {
+ my $params = shift;
+
my $dbh = C4::Context->dbh;
- my $sth = (C4::Context->preference('item-level_itypes')) ?
- $dbh->prepare(
- "SELECT issues.*,items.itype as itemtype FROM issues
- LEFT JOIN items USING (itemnumber)
- WHERE date_due < now()
- ORDER BY borrowernumber " )
- :
- $dbh->prepare(
- "SELECT issues.*,biblioitems.itemtype,items.itype FROM issues
- LEFT JOIN items USING (itemnumber)
- LEFT JOIN biblioitems USING (biblioitemnumber)
- WHERE date_due < now()
- ORDER BY borrowernumber " );
- $sth->execute;
-
- my @results;
- while ( my $data = $sth->fetchrow_hashref ) {
- push @results, $data;
+ my $statement;
+ if ( C4::Context->preference('item-level_itypes') ) {
+ $statement = "
+SELECT issues.*,items.itype as itemtype, items.homebranch FROM issues
+LEFT JOIN items USING (itemnumber)
+WHERE date_due < now()
+";
+ } else {
+ $statement = "
+SELECT issues.*,biblioitems.itemtype,items.itype, items.homebranch FROM issues
+ LEFT JOIN items USING (itemnumber)
+ LEFT JOIN biblioitems USING (biblioitemnumber)
+ WHERE date_due < now()
+";
}
- $sth->finish;
- return \@results;
+ my @bind_parameters;
+ if ( exists $params->{'minimumdays'} and exists $params->{'maximumdays'} ) {
+ $statement .= ' AND TO_DAYS( NOW() )-TO_DAYS( date_due ) BETWEEN ? and ? ';
+ push @bind_parameters, $params->{'minimumdays'}, $params->{'maximumdays'};
+ } elsif ( exists $params->{'minimumdays'} ) {
+ $statement .= ' AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) > ? ';
+ push @bind_parameters, $params->{'minimumdays'};
+ } elsif ( exists $params->{'maximumdays'} ) {
+ $statement .= ' AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ? ';
+ push @bind_parameters, $params->{'maximumdays'};
+ }
+ $statement .= 'ORDER BY borrowernumber';
+ my $sth = $dbh->prepare( $statement );
+ $sth->execute( @bind_parameters );
+ return $sth->fetchall_arrayref({});
}
+
=head2 checkoverdues
( $count, $overdueitems )=checkoverdues( $borrowernumber, $dbh );
return ( $count, \@overdueitems );
}
-=item CalcFine
+=head2 CalcFine
- ($amount, $chargename, $message, $daycounttotal, $daycount) =
- &CalcFine($itemnumber, $categorycode, $branch, $days_overdue, $description);
+ ($amount, $chargename, $daycount, $daycounttotal) =
+ &CalcFine($item, $categorycode, $branch, $days_overdue, $description, $start_date, $end_date );
Calculates the fine for a book.
reminders that a book is overdue).
-C<$itemnumber> is the book's item number.
+C<$item> is an item object (hashref).
-C<$categorycode> is the category code of the patron who currently has
+C<$categorycode> is the category code (string) of the patron who currently has
the book.
-C<$branchcode> is the library whose issuingrules govern this transaction.
+C<$branchcode> is the library (string) whose issuingrules govern this transaction.
+
+C<$days_overdue> is the number of days elapsed since the book's due date.
+ NOTE: supplying days_overdue is deprecated.
-C<$days_overdue> is the number of days elapsed since the book's due
-date.
+C<$start_date> & C<$end_date> are C4::Dates objects
+defining the date range over which to determine the fine.
+Note that if these are defined, we ignore C<$difference> and C<$dues> ,
+but retain these for backwards-comptibility with extant fines scripts.
+Fines scripts should just supply the date range over which to calculate the fine.
-C<&CalcFine> returns a list of three values:
+C<&CalcFine> returns four values:
C<$amount> is the fine owed by the patron (see above).
C<$chargename> is the chargename field from the applicable record in
the categoryitem table, whatever that is.
-C<$message> is a text message, either "First Notice", "Second Notice",
-or "Final Notice".
+C<$daycount> is the number of days between start and end dates, Calendar adjusted (where needed),
+minus any applicable grace period.
+
+C<$daycounttotal> is C<$daycount> without consideration of grace period.
+
+FIXME - What is chargename supposed to be ?
+
+FIXME: previously attempted to return C<$message> as a text message, either "First Notice", "Second Notice",
+or "Final Notice". But CalcFine never defined any value.
=cut
#'
sub CalcFine {
- my ( $item, $bortype, $branchcode, $difference , $dues ) = @_;
+ my ( $item, $bortype, $branchcode, $difference ,$dues , $start_date, $end_date ) = @_;
+ $debug and warn sprintf("CalcFine(%s, %s, %s, %s, %s, %s, %s)",
+ ($item ? '{item}' : 'UNDEF'),
+ ($bortype || 'UNDEF'),
+ ($branchcode || 'UNDEF'),
+ ($difference || 'UNDEF'),
+ ($dues || 'UNDEF'),
+ ($start_date ? ($start_date->output('iso') || 'Not a C4::Dates object') : 'UNDEF'),
+ ( $end_date ? ( $end_date->output('iso') || 'Not a C4::Dates object') : 'UNDEF')
+ );
my $dbh = C4::Context->dbh;
my $amount = 0;
- my $printout;
- # calculate how many days the patron is late
- my $countspecialday=&GetSpecialHolidays($dues,$item->{itemnumber});
- my $countrepeatableday=&GetRepeatableHolidays($dues,$item->{itemnumber},$difference);
- my $countalldayclosed = $countspecialday + $countrepeatableday;
- my $daycount = $difference - $countalldayclosed;
- # get issuingrules (fines part will be used)
- my $data = C4::Circulation::GetIssuingRule($item->{'itemtype'},$bortype,$branchcode);
- my $daycounttotal = $daycount - $data->{'firstremind'};
- if ($data->{'chargeperiod'} >0) { # if there is a rule for this bortype
- if ($data->{'firstremind'} < $daycount)
- {
- $amount = int($daycounttotal/$data->{'chargeperiod'})*$data->{'fine'};
- }
+ my $daystocharge;
+ # get issuingrules (fines part will be used)
+ my $data = C4::Circulation::GetIssuingRule($bortype, $item->{'itemtype'},$branchcode);
+ if($difference) {
+ # if $difference is supplied, the difference has already been calculated, but we still need to adjust for the calendar.
+ # use copy-pasted functions from calendar module. (deprecated -- these functions will be removed from C4::Overdues ).
+ my $countspecialday = &GetSpecialHolidays($dues,$item->{itemnumber});
+ my $countrepeatableday = &GetRepeatableHolidays($dues,$item->{itemnumber},$difference);
+ my $countalldayclosed = $countspecialday + $countrepeatableday;
+ $daystocharge = $difference - $countalldayclosed;
+ } else {
+ # if $difference is not supplied, we have C4::Dates objects giving us the date range, and we use the calendar module.
+ if(C4::Context->preference('finesCalendar') eq 'noFinesWhenClosed') {
+ my $calendar = C4::Calendar->new( branchcode => $branchcode );
+ $daystocharge = $calendar->daysBetween( $start_date, $end_date );
+ } else {
+ $daystocharge = Date_to_Days(split('-',$end_date->output('iso'))) - Date_to_Days(split('-',$start_date->output('iso')));
+ }
+ }
+ # correct for grace period.
+ my $days_minus_grace = $daystocharge - $data->{'firstremind'};
+ if ($data->{'chargeperiod'} > 0 && $days_minus_grace > 0 ) {
+ $amount = int($days_minus_grace / $data->{'chargeperiod'}) * $data->{'fine'};
} else {
# a zero (or null) chargeperiod means no charge.
- #
}
-
-# warn "Calc Fine: " . join(", ", ($item->{'itemnumber'}, $bortype, $difference , $data->{'fine'} . " * " . $daycount . " days = \$ " . $amount , "desc: $dues")) ;
- return ( $amount, $data->{'chargename'}, $printout ,$daycounttotal ,$daycount );
+ $amount = C4::Context->preference('maxFine') if(C4::Context->preference('maxFine') && ( $amount > C4::Context->preference('maxFine')));
+ return ( $amount, $data->{'chargename'}, $days_minus_grace, $daystocharge);
}
-=item GetSpecialHolidays
+=head2 GetSpecialHolidays
&GetSpecialHolidays($date_dues,$itemnumber);
return $specialdaycount;
}
-=item GetRepeatableHolidays
+=head2 GetRepeatableHolidays
&GetRepeatableHolidays($date_dues, $itemnumber, $difference,);
}
-=item GetWayFromItemnumber
+=head2 GetWayFromItemnumber
&Getwdayfromitemnumber($itemnumber);
}
-=item GetIssuesIteminfo
+=head2 GetIssuesIteminfo
&GetIssuesIteminfo($itemnumber);
}
-=item UpdateFine
+=head2 UpdateFine
&UpdateFine($itemnumber, $borrowernumber, $amount, $type, $description);
=cut
-#'
-# FIXME - This API doesn't look right: why should the caller have to
+#
+# Question: Why should the caller have to
# specify both the item number and the borrower number? A book can't
# be on loan to two different people, so the item number should be
# sufficient.
+#
+# Possible Answer: You might update a fine for a damaged item, *after* it is returned.
+#
sub UpdateFine {
my ( $itemnum, $borrowernumber, $amount, $type, $due ) = @_;
+ $debug and warn "UpdateFine($itemnum, $borrowernumber, $amount, " . ($type||'""') . ", $due) called";
my $dbh = C4::Context->dbh;
# FIXME - What exactly is this query supposed to do? It looks up an
# entry in accountlines that matches the given item and borrower
# account type has one of several values, but what does this _mean_?
# Does it look up existing fines for this item?
# FIXME - What are these various account types? ("FU", "O", "F", "M")
+ # "L" is LOST item
+ # "A" is Account Management Fee
+ # "N" is New Card
+ # "M" is Sundry
+ # "O" is Overdue ??
+ # "F" is Fine ??
+ # "FU" is Fine UPDATE??
+ # "Pay" is Payment
+ # "REF" is Cash Refund
my $sth = $dbh->prepare(
- "Select * from accountlines where itemnumber=? and
- borrowernumber=? and (accounttype='FU' or accounttype='O' or
- accounttype='F' or accounttype='M') and description like ?"
+ "SELECT * FROM accountlines
+ WHERE itemnumber=?
+ AND borrowernumber=?
+ AND accounttype IN ('FU','O','F','M')
+ AND description like ? "
);
$sth->execute( $itemnum, $borrowernumber, "%$due%" );
if ( my $data = $sth->fetchrow_hashref ) {
- # I think this if-clause deals with the case where we're updating
- # an existing fine.
- # print "in accounts ...";
- if ( $data->{'amount'} != $amount ) {
-
- # print "updating";
+ # we're updating an existing fine. Only modify if we're adding to the charge.
+ # Note that in the current implementation, you cannot pay against an accruing fine
+ # (i.e. , of accounttype 'FU'). Doing so will break accrual.
+ if ( $data->{'amount'} != $amount ) {
my $diff = $amount - $data->{'amount'};
+ $diff = 0 if ( $data->{amount} > $amount);
my $out = $data->{'amountoutstanding'} + $diff;
- my $sth2 = $dbh->prepare(
- "UPDATE accountlines SET date=now(), amount=?,
- amountoutstanding=?,accounttype='FU' WHERE
- borrowernumber=? AND itemnumber=?
- AND (accounttype='FU' OR accounttype='O') AND description LIKE ?"
- );
- $sth2->execute( $amount, $out, $data->{'borrowernumber'},
- $data->{'itemnumber'}, "%$due%" );
- $sth2->finish;
- }
- else {
-
+ my $query = "
+ UPDATE accountlines
+ SET date=now(), amount=?, amountoutstanding=?,
+ lastincrement=?, accounttype='FU'
+ WHERE borrowernumber=?
+ AND itemnumber=?
+ AND accounttype IN ('FU','O')
+ AND description LIKE ?
+ LIMIT 1 ";
+ my $sth2 = $dbh->prepare($query);
+ # FIXME: BOGUS query cannot ensure uniqueness w/ LIKE %x% !!!
+ # LIMIT 1 added to prevent multiple affected lines
+ # FIXME: accountlines table needs unique key!! Possibly a combo of borrowernumber and accountline.
+ # But actually, we should just have a regular autoincrementing PK and forget accountline,
+ # including the bogus getnextaccountno function (doesn't prevent conflict on simultaneous ops).
+ # FIXME: Why only 2 account types here?
+ $debug and print STDERR "UpdateFine query: $query\n" .
+ "w/ args: $amount, $out, $diff, $data->{'borrowernumber'}, $data->{'itemnumber'}, \"\%$due\%\"\n";
+ $sth2->execute($amount, $out, $diff, $data->{'borrowernumber'}, $data->{'itemnumber'}, "%$due%");
+ } else {
# print "no update needed $data->{'amount'}"
}
- }
- else {
-
- # I think this else-clause deals with the case where we're adding
- # a new fine.
+ } else {
my $sth4 = $dbh->prepare(
"SELECT title FROM biblio LEFT JOIN items ON biblio.biblionumber=items.biblionumber WHERE items.itemnumber=?"
);
$sth4->execute($itemnum);
- my $title = $sth4->fetchrow_hashref;
- $sth4->finish;
+ my $title = $sth4->fetchrow;
# # print "not in account";
# my $sth3 = $dbh->prepare("Select max(accountno) from accountlines");
# $sth3->finish;
# $accountno[0]++;
# begin transaction
- my $nextaccntno = C4::Accounts::getnextacctno($borrowernumber);
- my $sth2 = $dbh->prepare(
- "INSERT INTO accountlines
- (borrowernumber,itemnumber,date,amount,
- description,accounttype,amountoutstanding,accountno) VALUES
- (?,?,now(),?,?,'FU',?,?)"
- );
- $sth2->execute( $borrowernumber, $itemnum, $amount,
- "$type $title->{'title'} $due",
- $amount, $nextaccntno);
- $sth2->finish;
+ my $nextaccntno = C4::Accounts::getnextacctno($borrowernumber);
+ my $desc = ($type ? "$type " : '') . "$title $due"; # FIXEDME, avoid whitespace prefix on empty $type
+ my $query = "INSERT INTO accountlines
+ (borrowernumber,itemnumber,date,amount,description,accounttype,amountoutstanding,lastincrement,accountno)
+ VALUES (?,?,now(),?,?,'FU',?,?,?)";
+ my $sth2 = $dbh->prepare($query);
+ $debug and print STDERR "UpdateFine query: $query\nw/ args: $borrowernumber, $itemnum, $amount, $desc, $amount, $amount, $nextaccntno\n";
+ $sth2->execute($borrowernumber, $itemnum, $amount, $desc, $amount, $amount, $nextaccntno);
}
# logging action
&logaction(
$borrowernumber,
"due=".$due." amount=".$amount." itemnumber=".$itemnum
) if C4::Context->preference("FinesLog");
-
- $sth->finish;
}
-=item BorType
+=head2 BorType
$borrower = &BorType($borrowernumber);
return ($data);
}
-=item ReplacementCost
+=head2 ReplacementCost
$cost = &ReplacementCost($itemnumber);
return ( $data->{'replacementprice'} );
}
-=item GetFine
+=head2 GetFine
$data->{'sum(amountoutstanding)'} = &GetFine($itemnum,$borrowernumber);
my $sth = $dbh->prepare($query);
$sth->execute( $itemnum, $borrowernumber );
my $data = $sth->fetchrow_hashref();
- $sth->finish();
- $dbh->disconnect();
return ( $data->{'sum(amountoutstanding)'} );
}
-
-
-=item GetIssuingRules
+=head2 GetIssuingRules
FIXME - This sub should be deprecated and removed.
It ignores branch and defaults.
=cut
sub GetIssuingRules {
+ warn "GetIssuingRules is deprecated: use GetIssuingRule from C4::Circulation instead.";
my ($itemtype,$categorycode)=@_;
my $dbh = C4::Context->dbh();
my $query=qq|SELECT *
my $sth = $dbh->prepare($query);
# print $query;
$sth->execute($itemtype,$categorycode);
- my ($data) = $sth->fetchrow_hashref;
- $sth->finish;
-return ($data);
-
+ return $sth->fetchrow_hashref;
}
my $sth = $dbh->prepare($query);
$sth->execute( $itemnum, $borrowernumber );
my $data = $sth->fetchrow_hashref();
- $sth->finish();
- $dbh->disconnect();
return ( $data->{'amountoutstanding'} );
}
-=item GetNextIdNotify
+=head2 GetNextIdNotify
($result) = &GetNextIdNotify($reference);
}
-=item NumberNotifyId
+=head2 NumberNotifyId
(@notify) = &NumberNotifyId($borrowernumber);
}
-=item AmountNotify
+=head2 AmountNotify
($totalnotify) = &AmountNotify($notifyid);
}
-=item GetNotifyId
+=head2 GetNotifyId
($notify_id) = &GetNotifyId($borrowernumber,$itemnumber);
}
-=item CreateItemAccountLine
+=head2 CreateItemAccountLine
() = &CreateItemAccountLine($borrowernumber,$itemnumber,$date,$amount,$description,$accounttype,$amountoutstanding,$timestamp,$notify_id,$level);
sub CreateItemAccountLine {
my ($borrowernumber,$itemnumber,$date,$amount,$description,$accounttype,$amountoutstanding,$timestamp,$notify_id,$level)=@_;
my $dbh = C4::Context->dbh;
- my $nextaccntno = getnextacctno($borrowernumber);
+ my $nextaccntno = C4::Accounts::getnextacctno($borrowernumber);
my $query= "INSERT into accountlines
(borrowernumber,accountno,itemnumber,date,amount,description,accounttype,amountoutstanding,timestamp,notify_id,notify_level)
VALUES
$sth->finish;
}
-=item UpdateAccountLines
+=head2 UpdateAccountLines
() = &UpdateAccountLines($notify_id,$notify_level,$borrowernumber,$itemnumber);
}
-=item GetItems
+=head2 GetItems
($items) = &GetItems($itemnumber);
return($items);
}
-=item GetOverdueDelays
+=head2 GetOverdueDelays
(@delays) = &GetOverdueDelays($categorycode);
return(@delays);
}
-=item CheckAccountLineLevelInfo
+=head2 GetBranchcodesWithOverdueRules
+
+=over 4
+
+my @branchcodes = C4::Overdues::GetBranchcodesWithOverdueRules()
+
+returns a list of branch codes for branches with overdue rules defined.
+
+=back
+
+=cut
+
+sub GetBranchcodesWithOverdueRules {
+ my $dbh = C4::Context->dbh;
+ my $rqoverduebranches = $dbh->prepare("SELECT DISTINCT branchcode FROM overduerules WHERE delay1 IS NOT NULL AND branchcode <> ''");
+ $rqoverduebranches->execute;
+ my @branches = map { shift @$_ } @{ $rqoverduebranches->fetchall_arrayref };
+ $rqoverduebranches->finish;
+ return @branches;
+}
+
+=head2 CheckAccountLineLevelInfo
($exist) = &CheckAccountLineLevelInfo($borrowernumber,$itemnumber,$accounttype,notify_level);
return($exist);
}
-=item GetOverduerules
+=head2 GetOverduerules
($overduerules) = &GetOverduerules($categorycode);
C<$category> contains the borrower categorycode
C<$notify_level> contains the notify level
-=cut
+=cut
sub GetOverduerules{
my($category,$notify_level) = @_;
}
-=item CheckBorrowerDebarred
+=head2 CheckBorrowerDebarred
($debarredstatus) = &CheckBorrowerDebarred($borrowernumber);
}
}
-=item UpdateBorrowerDebarred
+=head2 UpdateBorrowerDebarred
($borrowerstatut) = &UpdateBorrowerDebarred($borrowernumber);
return 1;
}
-=item CheckExistantNotifyid
+=head2 CheckExistantNotifyid
($exist) = &CheckExistantNotifyid($borrowernumber,$itemnumber,$accounttype,$notify_id);
}
}
-=item CheckAccountLineItemInfo
+=head2 CheckAccountLineItemInfo
($exist) = &CheckAccountLineItemInfo($borrowernumber,$itemnumber,$accounttype,$notify_id);
1;
__END__
-=back
-
=head1 AUTHOR
Koha Developement team <info@koha.org>
projects / koha_fer / blobdiff