-package C4::Accounts2; #asummes C4/Accounts2
+package C4::Accounts2; #assumes C4/Accounts2
-#requires DBI.pm to be installed
-#uses DBD:Pg
+
+# Copyright 2000-2002 Katipo Communications
+#
+# This file is part of Koha.
+#
+# Koha is free software; you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 2 of the License, or (at your option) any later
+# version.
+#
+# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
+# Suite 330, Boston, MA 02111-1307 USA
use strict;
require Exporter;
use C4::Database;
use C4::Stats;
use C4::Search;
-use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
-
+use C4::Circulation::Circ2;
+use vars qw($VERSION @ISA @EXPORT);
+
# set the version for version checking
-$VERSION = 0.01;
-
+$VERSION = 0.01; # FIXME - Should probably be different from
+ # the version for C4::Accounts
+
+=head1 NAME
+
+C4::Accounts - Functions for dealing with Koha accounts
+
+=head1 SYNOPSIS
+
+ use C4::Accounts;
+
+=head1 DESCRIPTION
+
+The functions in this module deal with the monetary aspect of Koha,
+including looking up and modifying the amount of money owed by a
+patron.
+
+=head1 FUNCTIONS
+
+=over 2
+
+=cut
+
@ISA = qw(Exporter);
-@EXPORT = qw(&recordpayment &fixaccounts &makepayment);
-%EXPORT_TAGS = ( ); # eg: TAG => [ qw!name1 name2! ],
-
-# your exported package globals go here,
-# as well as any optionally exported functions
-
-@EXPORT_OK = qw($Var1 %Hashit);
-
-
-# non-exported package globals go here
-use vars qw(@more $stuff);
-
-# initalize package globals, first exported ones
-
-my $Var1 = '';
-my %Hashit = ();
-
-# then the others (which are still accessible as $Some::Module::stuff)
-my $stuff = '';
-my @more = ();
-
-# all file-scoped lexicals must be created before
-# the functions below that use them.
-
-# file-private lexicals go here
-my $priv_var = '';
-my %secret_hash = ();
-
-# here's a file-private function as a closure,
-# callable as &$priv_func; it cannot be prototyped.
-my $priv_func = sub {
- # stuff goes here.
-};
-
-# make all your functions, whether exported or not;
+@EXPORT = qw(&recordpayment &fixaccounts &makepayment &manualinvoice
+&getnextacctno);
+# FIXME - Never used
sub displayaccounts{
my ($env)=@_;
}
+=item recordpayment
+
+ &recordpayment($env, $borrowernumber, $payment);
+
+Record payment by a patron. C<$borrowernumber> is the patron's
+borrower number. C<$payment> is a floating-point number, giving the
+amount that was paid. C<$env> is a reference-to-hash;
+C<$env-E<gt>{branchcode}> is the code of the branch where payment was
+made.
+
+Amounts owed are paid off oldest first. That is, if the patron has a
+$1 fine from Feb. 1, another $1 fine from Mar. 1, and makes a payment
+of $1.50, then the oldest fine will be paid off in full, and $0.50
+will be credited to the next one.
+
+=cut
+#'
sub recordpayment{
#here we update both the accountoffsets and the account lines
my ($env,$bornumber,$data)=@_;
# begin transaction
my $nextaccntno = getnextacctno($env,$bornumber,$dbh);
# get lines with outstanding amounts to offset
- my $query = "select * from accountlines
+ my $query = "select * from accountlines
where (borrowernumber = '$bornumber') and (amountoutstanding<>0)
order by date";
my $sth = $dbh->prepare($query);
my $usth = $dbh->prepare($updquery);
$usth->execute;
$usth->finish;
- $updquery = "insert into accountoffsets
+ $updquery = "insert into accountoffsets
(borrowernumber, accountno, offsetaccount, offsetamount)
values ($bornumber,$accdata->{'accountno'},$nextaccntno,$newamtos)";
- my $usth = $dbh->prepare($updquery);
+ $usth = $dbh->prepare($updquery);
$usth->execute;
$usth->finish;
}
# create new line
- $updquery = "insert into accountlines
- (borrowernumber, accountno,date,amount,description,accounttype,amountoutstanding)
+ $updquery = "insert into accountlines
+ (borrowernumber, accountno,date,amount,description,accounttype,amountoutstanding)
values ($bornumber,$nextaccntno,now(),0-$data,'Payment,thanks',
'Pay',0-$amountleft)";
my $usth = $dbh->prepare($updquery);
$dbh->disconnect;
}
+=item makepayment
+
+ &makepayment($borrowernumber, $acctnumber, $amount, $branchcode);
+
+Records the fact that a patron has paid off the entire amount he or
+she owes.
+
+C<$borrowernumber> is the patron's borrower number. C<$acctnumber> is
+the account that was credited. C<$amount> is the amount paid (this is
+only used to record the payment. It is assumed to be equal to the
+amount owed). C<$branchcode> is the code of the branch where payment
+was made.
+
+=cut
+#'
+# FIXME - I'm not at all sure about the above, because I don't
+# understand what the acct* tables in the Koha database are for.
sub makepayment{
#here we update both the accountoffsets and the account lines
- #updated to check, if they are paying off a lost item, we return the item
+ #updated to check, if they are paying off a lost item, we return the item
# from their card, and put a note on the item record
my ($bornumber,$accountno,$amount,$user)=@_;
my $env;
$sth->execute;
my $data=$sth->fetchrow_hashref;
$sth->finish;
+ # FIXME - This prepare/execute/finish sequence could be done with
+ # $dbh->do(), no?
my $updquery="Update accountlines set amountoutstanding=0 where
borrowernumber=$bornumber and accountno=$accountno";
$sth=$dbh->prepare($updquery);
$sth->execute;
$sth->finish;
# print $updquery;
- $updquery = "insert into accountoffsets
+ $updquery = "insert into accountoffsets
(borrowernumber, accountno, offsetaccount, offsetamount)
values ($bornumber,$accountno,$nextaccntno,$newamtos)";
my $usth = $dbh->prepare($updquery);
$usth->execute;
- $usth->finish;
+ $usth->finish;
# create new line
my $payment=0-$amount;
- $updquery = "insert into accountlines
- (borrowernumber, accountno,date,amount,description,accounttype,amountoutstanding)
+ $updquery = "insert into accountlines
+ (borrowernumber, accountno,date,amount,description,accounttype,amountoutstanding)
values ($bornumber,$nextaccntno,now(),$payment,'Payment,thanks - $user', 'Pay',0)";
- my $usth = $dbh->prepare($updquery);
+ $usth = $dbh->prepare($updquery);
$usth->execute;
$usth->finish;
+ # FIXME - The second argument to &UpdateStats is supposed to be the
+ # branch code.
UpdateStats($env,$user,'payment',$amount,'','','',$bornumber);
$sth->finish;
$dbh->disconnect;
}
}
+=item getnextacctno
+
+ $nextacct = &getnextacctno($env, $borrowernumber, $dbh);
+
+Returns the next unused account number for the patron with the given
+borrower number.
+
+C<$dbh> is a DBI::db handle to the Koha database.
+
+C<$env> is ignored.
+
+=cut
+#'
+# FIXME - Okay, so what does the above actually _mean_?
sub getnextacctno {
my ($env,$bornumber,$dbh)=@_;
my $nextaccntno = 1;
return($nextaccntno);
}
+=item fixaccounts
+
+ &fixaccounts($borrowernumber, $accountnumber, $amount);
+
+=cut
+#'
+# FIXME - I don't understand what this function does.
sub fixaccounts {
my ($borrowernumber,$accountno,$amount)=@_;
my $dbh=C4Connect;
my $sth=$dbh->prepare($query);
$sth->execute;
my $data=$sth->fetchrow_hashref;
+ # FIXME - Error-checking
my $diff=$amount-$data->{'amount'};
my $outstanding=$data->{'amountoutstanding'}+$diff;
$sth->finish;
$dbh->disconnect;
}
+# FIXME - Never used, but not exported, either.
sub returnlost{
my ($borrnum,$itemnum)=@_;
my $dbh=C4Connect;
my $sth=$dbh->prepare($upiss);
$sth->execute;
$sth->finish;
- my $date='2001-04-18';
+ my @datearr = localtime(time);
+ my $date = (1900+$datearr[5])."-".($datearr[4]+1)."-".$datearr[3];
my $bor="$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
- my $upitem="Update items set itemnotes='Paid for by $bor $date' where itemnumber='$itemnum'";
+ my $upitem="Update items set paidfor='Paid for by $bor $date' where itemnumber='$itemnum'";
$sth=$dbh->prepare($upitem);
$sth->execute;
$sth->finish;
$dbh->disconnect;
}
+=item manualinvoice
+
+ &manualinvoice($borrowernumber, $itemnumber, $description, $type,
+ $amount, $user);
+
+C<$borrowernumber> is the patron's borrower number.
+C<$description> is a description of the transaction.
+C<$type> may be one of C<CS>, C<CB>, C<CW>, C<CF>, C<CL>, C<N>, C<L>,
+or C<REF>.
+C<$itemnumber> is the item involved, if pertinent; otherwise, it
+should be the empty string.
+
+=cut
+#'
+# FIXME - Okay, so what does this function do, really?
+sub manualinvoice{
+ my ($bornum,$itemnum,$desc,$type,$amount,$user)=@_;
+ my $dbh=C4Connect;
+ my $insert;
+ $itemnum=~ s/ //g;
+ my %env;
+ my $accountno=getnextacctno('',$bornum,$dbh);
+ my $amountleft=$amount;
+
+ if ($type eq 'CS' || $type eq 'CB' || $type eq 'CW'
+ || $type eq 'CF' || $type eq 'CL'){
+ my $amount2=$amount*-1; # FIXME - $amount2 = -$amount
+ $amountleft=fixcredit(\%env,$bornum,$amount2,$itemnum,$type,$user);
+ }
+ if ($type eq 'N'){
+ $desc.="New Card";
+ }
+ if ($type eq 'L' && $desc eq ''){
+ $desc="Lost Item";
+ }
+ if ($type eq 'REF'){
+ $amountleft=refund('',$bornum,$amount);
+ }
+ if ($itemnum ne ''){
+ my $sth=$dbh->prepare("Select * from items where barcode='$itemnum'");
+ $sth->execute;
+ my $data=$sth->fetchrow_hashref;
+ $sth->finish;
+ $desc.=" ".$itemnum;
+ $desc=$dbh->quote($desc);
+ $insert="insert into accountlines (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding,itemnumber)
+ values ($bornum,$accountno,now(),'$amount',$desc,'$type','$amountleft','$data->{'itemnumber'}')";
+ } else {
+ $desc=$dbh->quote($desc);
+ $insert="insert into accountlines (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
+ values ($bornum,$accountno,now(),'$amount',$desc,'$type','$amountleft')";
+ }
+
+ my $sth=$dbh->prepare($insert);
+ $sth->execute;
+ $sth->finish;
+
+ $dbh->disconnect;
+}
+
+# fixcredit
+# $amountleft = &fixcredit($env, $bornumber, $data, $barcode, $type, $user);
+#
+# This function is only used internally.
+# FIXME - Figure out what this function does, and write it down.
+sub fixcredit{
+ #here we update both the accountoffsets and the account lines
+ my ($env,$bornumber,$data,$barcode,$type,$user)=@_;
+ my $dbh=C4Connect;
+ my $updquery = "";
+ my $newamtos = 0;
+ my $accdata = "";
+ my $amountleft = $data;
+ if ($barcode ne ''){
+ my $item=getiteminformation($env,'',$barcode);
+ my $nextaccntno = getnextacctno($env,$bornumber,$dbh);
+ my $query="Select * from accountlines where (borrowernumber='$bornumber'
+ and itemnumber='$item->{'itemnumber'}' and amountoutstanding > 0)";
+ if ($type eq 'CL'){
+ $query.=" and (accounttype = 'L' or accounttype = 'Rep')";
+ } elsif ($type eq 'CF'){
+ $query.=" and (accounttype = 'F' or accounttype = 'FU' or
+ accounttype='Res' or accounttype='Rent')";
+ } elsif ($type eq 'CB'){
+ $query.=" and accounttype='A'";
+ }
+# print $query;
+ my $sth=$dbh->prepare($query);
+ $sth->execute;
+ $accdata=$sth->fetchrow_hashref;
+ $sth->finish;
+ if ($accdata->{'amountoutstanding'} < $amountleft) {
+ $newamtos = 0;
+ $amountleft = $amountleft - $accdata->{'amountoutstanding'};
+ } else {
+ $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
+ $amountleft = 0;
+ }
+ my $thisacct = $accdata->{accountno};
+ my $updquery = "update accountlines set amountoutstanding= '$newamtos'
+ where (borrowernumber = '$bornumber') and (accountno='$thisacct')";
+ my $usth = $dbh->prepare($updquery);
+ $usth->execute;
+ $usth->finish;
+ $updquery = "insert into accountoffsets
+ (borrowernumber, accountno, offsetaccount, offsetamount)
+ values ($bornumber,$accdata->{'accountno'},$nextaccntno,$newamtos)";
+ $usth = $dbh->prepare($updquery);
+ $usth->execute;
+ $usth->finish;
+ }
+ # begin transaction
+ my $nextaccntno = getnextacctno($env,$bornumber,$dbh);
+ # get lines with outstanding amounts to offset
+ my $query = "select * from accountlines
+ where (borrowernumber = '$bornumber') and (amountoutstanding >0)
+ order by date";
+ my $sth = $dbh->prepare($query);
+ $sth->execute;
+# print $query;
+ # offset transactions
+ while (($accdata=$sth->fetchrow_hashref) and ($amountleft>0)){
+ if ($accdata->{'amountoutstanding'} < $amountleft) {
+ $newamtos = 0;
+ $amountleft = $amountleft - $accdata->{'amountoutstanding'};
+ } else {
+ $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
+ $amountleft = 0;
+ }
+ my $thisacct = $accdata->{accountno};
+ $updquery = "update accountlines set amountoutstanding= '$newamtos'
+ where (borrowernumber = '$bornumber') and (accountno='$thisacct')";
+ my $usth = $dbh->prepare($updquery);
+ $usth->execute;
+ $usth->finish;
+ $updquery = "insert into accountoffsets
+ (borrowernumber, accountno, offsetaccount, offsetamount)
+ values ($bornumber,$accdata->{'accountno'},$nextaccntno,$newamtos)";
+ $usth = $dbh->prepare($updquery);
+ $usth->execute;
+ $usth->finish;
+ }
+ $sth->finish;
+ $dbh->disconnect;
+ $env->{'branch'}=$user;
+ $type="Credit ".$type;
+ UpdateStats($env,$user,$type,$data,$user,'','',$bornumber);
+ $amountleft*=-1;
+ return($amountleft);
+
+}
+
+# FIXME - Figure out what this function does, and write it down.
+sub refund{
+ #here we update both the accountoffsets and the account lines
+ my ($env,$bornumber,$data)=@_;
+ my $dbh=C4Connect;
+ my $updquery = "";
+ my $newamtos = 0;
+ my $accdata = "";
+# my $branch=$env->{'branchcode'};
+ my $amountleft = $data *-1;
+
+ # begin transaction
+ my $nextaccntno = getnextacctno($env,$bornumber,$dbh);
+ # get lines with outstanding amounts to offset
+ my $query = "select * from accountlines
+ where (borrowernumber = '$bornumber') and (amountoutstanding<0)
+ order by date";
+ my $sth = $dbh->prepare($query);
+ $sth->execute;
+# print $query;
+# print $amountleft;
+ # offset transactions
+ while (($accdata=$sth->fetchrow_hashref) and ($amountleft<0)){
+ if ($accdata->{'amountoutstanding'} > $amountleft) {
+ $newamtos = 0;
+ $amountleft = $amountleft - $accdata->{'amountoutstanding'};
+ } else {
+ $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
+ $amountleft = 0;
+ }
+# print $amountleft;
+ my $thisacct = $accdata->{accountno};
+ $updquery = "update accountlines set amountoutstanding= '$newamtos'
+ where (borrowernumber = '$bornumber') and (accountno='$thisacct')";
+ my $usth = $dbh->prepare($updquery);
+ $usth->execute;
+ $usth->finish;
+ $updquery = "insert into accountoffsets
+ (borrowernumber, accountno, offsetaccount, offsetamount)
+ values ($bornumber,$accdata->{'accountno'},$nextaccntno,$newamtos)";
+ $usth = $dbh->prepare($updquery);
+ $usth->execute;
+ $usth->finish;
+ }
+ $sth->finish;
+ $dbh->disconnect;
+ return($amountleft);
+}
+
END { } # module clean-up code here (global destructor)
+
+1;
+__END__
+=back
+
+=head1 SEE ALSO
+
+L<DBI(3)|DBI>
+
+=cut
projects / koha-ffzg.git / blobdiff