Bug 11210: Writeoff partial amounts
[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 strict;
30 use warnings;
31
32 use URI::Escape;
33 use C4::Context;
34 use C4::Auth;
35 use C4::Output;
36 use CGI qw ( -utf8 );
37 use C4::Members;
38 use C4::Accounts;
39 use C4::Stats;
40 use C4::Koha;
41 use C4::Overdues;
42 use C4::Members::Attributes qw(GetBorrowerAttributes);
43 use Koha::Patrons;
44 use Koha::Patron::Images;
45
46 use Koha::Patron::Categories;
47 use URI::Escape;
48
49 our $input = CGI->new;
50
51 my $updatecharges_permissions = $input->param('woall') ? 'writeoff' : 'remaining_permissions';
52 our ( $template, $loggedinuser, $cookie ) = get_template_and_user(
53     {   template_name   => 'members/pay.tt',
54         query           => $input,
55         type            => 'intranet',
56         authnotrequired => 0,
57         flagsrequired   => { borrowers => 1, updatecharges => $updatecharges_permissions },
58         debug           => 1,
59     }
60 );
61
62 my @names = $input->param;
63
64 our $borrowernumber = $input->param('borrowernumber');
65 if ( !$borrowernumber ) {
66     $borrowernumber = $input->param('borrowernumber0');
67 }
68
69 # get borrower details
70 my $patron = Koha::Patrons->find( $borrowernumber );
71 unless ( $patron ) {
72     print $input->redirect("/cgi-bin/koha/circ/circulation.pl?borrowernumber=$borrowernumber");
73     exit;
74 }
75 my $category = $patron->category;
76 our $borrower = $patron->unblessed;
77 $borrower->{description} = $category->description;
78 $borrower->{category_type} = $category->category_type;
79 our $user = $input->remote_user;
80 $user ||= q{};
81
82 our $branch = C4::Context->userenv->{'branch'};
83
84 my $writeoff_item = $input->param('confirm_writeoff');
85 my $paycollect    = $input->param('paycollect');
86 if ($paycollect) {
87     print $input->redirect(
88         "/cgi-bin/koha/members/paycollect.pl?borrowernumber=$borrowernumber");
89 }
90 my $payselected = $input->param('payselected');
91 if ($payselected) {
92     payselected(@names);
93 }
94
95 my $writeoff_all = $input->param('woall');    # writeoff all fines
96 if ($writeoff_all) {
97     writeoff_all(@names);
98 } elsif ($writeoff_item) {
99     my $accountlines_id = $input->param('accountlines_id');
100     my $amount       = $input->param('amountwrittenoff');
101     my $payment_note = $input->param("payment_note");
102
103     Koha::Account->new( { patron_id => $borrowernumber } )->pay(
104         {
105             amount     => $amount,
106             lines      => [ scalar Koha::Account::Lines->find($accountlines_id) ],
107             type       => 'writeoff',
108             note       => $payment_note,
109             library_id => $branch,
110         }
111     );
112 }
113
114 for (@names) {
115     if (/^pay_indiv_(\d+)$/) {
116         my $line_no = $1;
117         redirect_to_paycollect( 'pay_individual', $line_no );
118     } elsif (/^wo_indiv_(\d+)$/) {
119         my $line_no = $1;
120         redirect_to_paycollect( 'writeoff_individual', $line_no );
121     }
122 }
123
124 $template->param(
125     finesview => 1,
126     RoutingSerials => C4::Context->preference('RoutingSerials'),
127 );
128
129 add_accounts_to_template();
130
131 output_html_with_http_headers $input, $cookie, $template->output;
132
133 sub add_accounts_to_template {
134
135     my ( $total, undef, undef ) = GetMemberAccountRecords($borrowernumber);
136     my $account_lines = Koha::Account::Lines->search({ borrowernumber => $borrowernumber, amountoutstanding => { '!=' => 0 } }, { order_by => ['accounttype'] });
137     my @accounts;
138     while ( my $account_line = $account_lines->next ) {
139         $account_line = $account_line->unblessed;
140         if ( $account_line->{itemnumber} ) {
141             my $item = Koha::Items->find( $account_line->{itemnumber} );
142             my $biblio = $item->biblio;
143             $account_line->{biblionumber} = $biblio->biblionumber;
144             $account_line->{title}        = $biblio->title;
145         }
146         push @accounts, $account_line;
147     }
148     borrower_add_additional_fields($borrower);
149
150     $template->param(%$borrower);
151
152     my $patron_image = Koha::Patron::Images->find($borrower->{borrowernumber});
153     $template->param( picture => 1 ) if $patron_image;
154     $template->param(
155         accounts => \@accounts,
156         borrower => $borrower,
157         categoryname => $borrower->{'description'},
158         total    => $total,
159     );
160     return;
161
162 }
163
164 sub get_for_redirect {
165     my ( $name, $name_in, $money ) = @_;
166     my $s     = q{&} . $name . q{=};
167     my $value;
168     if (defined $input->param($name_in)) {
169         $value = uri_escape_utf8( scalar $input->param($name_in) );
170     }
171     if ( !defined $value ) {
172         $value = ( $money == 1 ) ? 0 : q{};
173     }
174     if ($money) {
175         $s .= sprintf '%.2f', $value;
176     } else {
177         $s .= $value;
178     }
179     return $s;
180 }
181
182 sub redirect_to_paycollect {
183     my ( $action, $line_no ) = @_;
184     my $redirect =
185       "/cgi-bin/koha/members/paycollect.pl?borrowernumber=$borrowernumber";
186     $redirect .= q{&};
187     $redirect .= "$action=1";
188     $redirect .= get_for_redirect( 'accounttype', "accounttype$line_no", 0 );
189     $redirect .= get_for_redirect( 'amount', "amount$line_no", 1 );
190     $redirect .=
191       get_for_redirect( 'amountoutstanding', "amountoutstanding$line_no", 1 );
192     $redirect .= get_for_redirect( 'description', "description$line_no", 0 );
193     $redirect .= get_for_redirect( 'title', "title$line_no", 0 );
194     $redirect .= get_for_redirect( 'itemnumber',   "itemnumber$line_no",   0 );
195     $redirect .= get_for_redirect( 'accountlines_id', "accountlines_id$line_no", 0 );
196     $redirect .= q{&} . 'payment_note' . q{=} . uri_escape_utf8( scalar $input->param("payment_note_$line_no") );
197     $redirect .= '&remote_user=';
198     $redirect .= $user;
199     return print $input->redirect($redirect);
200 }
201
202 sub writeoff_all {
203     my @params = @_;
204     my @wo_lines = grep { /^accountlines_id\d+$/ } @params;
205
206     my $borrowernumber = $input->param('borrowernumber');
207
208     for (@wo_lines) {
209         if (/(\d+)/) {
210             my $value           = $1;
211             my $amount          = $input->param("amountoutstanding$value");
212             my $accountlines_id = $input->param("accountlines_id$value");
213             my $payment_note    = $input->param("payment_note_$value");
214             Koha::Account->new( { patron_id => $borrowernumber } )->pay(
215                 {
216                     amount => $amount,
217                     lines  => [ scalar Koha::Account::Lines->find($accountlines_id) ],
218                     type   => 'writeoff',
219                     note   => $payment_note,
220                     library_id => $branch,
221                 }
222             );
223         }
224     }
225
226     print $input->redirect("/cgi-bin/koha/members/boraccount.pl?borrowernumber=$borrowernumber");
227     return;
228 }
229
230 sub borrower_add_additional_fields {
231     my $b_ref = shift;
232
233 # some borrower info is not returned in the standard call despite being assumed
234 # in a number of templates. It should not be the business of this script but in lieu of
235 # a revised api here it is ...
236     if ( $b_ref->{category_type} eq 'C' ) {
237         my $patron_categories = Koha::Patron::Categories->search_limited({ category_type => 'A' }, {order_by => ['categorycode']});
238         $template->param( 'CATCODE_MULTI' => 1) if $patron_categories->count > 1;
239         $template->param( 'catcode' => $patron_categories->next )  if $patron_categories->count == 1;
240     } elsif ( $b_ref->{category_type} eq 'A' || $b_ref->{category_type} eq 'I' ) {
241         $b_ref->{adultborrower} = 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 }