Bug 20120: Prevent writeoffs of more than the amount owed for a fee
[koha.git] / members / pay.pl
1 #!/usr/bin/perl
2
3 # Copyright 2000-2002 Katipo Communications
4 # Copyright 2010 BibLibre
5 # Copyright 2010,2011 PTFS-Europe Ltd
6 #
7 # This file is part of Koha.
8 #
9 # Koha is free software; you can redistribute it and/or modify it
10 # under the terms of the GNU General Public License as published by
11 # the Free Software Foundation; either version 3 of the License, or
12 # (at your option) any later version.
13 #
14 # Koha is distributed in the hope that it will be useful, but
15 # WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
18 #
19 # You should have received a copy of the GNU General Public License
20 # along with Koha; if not, see <http://www.gnu.org/licenses>.
21
22 =head1 pay.pl
23
24  written 11/1/2000 by chris@katipo.oc.nz
25  part of the koha library system, script to facilitate paying off fines
26
27 =cut
28
29 use Modern::Perl;
30
31 use URI::Escape;
32 use C4::Context;
33 use C4::Auth;
34 use C4::Output;
35 use CGI qw ( -utf8 );
36 use C4::Members;
37 use C4::Accounts;
38 use C4::Stats;
39 use C4::Koha;
40 use C4::Overdues;
41 use C4::Members::Attributes qw(GetBorrowerAttributes);
42 use Koha::Patrons;
43
44 use Koha::Patron::Categories;
45 use URI::Escape;
46
47 our $input = CGI->new;
48
49 my $updatecharges_permissions = $input->param('woall') ? 'writeoff' : 'remaining_permissions';
50 our ( $template, $loggedinuser, $cookie ) = get_template_and_user(
51     {   template_name   => 'members/pay.tt',
52         query           => $input,
53         type            => 'intranet',
54         authnotrequired => 0,
55         flagsrequired   => { borrowers => 'edit_borrowers', updatecharges => $updatecharges_permissions },
56         debug           => 1,
57     }
58 );
59
60 my @names = $input->param;
61
62 our $borrowernumber = $input->param('borrowernumber');
63 if ( !$borrowernumber ) {
64     $borrowernumber = $input->param('borrowernumber0');
65 }
66
67 # get borrower details
68 my $logged_in_user = Koha::Patrons->find( $loggedinuser ) or die "Not logged in";
69 our $patron         = Koha::Patrons->find($borrowernumber);
70 output_and_exit_if_error( $input, $cookie, $template, { module => 'members', logged_in_user => $logged_in_user, current_patron => $patron } );
71
72 our $user = $input->remote_user;
73 $user ||= q{};
74
75 our $branch = C4::Context->userenv->{'branch'};
76
77 my $writeoff_item = $input->param('confirm_writeoff');
78 my $paycollect    = $input->param('paycollect');
79 if ($paycollect) {
80     print $input->redirect(
81         "/cgi-bin/koha/members/paycollect.pl?borrowernumber=$borrowernumber");
82 }
83 my $payselected = $input->param('payselected');
84 if ($payselected) {
85     payselected(@names);
86 }
87
88 my $writeoff_all = $input->param('woall');    # writeoff all fines
89 if ($writeoff_all) {
90     writeoff_all(@names);
91 } elsif ($writeoff_item) {
92     my $accountlines_id = $input->param('accountlines_id');
93     my $amount       = $input->param('amountwrittenoff');
94     my $payment_note = $input->param("payment_note");
95
96     my $accountline = Koha::Account::Lines->find( $accountlines_id );
97
98     if ( $amount > $accountline->amountoutstanding ) {
99         print $input->redirect( "/cgi-bin/koha/members/paycollect.pl?"
100               . "borrowernumber=$borrowernumber"
101               . "&amount=$amount"
102               . "&amountoutstanding=" . $accountline->amountoutstanding
103               . "&accounttype=" . $accountline->accounttype
104               . "&accountlines_id=" . $accountlines_id
105               . "&writeoff_individual=1"
106               . "&error_over=1" );
107
108     } else {
109         Koha::Account->new( { patron_id => $borrowernumber } )->pay(
110             {
111                 amount     => $amount,
112                 lines      => [ scalar Koha::Account::Lines->find($accountlines_id) ],
113                 type       => 'writeoff',
114                 note       => $payment_note,
115                 library_id => $branch,
116             }
117         );
118     }
119 }
120
121 for (@names) {
122     if (/^pay_indiv_(\d+)$/) {
123         my $line_no = $1;
124         redirect_to_paycollect( 'pay_individual', $line_no );
125     } elsif (/^wo_indiv_(\d+)$/) {
126         my $line_no = $1;
127         redirect_to_paycollect( 'writeoff_individual', $line_no );
128     }
129 }
130
131 $template->param(
132     finesview => 1,
133 );
134
135 add_accounts_to_template();
136
137 output_html_with_http_headers $input, $cookie, $template->output;
138
139 sub add_accounts_to_template {
140
141     my $patron = Koha::Patrons->find( $borrowernumber );
142     my $total = $patron->account->balance;
143     my $account_lines = Koha::Account::Lines->search({ borrowernumber => $borrowernumber, amountoutstanding => { '!=' => 0 } }, { order_by => ['accounttype'] });
144     my @accounts;
145     while ( my $account_line = $account_lines->next ) {
146         $account_line = $account_line->unblessed;
147         if ( $account_line->{itemnumber} ) {
148             my $item = Koha::Items->find( $account_line->{itemnumber} );
149             my $biblio = $item->biblio;
150             $account_line->{biblionumber} = $biblio->biblionumber;
151             $account_line->{title}        = $biblio->title;
152         }
153         push @accounts, $account_line;
154     }
155     borrower_add_additional_fields($patron->unblessed);
156
157     $template->param(
158         patron   => $patron,
159         accounts => \@accounts,
160         total    => $total,
161     );
162     return;
163
164 }
165
166 sub get_for_redirect {
167     my ( $name, $name_in, $money ) = @_;
168     my $s     = q{&} . $name . q{=};
169     my $value;
170     if (defined $input->param($name_in)) {
171         $value = uri_escape_utf8( scalar $input->param($name_in) );
172     }
173     if ( !defined $value ) {
174         $value = ( $money == 1 ) ? 0 : q{};
175     }
176     if ($money) {
177         $s .= sprintf '%.2f', $value;
178     } else {
179         $s .= $value;
180     }
181     return $s;
182 }
183
184 sub redirect_to_paycollect {
185     my ( $action, $line_no ) = @_;
186     my $redirect =
187       "/cgi-bin/koha/members/paycollect.pl?borrowernumber=$borrowernumber";
188     $redirect .= q{&};
189     $redirect .= "$action=1";
190     $redirect .= get_for_redirect( 'accounttype', "accounttype$line_no", 0 );
191     $redirect .= get_for_redirect( 'amount', "amount$line_no", 1 );
192     $redirect .=
193       get_for_redirect( 'amountoutstanding', "amountoutstanding$line_no", 1 );
194     $redirect .= get_for_redirect( 'description', "description$line_no", 0 );
195     $redirect .= get_for_redirect( 'title', "title$line_no", 0 );
196     $redirect .= get_for_redirect( 'itemnumber',   "itemnumber$line_no",   0 );
197     $redirect .= get_for_redirect( 'accountlines_id', "accountlines_id$line_no", 0 );
198     $redirect .= q{&} . 'payment_note' . q{=} . uri_escape_utf8( scalar $input->param("payment_note_$line_no") );
199     $redirect .= '&remote_user=';
200     $redirect .= $user;
201     return print $input->redirect($redirect);
202 }
203
204 sub writeoff_all {
205     my @params = @_;
206     my @wo_lines = grep { /^accountlines_id\d+$/ } @params;
207
208     my $borrowernumber = $input->param('borrowernumber');
209
210     for (@wo_lines) {
211         if (/(\d+)/) {
212             my $value           = $1;
213             my $amount          = $input->param("amountoutstanding$value");
214             my $accountlines_id = $input->param("accountlines_id$value");
215             my $payment_note    = $input->param("payment_note_$value");
216             Koha::Account->new( { patron_id => $borrowernumber } )->pay(
217                 {
218                     amount => $amount,
219                     lines  => [ scalar Koha::Account::Lines->find($accountlines_id) ],
220                     type   => 'writeoff',
221                     note   => $payment_note,
222                     library_id => $branch,
223                 }
224             );
225         }
226     }
227
228     print $input->redirect("/cgi-bin/koha/members/boraccount.pl?borrowernumber=$borrowernumber");
229     return;
230 }
231
232 sub borrower_add_additional_fields {
233     my $b_ref = shift;
234
235 # some borrower info is not returned in the standard call despite being assumed
236 # in a number of templates. It should not be the business of this script but in lieu of
237 # a revised api here it is ...
238     if ( $b_ref->{category_type} eq 'C' ) {
239         my $patron_categories = Koha::Patron::Categories->search_limited({ category_type => 'A' }, {order_by => ['categorycode']});
240         $template->param( 'CATCODE_MULTI' => 1) if $patron_categories->count > 1;
241         $template->param( 'catcode' => $patron_categories->next->categorycode )  if $patron_categories->count == 1;
242     }
243
244     if (C4::Context->preference('ExtendedPatronAttributes')) {
245         $b_ref->{extendedattributes} = GetBorrowerAttributes($borrowernumber);
246         $template->param(
247             ExtendedPatronAttributes => 1,
248         );
249     }
250
251     return;
252 }
253
254 sub payselected {
255     my @params = @_;
256     my $amt    = 0;
257     my @lines_to_pay;
258     foreach (@params) {
259         if (/^incl_par_(\d+)$/) {
260             my $index = $1;
261             push @lines_to_pay, scalar $input->param("accountlines_id$index");
262             $amt += $input->param("amountoutstanding$index");
263         }
264     }
265     $amt = '&amt=' . $amt;
266     my $sel = '&selected=' . join ',', @lines_to_pay;
267     my $notes = '&notes=' . join("%0A", map { scalar $input->param("payment_note_$_") } @lines_to_pay );
268     my $redirect =
269         "/cgi-bin/koha/members/paycollect.pl?borrowernumber=$borrowernumber"
270       . $amt
271       . $sel
272       . $notes;
273
274     print $input->redirect($redirect);
275     return;
276 }