Polish, English NZ and German updates
[koha.git] / C4 / Accounts.pm
old mode 100755 (executable)
new mode 100644 (file)
index c03a0cd..c43741b
@@ -17,21 +17,27 @@ package C4::Accounts;
 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
 # Suite 330, Boston, MA  02111-1307 USA
 
-# $Id$
 
 use strict;
-require Exporter;
 use C4::Context;
 use C4::Stats;
 use C4::Members;
+use C4::Items;
+use C4::Circulation qw(MarkIssueReturned);
 
-#use C4::Circulation;
 use vars qw($VERSION @ISA @EXPORT);
 
-# set the version for version checking
-$VERSION = do { my @v = '$Revision$' =~ /\d+/g;
-    shift(@v) . "." . join( "_", map { sprintf "%03d", $_ } @v );
-};
+BEGIN {
+       # set the version for version checking
+       $VERSION = 3.03;
+       require Exporter;
+       @ISA    = qw(Exporter);
+       @EXPORT = qw(
+               &recordpayment &makepayment &manualinvoice
+               &getnextacctno &reconcileaccount &getcharges &getcredits
+               &getrefunds &chargelostitem
+       ); # removed &fixaccounts
+}
 
 =head1 NAME
 
@@ -49,12 +55,6 @@ patron.
 
 =head1 FUNCTIONS
 
-=cut
-
-@ISA    = qw(Exporter);
-@EXPORT = qw(&recordpayment &fixaccounts &makepayment &manualinvoice
-  &getnextacctno &reconcileaccount);
-
 =head2 recordpayment
 
   &recordpayment($borrowernumber, $payment);
@@ -73,7 +73,7 @@ will be credited to the next one.
 #'
 sub recordpayment {
 
-    #here we update both the accountoffsets and the account lines
+    #here we update the account lines
     my ( $borrowernumber, $data ) = @_;
     my $dbh        = C4::Context->dbh;
     my $newamtos   = 0;
@@ -109,13 +109,13 @@ sub recordpayment {
         );
         $usth->execute( $newamtos, $borrowernumber, $thisacct );
         $usth->finish;
-        $usth = $dbh->prepare(
-            "INSERT INTO accountoffsets
-     (borrowernumber, accountno, offsetaccount,  offsetamount)
-     VALUES (?,?,?,?)"
-        );
-        $usth->execute( $borrowernumber, $accdata->{'accountno'},
-            $nextaccntno, $newamtos );
+#        $usth = $dbh->prepare(
+#            "INSERT INTO accountoffsets
+#     (borrowernumber, accountno, offsetaccount,  offsetamount)
+#     VALUES (?,?,?,?)"
+#        );
+#        $usth->execute( $borrowernumber, $accdata->{'accountno'},
+#            $nextaccntno, $newamtos );
         $usth->finish;
     }
 
@@ -127,7 +127,7 @@ sub recordpayment {
     );
     $usth->execute( $borrowernumber, $nextaccntno, 0 - $data, 0 - $amountleft );
     $usth->finish;
-    UpdateStats( $branch, 'payment', $data, '', '', '', $borrowernumber );
+    UpdateStats( $branch, 'payment', $data, '', '', '', $borrowernumber, $nextaccntno );
     $sth->finish;
 }
 
@@ -176,12 +176,12 @@ sub makepayment {
     );
 
     #  print $updquery;
-    $dbh->do( "
-        INSERT INTO     accountoffsets
-                        (borrowernumber, accountno, offsetaccount,
-                         offsetamount)
-        VALUES          ($borrowernumber, $accountno, $nextaccntno, $newamtos)
-        " );
+#    $dbh->do( "
+#        INSERT INTO     accountoffsets
+#                        (borrowernumber, accountno, offsetaccount,
+#                         offsetamount)
+#        VALUES          ($borrowernumber, $accountno, $nextaccntno, $newamtos)
+#        " );
 
     # create new line
     my $payment = 0 - $amount;
@@ -217,29 +217,22 @@ borrower number.
 
 #'
 # FIXME - Okay, so what does the above actually _mean_?
-sub getnextacctno {
-    my ($borrowernumber) = @_;
-    my $nextaccntno      = 1;
-    my $dbh              = C4::Context->dbh;
-    my $sth              = $dbh->prepare(
-        "SELECT * FROM accountlines
-                                WHERE (borrowernumber = ?)
-                                ORDER BY accountno DESC"
+sub getnextacctno ($) {
+    my ($borrowernumber) = shift or return undef;
+    my $sth = C4::Context->dbh->prepare(
+        "SELECT accountno+1 FROM accountlines
+         WHERE    (borrowernumber = ?)
+         ORDER BY accountno DESC
+                LIMIT 1"
     );
     $sth->execute($borrowernumber);
-    if ( my $accdata = $sth->fetchrow_hashref ) {
-        $nextaccntno = $accdata->{'accountno'} + 1;
-    }
-    $sth->finish;
-    return ($nextaccntno);
+    return ($sth->fetchrow || 1);
 }
 
-=head2 fixaccounts
+=head2 fixaccounts (removed)
 
   &fixaccounts($borrowernumber, $accountnumber, $amount);
 
-=cut
-
 #'
 # FIXME - I don't understand what this function does.
 sub fixaccounts {
@@ -264,26 +257,65 @@ sub fixaccounts {
         WHERE   borrowernumber = $borrowernumber
           AND   accountno = $accountno
 EOT
+       # FIXME: exceedingly bad form.  Use prepare with placholders ("?") in query and execute args.
 }
 
-# FIXME - Never used, but not exported, either.
-sub returnlost {
+=cut
+
+sub returnlost{
     my ( $borrowernumber, $itemnum ) = @_;
-    my $dbh      = C4::Context->dbh;
+    C4::Circulation::MarkIssueReturned( $borrowernumber, $itemnum );
     my $borrower = C4::Members::GetMember( $borrowernumber, 'borrowernumber' );
-    my $sth      = $dbh->prepare(
-        "UPDATE issues SET returndate=now() WHERE
-  borrowernumber=? AND itemnumber=? AND returndate IS NULL"
-    );
-    $sth->execute( $borrowernumber, $itemnum );
-    $sth->finish;
     my @datearr = localtime(time);
-    my $date =
-      ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
-    my $bor =
-"$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
-    $sth = $dbh->prepare("UPDATE items SET paidfor=? WHERE itemnumber=?");
-    $sth->execute( "Paid for by $bor $date", $itemnum );
+    my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
+    my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
+    ModItem({ paidfor =>  "Paid for by $bor $date" }, undef, $itemnum);
+}
+
+
+sub chargelostitem{
+# http://wiki.koha.org/doku.php?id=en:development:kohastatuses
+# lost ==1 Lost, lost==2 longoverdue, lost==3 lost and paid for
+# FIXME: itemlost should be set to 3 after payment is made, should be a warning to the interface that
+# a charge has been added
+# FIXME : if no replacement price, borrower just doesn't get charged?
+   
+    my $dbh = C4::Context->dbh();
+    my ($itemnumber) = @_;
+    my $sth=$dbh->prepare("SELECT * FROM issues, items WHERE issues.itemnumber=items.itemnumber and  issues.itemnumber=?");
+    $sth->execute($itemnumber);
+    my $issues=$sth->fetchrow_hashref();
+
+    # if a borrower lost the item, add a replacement cost to the their record
+    if ( $issues->{borrowernumber} ){
+
+        # first make sure the borrower hasn't already been charged for this item
+        my $sth1=$dbh->prepare("SELECT * from accountlines
+        WHERE borrowernumber=? AND itemnumber=? and accounttype='L'");
+        $sth1->execute($issues->{'borrowernumber'},$itemnumber);
+        my $existing_charge_hashref=$sth1->fetchrow_hashref();
+
+        # OK, they haven't
+        unless ($existing_charge_hashref) {
+            # This item is on issue ... add replacement cost to the borrower's record and mark it returned
+            #  Note that we add this to the account even if there's no replacement price, allowing some other
+            #  process (or person) to update it, since we don't handle any defaults for replacement prices.
+            my $accountno = getnextacctno($issues->{'borrowernumber'});
+            my $sth2=$dbh->prepare("INSERT INTO accountlines
+            (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding,itemnumber)
+            VALUES (?,?,now(),?,?,'L',?,?)");
+            $sth2->execute($issues->{'borrowernumber'},$accountno,$issues->{'replacementprice'},
+            "Lost Item $issues->{'title'} $issues->{'barcode'}",
+            $issues->{'replacementprice'},$itemnumber);
+            $sth2->finish;
+        # FIXME: Log this ?
+        }
+        #FIXME : Should probably have a way to distinguish this from an item that really was returned.
+        warn " $issues->{'borrowernumber'}  /  $itemnumber ";
+        C4::Circulation::MarkIssueReturned($issues->{borrowernumber},$itemnumber);
+       #  Shouldn't MarkIssueReturned do this?
+        ModItem({ onloan => undef }, undef, $itemnumber);
+    }
     $sth->finish;
 }
 
@@ -302,7 +334,17 @@ should be the empty string.
 =cut
 
 #'
-# FIXME - Okay, so what does this function do, really?
+# FIXME: In Koha 3.0 , the only account adjustment 'types' passed to this function
+# are :  
+#              'C' = CREDIT
+#              'FOR' = FORGIVEN  (Formerly 'F', but 'F' is taken to mean 'FINE' elsewhere)
+#              'N' = New Card fee
+#              'F' = Fine
+#              'A' = Account Management fee
+#              'M' = Sundry
+#              'L' = Lost Item
+#
+
 sub manualinvoice {
     my ( $borrowernumber, $itemnum, $desc, $type, $amount, $user ) = @_;
     my $dbh      = C4::Context->dbh;
@@ -312,37 +354,37 @@ sub manualinvoice {
     my $accountno  = getnextacctno($borrowernumber);
     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( $borrowernumber, $amount2, $itemnum, $type, $user );
-    }
+#    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( $borrowernumber, $amount2, $itemnum, $type, $user );
+#    }
     if ( $type eq 'N' ) {
-        $desc .= "New Card";
+        $desc .= " New Card";
     }
     if ( $type eq 'F' ) {
-        $desc .= "Fine";
+        $desc .= " Fine";
     }
     if ( $type eq 'A' ) {
-        $desc .= "Account Management fee";
+        $desc .= " Account Management fee";
     }
     if ( $type eq 'M' ) {
-        $desc .= "Sundry";
+        $desc .= " Sundry";
     }
 
     if ( $type eq 'L' && $desc eq '' ) {
 
-        $desc = "Lost Item";
-    }
-    if ( $type eq 'REF' ) {
-        $desc .= "Cash Refund";
-        $amountleft = refund( '', $borrowernumber, $amount );
+        $desc = " Lost Item";
     }
+#    if ( $type eq 'REF' ) {
+#        $desc .= " Cash Refund";
+#        $amountleft = refund( '', $borrowernumber, $amount );
+#    }
     if (   ( $type eq 'L' )
         or ( $type eq 'F' )
         or ( $type eq 'A' )
@@ -370,15 +412,16 @@ sub manualinvoice {
     return 0;
 }
 
-=head2 fixcredit
+=head2 fixcredit #### DEPRECATED
 
  $amountleft = &fixcredit($borrowernumber, $data, $barcode, $type, $user);
 
  This function is only used internally, not exported.
- FIXME - Figure out what this function does, and write it down.
 
 =cut
 
+# This function is deprecated in 3.0
+
 sub fixcredit {
 
     #here we update both the accountoffsets and the account lines
@@ -481,7 +524,10 @@ sub fixcredit {
 
 =head2 refund
 
-# FIXME - Figure out what this function does, and write it down.
+#FIXME : DEPRECATED SUB
+ This subroutine tracks payments and/or credits against fines/charges
+   using the accountoffsets table, which is not used consistently in
+   Koha's fines management, and so is not used in 3.0 
 
 =cut 
 
@@ -538,12 +584,69 @@ sub refund {
     return ($amountleft);
 }
 
+sub getcharges {
+       my ( $borrowerno, $timestamp, $accountno ) = @_;
+       my $dbh        = C4::Context->dbh;
+       my $timestamp2 = $timestamp - 1;
+       my $query      = "";
+       my $sth = $dbh->prepare(
+                       "SELECT * FROM accountlines WHERE borrowernumber=? AND accountno = ?"
+          );
+       $sth->execute( $borrowerno, $accountno );
+       
+    my @results;
+    while ( my $data = $sth->fetchrow_hashref ) {
+               push @results,$data;
+       }
+    return (@results);
+}
+
+
+sub getcredits {
+       my ( $date, $date2 ) = @_;
+       my $dbh = C4::Context->dbh;
+       my $sth = $dbh->prepare(
+                               "SELECT * FROM accountlines,borrowers
+      WHERE amount < 0 AND accounttype <> 'Pay' AND accountlines.borrowernumber = borrowers.borrowernumber
+         AND timestamp >=TIMESTAMP(?) AND timestamp < TIMESTAMP(?)"
+      );  
+
+    $sth->execute( $date, $date2 );                                                                                                              
+    my @results;          
+    while ( my $data = $sth->fetchrow_hashref ) {
+               $data->{'date'} = $data->{'timestamp'};
+               push @results,$data;
+       }
+    return (@results);
+} 
+
+
+sub getrefunds {
+       my ( $date, $date2 ) = @_;
+       my $dbh = C4::Context->dbh;
+       
+       my $sth = $dbh->prepare(
+                               "SELECT *,timestamp AS datetime                                                                                      
+                  FROM accountlines,borrowers
+                  WHERE (accounttype = 'REF'
+                                         AND accountlines.borrowernumber = borrowers.borrowernumber
+                                                         AND date  >=?  AND date  <?)"
+    );
+
+    $sth->execute( $date, $date2 );
+
+    my @results;
+    while ( my $data = $sth->fetchrow_hashref ) {
+               push @results,$data;
+               
+       }
+    return (@results);
+}
 END { }    # module clean-up code here (global destructor)
 
 1;
 __END__
 
-
 =head1 SEE ALSO
 
 DBI(3)