Bug 2696: Fine payments should show what was paid for
[koha.git] / members / pay.pl
index cefdfba..05b73e5 100755 (executable)
@@ -2,22 +2,22 @@
 
 # Copyright 2000-2002 Katipo Communications
 # Copyright 2010 BibLibre
+# Copyright 2010,2011 PTFS-Europe Ltd
 #
 # 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 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 3 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.
+# 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.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
 =head1 pay.pl
 
 
 =cut
 
-use strict;
-use warnings;
+use Modern::Perl;
 
+use URI::Escape;
 use C4::Context;
 use C4::Auth;
 use C4::Output;
-use CGI;
+use CGI qw ( -utf8 );
 use C4::Members;
 use C4::Accounts;
 use C4::Stats;
 use C4::Koha;
 use C4::Overdues;
-use C4::Branch; # GetBranches
+use C4::Members::Attributes qw(GetBorrowerAttributes);
+use Koha::Patrons;
+
+use Koha::Patron::Categories;
+use URI::Escape;
 
-my $input = new CGI;
+our $input = CGI->new;
 
-my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
-    {
-        template_name   => "members/pay.tmpl",
+my $updatecharges_permissions = $input->param('woall') ? 'writeoff' : 'remaining_permissions';
+our ( $template, $loggedinuser, $cookie ) = get_template_and_user(
+    {   template_name   => 'members/pay.tt',
         query           => $input,
-        type            => "intranet",
+        type            => 'intranet',
         authnotrequired => 0,
-        flagsrequired   => { borrowers => 1, updatecharges => 1 },
+        flagsrequired   => { borrowers => 'edit_borrowers', updatecharges => $updatecharges_permissions },
         debug           => 1,
     }
 );
 
-my $borrowernumber = $input->param('borrowernumber');
-if ( $borrowernumber eq '' ) {
+my @names = $input->param;
+
+our $borrowernumber = $input->param('borrowernumber');
+if ( !$borrowernumber ) {
     $borrowernumber = $input->param('borrowernumber0');
 }
 
 # get borrower details
-my $data = GetMember( borrowernumber => $borrowernumber );
-my $user = $input->remote_user;
+my $logged_in_user = Koha::Patrons->find( $loggedinuser ) or die "Not logged in";
+our $patron         = Koha::Patrons->find($borrowernumber);
+output_and_exit_if_error( $input, $cookie, $template, { module => 'members', logged_in_user => $logged_in_user, current_patron => $patron } );
 
-# get account details
-my $branches = GetBranches();
-my $branch   = GetBranch( $input, $branches );
+our $user = $input->remote_user;
+$user ||= q{};
 
-my @names = $input->param;
-my %inp;
-my $check = 0;
-for ( my $i = 0 ; $i < @names ; $i++ ) {
-    my $temp = $input->param( $names[$i] );
-    if ( $temp eq 'wo' ) {
-        $inp{ $names[$i] } = $temp;
-        $check = 1;
-    }
-    if ( $temp eq 'yes' ) {
-
-# FIXME : using array +4, +5, +6 is dirty. Should use arrays for each accountline
-        my $amount         = $input->param( $names[ $i + 4 ] );
-        my $borrowernumber = $input->param( $names[ $i + 5 ] );
-        my $accountno      = $input->param( $names[ $i + 6 ] );
-        makepayment( $borrowernumber, $accountno, $amount, $user, $branch );
-        $check = 2;
-    }
+our $branch = C4::Context->userenv->{'branch'};
+
+my $writeoff_item = $input->param('confirm_writeoff');
+my $paycollect    = $input->param('paycollect');
+if ($paycollect) {
+    print $input->redirect(
+        "/cgi-bin/koha/members/paycollect.pl?borrowernumber=$borrowernumber");
 }
-my $total = $input->param('total') || '';
-if ( $check == 0 ) {
-    if ( $total ne '' ) {
-        recordpayment( $borrowernumber, $total );
-    }
+my $payselected = $input->param('payselected');
+if ($payselected) {
+    payselected(@names);
+}
+
+my $writeoff_all = $input->param('woall');    # writeoff all fines
+if ($writeoff_all) {
+    writeoff_all(@names);
+} elsif ($writeoff_item) {
+    my $accountlines_id = $input->param('accountlines_id');
+    my $amount       = $input->param('amountwrittenoff');
+    my $payment_note = $input->param("payment_note");
 
-    my ( $total, $accts, $numaccts) = GetMemberAccountRecords( $borrowernumber );
-
-    my @allfile;
-    my @notify = NumberNotifyId($borrowernumber);
-
-    my $numberofnotify = scalar(@notify);
-    for ( my $j = 0 ; $j < scalar(@notify) ; $j++ ) {
-        my @loop_pay;
-        my ( $total , $accts, $numaccts) =
-          GetBorNotifyAcctRecord( $borrowernumber, $notify[$j] );
-        for ( my $i = 0 ; $i < $numaccts ; $i++ ) {
-            my %line;
-            if ( $accts->[$i]{'amountoutstanding'} != 0 ) {
-                $accts->[$i]{'amount'}            += 0.00;
-                $accts->[$i]{'amountoutstanding'} += 0.00;
-                $line{i}           = $j . "" . $i;
-                $line{itemnumber}  = $accts->[$i]{'itemnumber'};
-                $line{accounttype} = $accts->[$i]{'accounttype'};
-                $line{amount}      = sprintf( "%.2f", $accts->[$i]{'amount'} );
-                $line{amountoutstanding} =
-                  sprintf( "%.2f", $accts->[$i]{'amountoutstanding'} );
-                $line{borrowernumber} = $borrowernumber;
-                $line{accountno}      = $accts->[$i]{'accountno'};
-                $line{description}    = $accts->[$i]{'description'};
-                $line{title}          = $accts->[$i]{'title'};
-                $line{notify_id}      = $accts->[$i]{'notify_id'};
-                $line{notify_level}   = $accts->[$i]{'notify_level'};
-                $line{net_balance} = 1 if($accts->[$i]{'amountoutstanding'} > 0); # you can't pay a credit.
-                push( @loop_pay, \%line );
-            }
+    Koha::Account->new( { patron_id => $borrowernumber } )->pay(
+        {
+            amount     => $amount,
+            lines      => [ scalar Koha::Account::Lines->find($accountlines_id) ],
+            type       => 'writeoff',
+            note       => $payment_note,
+            library_id => $branch,
         }
+    );
+}
 
-        my $totalnotify = AmountNotify( $notify[$j], $borrowernumber );
-        ( $totalnotify = '0' ) if ( $totalnotify =~ /^0.00/ );
-        push @allfile,
-          {
-            'loop_pay' => \@loop_pay,
-            'notify'   => $notify[$j],
-            'total'    =>  sprintf( "%.2f",$totalnotify),
-                       
-          };
+for (@names) {
+    if (/^pay_indiv_(\d+)$/) {
+        my $line_no = $1;
+        redirect_to_paycollect( 'pay_individual', $line_no );
+    } elsif (/^wo_indiv_(\d+)$/) {
+        my $line_no = $1;
+        redirect_to_paycollect( 'writeoff_individual', $line_no );
     }
-       
-if ( $data->{'category_type'} eq 'C') {
-   my  ( $catcodes, $labels ) =  GetborCatFromCatType( 'A', 'WHERE category_type = ?' );
-   my $cnt = scalar(@$catcodes);
-   $template->param( 'CATCODE_MULTI' => 1) if $cnt > 1;
-   $template->param( 'catcode' =>    $catcodes->[0])  if $cnt == 1;
 }
-       
-$template->param( adultborrower => 1 ) if ( $data->{'category_type'} eq 'A' );
-my ($picture, $dberror) = GetPatronImage($data->{'cardnumber'});
-$template->param( picture => 1 ) if $picture;
-       
+
+$template->param(
+    finesview => 1,
+);
+
+add_accounts_to_template();
+
+output_html_with_http_headers $input, $cookie, $template->output;
+
+sub add_accounts_to_template {
+
+    my $patron = Koha::Patrons->find( $borrowernumber );
+    my $total = $patron->account->balance;
+    my $account_lines = Koha::Account::Lines->search({ borrowernumber => $borrowernumber, amountoutstanding => { '!=' => 0 } }, { order_by => ['accounttype'] });
+    my @accounts;
+    while ( my $account_line = $account_lines->next ) {
+        $account_line = $account_line->unblessed;
+        if ( $account_line->{itemnumber} ) {
+            my $item = Koha::Items->find( $account_line->{itemnumber} );
+            my $biblio = $item->biblio;
+            $account_line->{biblionumber} = $biblio->biblionumber;
+            $account_line->{title}        = $biblio->title;
+        }
+        push @accounts, $account_line;
+    }
+    borrower_add_additional_fields($patron->unblessed);
+
     $template->param(
-        allfile        => \@allfile,
-        firstname      => $data->{'firstname'},
-        surname        => $data->{'surname'},
-        borrowernumber => $borrowernumber,
-       cardnumber => $data->{'cardnumber'},
-       categorycode => $data->{'categorycode'},
-       category_type => $data->{'category_type'},
-       categoryname  => $data->{'description'},
-       address => $data->{'address'},
-       address2 => $data->{'address2'},
-       city => $data->{'city'},
-       zipcode => $data->{'zipcode'},
-       country => $data->{'country'},
-       phone => $data->{'phone'},
-       email => $data->{'email'},
-       branchcode => $data->{'branchcode'},
-       branchname => GetBranchName($data->{'branchcode'}),
-       is_child        => ($data->{'category_type'} eq 'C'),
-        total          => sprintf( "%.2f", $total )
+        patron   => $patron,
+        accounts => \@accounts,
+        total    => $total,
     );
-    output_html_with_http_headers $input, $cookie, $template->output;
+    return;
 
 }
-else {
-
-    my %inp;
-    my @name = $input->param;
-    for ( my $i = 0 ; $i < @name ; $i++ ) {
-        my $test = $input->param( $name[$i] );
-        if ( $test eq 'wo' ) {
-            my $temp = $name[$i];
-            $temp =~ s/payfine//;
-            $inp{ $name[$i] } = $temp;
+
+sub get_for_redirect {
+    my ( $name, $name_in, $money ) = @_;
+    my $s     = q{&} . $name . q{=};
+    my $value;
+    if (defined $input->param($name_in)) {
+        $value = uri_escape_utf8( scalar $input->param($name_in) );
+    }
+    if ( !defined $value ) {
+        $value = ( $money == 1 ) ? 0 : q{};
+    }
+    if ($money) {
+        $s .= sprintf '%.2f', $value;
+    } else {
+        $s .= $value;
+    }
+    return $s;
+}
+
+sub redirect_to_paycollect {
+    my ( $action, $line_no ) = @_;
+    my $redirect =
+      "/cgi-bin/koha/members/paycollect.pl?borrowernumber=$borrowernumber";
+    $redirect .= q{&};
+    $redirect .= "$action=1";
+    $redirect .= get_for_redirect( 'accounttype', "accounttype$line_no", 0 );
+    $redirect .= get_for_redirect( 'amount', "amount$line_no", 1 );
+    $redirect .=
+      get_for_redirect( 'amountoutstanding', "amountoutstanding$line_no", 1 );
+    $redirect .= get_for_redirect( 'description', "description$line_no", 0 );
+    $redirect .= get_for_redirect( 'title', "title$line_no", 0 );
+    $redirect .= get_for_redirect( 'itemnumber',   "itemnumber$line_no",   0 );
+    $redirect .= get_for_redirect( 'accountlines_id', "accountlines_id$line_no", 0 );
+    $redirect .= q{&} . 'payment_note' . q{=} . uri_escape_utf8( scalar $input->param("payment_note_$line_no") );
+    $redirect .= '&remote_user=';
+    $redirect .= $user;
+    return print $input->redirect($redirect);
+}
+
+sub writeoff_all {
+    my @params = @_;
+    my @wo_lines = grep { /^accountlines_id\d+$/ } @params;
+
+    my $borrowernumber = $input->param('borrowernumber');
+
+    for (@wo_lines) {
+        if (/(\d+)/) {
+            my $value           = $1;
+            my $amount          = $input->param("amountoutstanding$value");
+            my $accountlines_id = $input->param("accountlines_id$value");
+            my $payment_note    = $input->param("payment_note_$value");
+            Koha::Account->new( { patron_id => $borrowernumber } )->pay(
+                {
+                    amount => $amount,
+                    lines  => [ scalar Koha::Account::Lines->find($accountlines_id) ],
+                    type   => 'writeoff',
+                    note   => $payment_note,
+                    library_id => $branch,
+                }
+            );
         }
     }
-    my $borrowernumber;
-    while ( my ( $key, $value ) = each %inp ) {
-
-        my $accounttype = $input->param("accounttype$value");
-        $borrowernumber = $input->param("borrowernumber$value");
-        my $itemno    = $input->param("itemnumber$value");
-        my $amount    = $input->param("amount$value");
-        my $accountno = $input->param("accountno$value");
-        writeoff( $borrowernumber, $accountno, $itemno, $accounttype, $amount );
+
+    print $input->redirect("/cgi-bin/koha/members/boraccount.pl?borrowernumber=$borrowernumber");
+    return;
+}
+
+sub borrower_add_additional_fields {
+    my $b_ref = shift;
+
+# some borrower info is not returned in the standard call despite being assumed
+# in a number of templates. It should not be the business of this script but in lieu of
+# a revised api here it is ...
+    if ( $b_ref->{category_type} eq 'C' ) {
+        my $patron_categories = Koha::Patron::Categories->search_limited({ category_type => 'A' }, {order_by => ['categorycode']});
+        $template->param( 'CATCODE_MULTI' => 1) if $patron_categories->count > 1;
+        $template->param( 'catcode' => $patron_categories->next->categorycode )  if $patron_categories->count == 1;
+    }
+
+    if (C4::Context->preference('ExtendedPatronAttributes')) {
+        $b_ref->{extendedattributes} = GetBorrowerAttributes($borrowernumber);
+        $template->param(
+            ExtendedPatronAttributes => 1,
+        );
     }
-    $borrowernumber = $input->param('borrowernumber');
-    print $input->redirect(
-        "/cgi-bin/koha/members/boraccount.pl?borrowernumber=$borrowernumber");
+
+    return;
 }
 
-sub writeoff {
-    my ( $borrowernumber, $accountnum, $itemnum, $accounttype, $amount ) = @_;
-    my $user = $input->remote_user;
-    my $dbh  = C4::Context->dbh;
-    undef $itemnum unless $itemnum; # if no item is attached to fine, make sure to store it as a NULL
-    my $sth =
-      $dbh->prepare(
-"Update accountlines set amountoutstanding=0 where accountno=? and borrowernumber=?"
-      );
-    $sth->execute( $accountnum, $borrowernumber );
-    $sth->finish;
-    $sth = $dbh->prepare("select max(accountno) from accountlines");
-    $sth->execute;
-    my $account = $sth->fetchrow_hashref;
-    $sth->finish;
-    $account->{'max(accountno)'}++;
-    $sth = $dbh->prepare(
-"insert into accountlines (borrowernumber,accountno,itemnumber,date,amount,description,accounttype)
-                                               values (?,?,?,now(),?,'Writeoff','W')"
-    );
-    $sth->execute( $borrowernumber, $account->{'max(accountno)'},
-        $itemnum, $amount );
-    $sth->finish;
-    UpdateStats( $branch, 'writeoff', $amount, '', '', '',
-        $borrowernumber );
+sub payselected {
+    my @params = @_;
+    my $amt    = 0;
+    my @lines_to_pay;
+    foreach (@params) {
+        if (/^incl_par_(\d+)$/) {
+            my $index = $1;
+            push @lines_to_pay, scalar $input->param("accountlines_id$index");
+            $amt += $input->param("amountoutstanding$index");
+        }
+    }
+    $amt = '&amt=' . $amt;
+    my $sel = '&selected=' . join ',', @lines_to_pay;
+    my $notes = '&notes=' . join("%0A", map { scalar $input->param("payment_note_$_") } @lines_to_pay );
+    my $redirect =
+        "/cgi-bin/koha/members/paycollect.pl?borrowernumber=$borrowernumber"
+      . $amt
+      . $sel
+      . $notes;
+
+    print $input->redirect($redirect);
+    return;
 }