Bug 21581: (RMaint follow-up) Skip deprecated GRS-1 test for feature
[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 );
127
128 add_accounts_to_template();
129
130 output_html_with_http_headers $input, $cookie, $template->output;
131
132 sub add_accounts_to_template {
133
134     my ( $total, undef, undef ) = GetMemberAccountRecords($borrowernumber);
135     my $accounts = [];
136     my @notify   = NumberNotifyId($borrowernumber);
137
138     my $notify_groups = [];
139     for my $notify_id (@notify) {
140         my ( $acct_total, $accountlines, undef ) =
141           GetBorNotifyAcctRecord( $borrowernumber, $notify_id );
142         if ( @{$accountlines} ) {
143             my $totalnotify = AmountNotify( $notify_id, $borrowernumber );
144             push @{$accounts},
145               { accountlines => $accountlines,
146                 notify       => $notify_id,
147                 total        => $totalnotify,
148               };
149         }
150     }
151     borrower_add_additional_fields($borrower);
152
153     $template->param(%$borrower);
154
155     my $patron_image = Koha::Patron::Images->find($borrower->{borrowernumber});
156     $template->param( picture => 1 ) if $patron_image;
157     $template->param(
158         accounts => $accounts,
159         borrower => $borrower,
160         categoryname => $borrower->{'description'},
161         total    => $total,
162     );
163     return;
164
165 }
166
167 sub get_for_redirect {
168     my ( $name, $name_in, $money ) = @_;
169     my $s     = q{&} . $name . q{=};
170     my $value;
171     if (defined $input->param($name_in)) {
172         $value = uri_escape_utf8( scalar $input->param($name_in) );
173     }
174     if ( !defined $value ) {
175         $value = ( $money == 1 ) ? 0 : q{};
176     }
177     if ($money) {
178         $s .= sprintf '%.2f', $value;
179     } else {
180         $s .= $value;
181     }
182     return $s;
183 }
184
185 sub redirect_to_paycollect {
186     my ( $action, $line_no ) = @_;
187     my $redirect =
188       "/cgi-bin/koha/members/paycollect.pl?borrowernumber=$borrowernumber";
189     $redirect .= q{&};
190     $redirect .= "$action=1";
191     $redirect .= get_for_redirect( 'accounttype', "accounttype$line_no", 0 );
192     $redirect .= get_for_redirect( 'amount', "amount$line_no", 1 );
193     $redirect .=
194       get_for_redirect( 'amountoutstanding', "amountoutstanding$line_no", 1 );
195     $redirect .= get_for_redirect( 'description', "description$line_no", 0 );
196     $redirect .= get_for_redirect( 'title', "title$line_no", 0 );
197     $redirect .= get_for_redirect( 'itemnumber',   "itemnumber$line_no",   0 );
198     $redirect .= get_for_redirect( 'notify_id',    "notify_id$line_no",    0 );
199     $redirect .= get_for_redirect( 'notify_level', "notify_level$line_no", 0 );
200     $redirect .= get_for_redirect( 'accountlines_id', "accountlines_id$line_no", 0 );
201     $redirect .= q{&} . 'payment_note' . q{=} . uri_escape_utf8( scalar $input->param("payment_note_$line_no") );
202     $redirect .= '&remote_user=';
203     $redirect .= $user;
204     return print $input->redirect($redirect);
205 }
206
207 sub writeoff_all {
208     my @params = @_;
209     my @wo_lines = grep { /^accountlines_id\d+$/ } @params;
210
211     my $borrowernumber = $input->param('borrowernumber');
212
213     for (@wo_lines) {
214         if (/(\d+)/) {
215             my $value           = $1;
216             my $amount          = $input->param("amountoutstanding$value");
217             my $accountlines_id = $input->param("accountlines_id$value");
218             my $payment_note    = $input->param("payment_note_$value");
219             Koha::Account->new( { patron_id => $borrowernumber } )->pay(
220                 {
221                     amount => $amount,
222                     lines  => [ scalar Koha::Account::Lines->find($accountlines_id) ],
223                     type   => 'writeoff',
224                     note   => $payment_note,
225                     library_id => $branch,
226                 }
227             );
228         }
229     }
230
231     print $input->redirect("/cgi-bin/koha/members/boraccount.pl?borrowernumber=$borrowernumber");
232     return;
233 }
234
235 sub borrower_add_additional_fields {
236     my $b_ref = shift;
237
238 # some borrower info is not returned in the standard call despite being assumed
239 # in a number of templates. It should not be the business of this script but in lieu of
240 # a revised api here it is ...
241     if ( $b_ref->{category_type} eq 'C' ) {
242         my $patron_categories = Koha::Patron::Categories->search_limited({ category_type => 'A' }, {order_by => ['categorycode']});
243         $template->param( 'CATCODE_MULTI' => 1) if $patron_categories->count > 1;
244         $template->param( 'catcode' => $patron_categories->next->categorycode )  if $patron_categories->count == 1;
245     } elsif ( $b_ref->{category_type} eq 'A' || $b_ref->{category_type} eq 'I' ) {
246         $b_ref->{adultborrower} = 1;
247     }
248
249     if (C4::Context->preference('ExtendedPatronAttributes')) {
250         $b_ref->{extendedattributes} = GetBorrowerAttributes($borrowernumber);
251         $template->param(
252             ExtendedPatronAttributes => 1,
253         );
254     }
255
256     return;
257 }
258
259 sub payselected {
260     my @params = @_;
261     my $amt    = 0;
262     my @lines_to_pay;
263     foreach (@params) {
264         if (/^incl_par_(\d+)$/) {
265             my $index = $1;
266             push @lines_to_pay, scalar $input->param("accountlines_id$index");
267             $amt += $input->param("amountoutstanding$index");
268         }
269     }
270     $amt = '&amt=' . $amt;
271     my $sel = '&selected=' . join ',', @lines_to_pay;
272     my $notes = '&notes=' . join("%0A", map { scalar $input->param("payment_note_$_") } @lines_to_pay );
273     my $redirect =
274         "/cgi-bin/koha/members/paycollect.pl?borrowernumber=$borrowernumber"
275       . $amt
276       . $sel
277       . $notes;
278
279     print $input->redirect($redirect);
280     return;
281 }