Bug 21738: make call of CanBookBeReserved more safe
[koha.git] / C4 / Accounts.pm
index 17f7e69..d2c597a 100644 (file)
@@ -23,30 +23,25 @@ use strict;
 use C4::Context;
 use C4::Stats;
 use C4::Members;
-use C4::Circulation qw(ReturnLostItem);
 use C4::Log qw(logaction);
 use Koha::Account;
 use Koha::Account::Lines;
+use Koha::Account::Offsets;
+use Koha::Items;
 
 use Data::Dumper qw(Dumper);
 
 use vars qw(@ISA @EXPORT);
 
 BEGIN {
-       require Exporter;
-       @ISA    = qw(Exporter);
-       @EXPORT = qw(
-               &manualinvoice
-               &getnextacctno
-               &getcharges
-               &ModNote
-               &getcredits
-               &getrefunds
-               &chargelostitem
-               &ReversePayment
-        &WriteOffFee
-        &purge_zero_balance_fees
-       );
+    require Exporter;
+    @ISA    = qw(Exporter);
+    @EXPORT = qw(
+      &manualinvoice
+      &getnextacctno
+      &chargelostitem
+      &purge_zero_balance_fees
+    );
 }
 
 =head1 NAME
@@ -88,79 +83,131 @@ sub getnextacctno {
     return ($sth->fetchrow || 1);
 }
 
-=head2 fixaccounts (removed)
+=head2 chargelostitem
 
-  &fixaccounts($accountlines_id, $borrowernumber, $accountnumber, $amount);
+In a default install of Koha the following lost values are set
+1 = Lost
+2 = Long overdue
+3 = Lost and paid for
 
-#'
-# FIXME - I don't understand what this function does.
-sub fixaccounts {
-    my ( $accountlines_id, $borrowernumber, $accountno, $amount ) = @_;
-    my $dbh = C4::Context->dbh;
-    my $sth = $dbh->prepare(
-        "SELECT * FROM accountlines WHERE accountlines_id=?"
-    );
-    $sth->execute( $accountlines_id );
-    my $data = $sth->fetchrow_hashref;
-
-    # FIXME - Error-checking
-    my $diff        = $amount - $data->{'amount'};
-    my $outstanding = $data->{'amountoutstanding'} + $diff;
-    $sth->finish;
-
-    $dbh->do(<<EOT);
-        UPDATE  accountlines
-        SET     amount = '$amount',
-                amountoutstanding = '$outstanding'
-        WHERE   accountlines_id = $accountlines_id
-EOT
-       # FIXME: exceedingly bad form.  Use prepare with placholders ("?") in query and execute args.
-}
+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?
 
 =cut
 
 sub chargelostitem{
-# 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 ($borrowernumber, $itemnumber, $amount, $description) = @_;
+    my $itype = Koha::ItemTypes->find({ itemtype => Koha::Items->find($itemnumber)->effective_itemtype() });
+    my $replacementprice = $amount;
+    my $defaultreplacecost = $itype->defaultreplacecost;
+    my $processfee = $itype->processfee;
+    my $usedefaultreplacementcost = C4::Context->preference("useDefaultReplacementCost");
+    my $processingfeenote = C4::Context->preference("ProcessingFeeNote");
+    if ($usedefaultreplacementcost && $amount == 0 && $defaultreplacecost){
+        $replacementprice = $defaultreplacecost;
+    }
+
+    my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
 
     # 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($borrowernumber,$itemnumber);
-    my $existing_charge_hashref=$sth1->fetchrow_hashref();
+    # FIXME this should be more exact
+    #       there is no reason a user can't lose an item, find and return it, and lost it again
+    my $existing_charges = Koha::Account::Lines->search(
+        {
+            borrowernumber => $borrowernumber,
+            itemnumber     => $itemnumber,
+            accounttype    => 'L',
+        }
+    )->count();
 
     # OK, they haven't
-    unless ($existing_charge_hashref) {
-        my $manager_id = 0;
-        $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
-        # 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($borrowernumber);
-        my $sth2=$dbh->prepare("INSERT INTO accountlines
-        (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding,itemnumber,manager_id)
-        VALUES (?,?,now(),?,?,'L',?,?,?)");
-        $sth2->execute($borrowernumber,$accountno,$amount,
-        $description,$amount,$itemnumber,$manager_id);
-
-        if ( C4::Context->preference("FinesLog") ) {
-            logaction("FINES", 'CREATE', $borrowernumber, Dumper({
-                action            => 'create_fee',
-                borrowernumber    => $borrowernumber,
-                accountno         => $accountno,
-                amount            => $amount,
-                amountoutstanding => $amount,
-                description       => $description,
-                accounttype       => 'L',
-                itemnumber        => $itemnumber,
-                manager_id        => $manager_id,
-            }));
+    unless ($existing_charges) {
+        my $checkout = Koha::Checkouts->find({ itemnumber => $itemnumber });
+        my $issue_id = $checkout ? $checkout->issue_id : undef;
+        #add processing fee
+        if ($processfee && $processfee > 0){
+            my $accountline = Koha::Account::Line->new(
+                {
+                    borrowernumber    => $borrowernumber,
+                    issue_id          => $issue_id,
+                    accountno         => getnextacctno($borrowernumber),
+                    date              => \'NOW()',
+                    amount            => $processfee,
+                    description       => $description,
+                    accounttype       => 'PF',
+                    amountoutstanding => $processfee,
+                    itemnumber        => $itemnumber,
+                    note              => $processingfeenote,
+                    manager_id        => C4::Context->userenv ? C4::Context->userenv->{'number'} : 0,
+                    branchcode        => $branchcode,
+                }
+            )->store();
+
+            my $account_offset = Koha::Account::Offset->new(
+                {
+                    debit_id => $accountline->id,
+                    type     => 'Processing Fee',
+                    amount   => $accountline->amount,
+                }
+            )->store();
+
+            if ( C4::Context->preference("FinesLog") ) {
+                logaction("FINES", 'CREATE',$borrowernumber,Dumper({
+                    action            => 'create_fee',
+                    borrowernumber    => $accountline->borrowernumber,,
+                    accountno         => $accountline->accountno,
+                    amount            => $accountline->amount,
+                    description       => $accountline->description,
+                    accounttype       => $accountline->accounttype,
+                    amountoutstanding => $accountline->amountoutstanding,
+                    note              => $accountline->note,
+                    itemnumber        => $accountline->itemnumber,
+                    manager_id        => $accountline->manager_id,
+                }));
+            }
+        }
+        #add replace cost
+        if ($replacementprice > 0){
+            my $accountline = Koha::Account::Line->new(
+                {
+                    borrowernumber    => $borrowernumber,
+                    issue_id          => $issue_id,
+                    accountno         => getnextacctno($borrowernumber),
+                    date              => \'NOW()',
+                    amount            => $replacementprice,
+                    description       => $description,
+                    accounttype       => 'L',
+                    amountoutstanding => $replacementprice,
+                    itemnumber        => $itemnumber,
+                    manager_id        => C4::Context->userenv ? C4::Context->userenv->{'number'} : 0,
+                    branchcode        => $branchcode,
+                }
+            )->store();
+
+            my $account_offset = Koha::Account::Offset->new(
+                {
+                    debit_id => $accountline->id,
+                    type     => 'Lost Item',
+                    amount   => $accountline->amount,
+                }
+            )->store();
+
+            if ( C4::Context->preference("FinesLog") ) {
+                logaction("FINES", 'CREATE',$borrowernumber,Dumper({
+                    action            => 'create_fee',
+                    borrowernumber    => $accountline->borrowernumber,,
+                    accountno         => $accountline->accountno,
+                    amount            => $accountline->amount,
+                    description       => $accountline->description,
+                    accounttype       => $accountline->accounttype,
+                    amountoutstanding => $accountline->amountoutstanding,
+                    note              => $accountline->note,
+                    itemnumber        => $accountline->itemnumber,
+                    manager_id        => $accountline->manager_id,
+                }));
+            }
         }
-
     }
 }
 
@@ -180,7 +227,7 @@ should be the empty string.
 
 #'
 # FIXME: In Koha 3.0 , the only account adjustment 'types' passed to this function
-# are :  
+# are:
 #              'C' = CREDIT
 #              'FOR' = FORGIVEN  (Formerly 'F', but 'F' is taken to mean 'FINE' elsewhere)
 #              'N' = New Card fee
@@ -195,35 +242,35 @@ sub manualinvoice {
     my $manager_id = 0;
     $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
     my $dbh      = C4::Context->dbh;
-    my $notifyid = 0;
     my $insert;
     my $accountno  = getnextacctno($borrowernumber);
     my $amountleft = $amount;
 
-    if (   ( $type eq 'L' )
-        or ( $type eq 'F' )
-        or ( $type eq 'A' )
-        or ( $type eq 'N' )
-        or ( $type eq 'M' ) )
-    {
-        $notifyid = 1;
-    }
+    my $branchcode = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
 
-    if ( $itemnum ) {
-        $desc .= ' ' . $itemnum;
-        my $sth = $dbh->prepare(
-            'INSERT INTO  accountlines
-                        (borrowernumber, accountno, date, amount, description, accounttype, amountoutstanding, itemnumber,notify_id, note, manager_id)
-        VALUES (?, ?, now(), ?,?, ?,?,?,?,?,?)');
-     $sth->execute($borrowernumber, $accountno, $amount, $desc, $type, $amountleft, $itemnum,$notifyid, $note, $manager_id) || return $sth->errstr;
-  } else {
-    my $sth=$dbh->prepare("INSERT INTO  accountlines
-            (borrowernumber, accountno, date, amount, description, accounttype, amountoutstanding,notify_id, note, manager_id)
-            VALUES (?, ?, now(), ?, ?, ?, ?,?,?,?)"
-        );
-        $sth->execute( $borrowernumber, $accountno, $amount, $desc, $type,
-            $amountleft, $notifyid, $note, $manager_id );
-    }
+    my $accountline = Koha::Account::Line->new(
+        {
+            borrowernumber    => $borrowernumber,
+            accountno         => $accountno,
+            date              => \'NOW()',
+            amount            => $amount,
+            description       => $desc,
+            accounttype       => $type,
+            amountoutstanding => $amountleft,
+            itemnumber        => $itemnum || undef,
+            note              => $note,
+            manager_id        => $manager_id,
+            branchcode        => $branchcode,
+        }
+    )->store();
+
+    my $account_offset = Koha::Account::Offset->new(
+        {
+            debit_id => $accountline->id,
+            type     => 'Manual Debit',
+            amount   => $amount,
+        }
+    )->store();
 
     if ( C4::Context->preference("FinesLog") ) {
         logaction("FINES", 'CREATE',$borrowernumber,Dumper({
@@ -234,7 +281,6 @@ sub manualinvoice {
             description       => $desc,
             accounttype       => $type,
             amountoutstanding => $amountleft,
-            notify_id         => $notifyid,
             note              => $note,
             itemnumber        => $itemnum,
             manager_id        => $manager_id,
@@ -244,142 +290,6 @@ sub manualinvoice {
     return 0;
 }
 
-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 ModNote {
-    my ( $accountlines_id, $note ) = @_;
-    my $dbh = C4::Context->dbh;
-    my $sth = $dbh->prepare('UPDATE accountlines SET note = ? WHERE accountlines_id = ?');
-    $sth->execute( $note, $accountlines_id );
-}
-
-sub getcredits {
-       my ( $date, $date2 ) = @_;
-       my $dbh = C4::Context->dbh;
-       my $sth = $dbh->prepare(
-                               "SELECT * FROM accountlines,borrowers
-      WHERE amount < 0 AND accounttype not like '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);
-}
-
-sub ReversePayment {
-    my ( $accountlines_id ) = @_;
-    my $dbh = C4::Context->dbh;
-
-    my $sth = $dbh->prepare('SELECT * FROM accountlines WHERE accountlines_id = ?');
-    $sth->execute( $accountlines_id );
-    my $row = $sth->fetchrow_hashref();
-    my $amount_outstanding = $row->{'amountoutstanding'};
-
-    if ( $amount_outstanding <= 0 ) {
-        $sth = $dbh->prepare('UPDATE accountlines SET amountoutstanding = amount * -1, description = CONCAT( description, " Reversed -" ) WHERE accountlines_id = ?');
-        $sth->execute( $accountlines_id );
-    } else {
-        $sth = $dbh->prepare('UPDATE accountlines SET amountoutstanding = 0, description = CONCAT( description, " Reversed -" ) WHERE accountlines_id = ?');
-        $sth->execute( $accountlines_id );
-    }
-
-    if ( C4::Context->preference("FinesLog") ) {
-        my $manager_id = 0;
-        $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
-
-        if ( $amount_outstanding <= 0 ) {
-            $row->{'amountoutstanding'} *= -1;
-        } else {
-            $row->{'amountoutstanding'} = '0';
-        }
-        $row->{'description'} .= ' Reversed -';
-        logaction("FINES", 'MODIFY', $row->{'borrowernumber'}, Dumper({
-            action                => 'reverse_fee_payment',
-            borrowernumber        => $row->{'borrowernumber'},
-            old_amountoutstanding => $row->{'amountoutstanding'},
-            new_amountoutstanding => 0 - $amount_outstanding,,
-            accountlines_id       => $row->{'accountlines_id'},
-            accountno             => $row->{'accountno'},
-            manager_id            => $manager_id,
-        }));
-
-    }
-
-}
-
-=head2 WriteOffFee
-
-  WriteOffFee( $borrowernumber, $accountline_id, $itemnum, $accounttype, $amount, $branch, $payment_note );
-
-Write off a fine for a patron.
-C<$borrowernumber> is the patron's borrower number.
-C<$accountline_id> is the accountline_id of the fee to write off.
-C<$itemnum> is the itemnumber of of item whose fine is being written off.
-C<$accounttype> is the account type of the fine being written off.
-C<$amount> is a floating-point number, giving the amount that is being written off.
-C<$branch> is the branchcode of the library where the writeoff occurred.
-C<$payment_note> is the note to attach to this payment
-
-=cut
-
-sub WriteOffFee {
-    my ( $borrowernumber, $accountlines_id, $itemnum, $accounttype, $amount, $branch, $payment_note ) = @_;
-
-    my $line = Koha::Account::Lines->find($accountlines_id);
-    return Koha::Account->new( { patron_id => $borrowernumber } )->pay(
-        {
-            amount     => $amount,
-            lines      => [$line],
-            type       => 'writeoff',
-            note       => $payment_note,
-            library_id => $branch,
-        }
-    );
-}
-
 =head2 purge_zero_balance_fees
 
   purge_zero_balance_fees( $days );
@@ -402,9 +312,18 @@ sub purge_zero_balance_fees {
     my $dbh = C4::Context->dbh;
     my $sth = $dbh->prepare(
         q{
-            DELETE FROM accountlines
-            WHERE date < date_sub(curdate(), INTERVAL ? DAY)
-              AND ( amountoutstanding = 0 or amountoutstanding IS NULL );
+            DELETE a1 FROM accountlines a1
+
+            LEFT JOIN account_offsets credit_offset ON ( a1.accountlines_id = credit_offset.credit_id )
+            LEFT JOIN accountlines a2 ON ( credit_offset.debit_id = a2.accountlines_id )
+
+            LEFT JOIN account_offsets debit_offset ON ( a1.accountlines_id = debit_offset.debit_id )
+            LEFT JOIN accountlines a3 ON ( debit_offset.credit_id = a3.accountlines_id )
+
+            WHERE a1.date < date_sub(curdate(), INTERVAL ? DAY)
+              AND ( a1.amountoutstanding = 0 OR a1.amountoutstanding IS NULL )
+              AND ( a2.amountoutstanding = 0 OR a2.amountoutstanding IS NULL )
+              AND ( a3.amountoutstanding = 0 OR a3.amountoutstanding IS NULL )
         }
     );
     $sth->execute($days) or die $dbh->errstr;