Bug 9302: (QA follow-up) Consistency follow-up
[koha.git] / members / pay.pl
blob05b73e5b74fda9c6cc7977d33f88102f16d2a9f2
1 #!/usr/bin/perl
3 # Copyright 2000-2002 Katipo Communications
4 # Copyright 2010 BibLibre
5 # Copyright 2010,2011 PTFS-Europe Ltd
7 # This file is part of Koha.
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.
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.
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>.
22 =head1 pay.pl
24 written 11/1/2000 by chris@katipo.oc.nz
25 part of the koha library system, script to facilitate paying off fines
27 =cut
29 use Modern::Perl;
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;
44 use Koha::Patron::Categories;
45 use URI::Escape;
47 our $input = CGI->new;
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,
60 my @names = $input->param;
62 our $borrowernumber = $input->param('borrowernumber');
63 if ( !$borrowernumber ) {
64 $borrowernumber = $input->param('borrowernumber0');
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 } );
72 our $user = $input->remote_user;
73 $user ||= q{};
75 our $branch = C4::Context->userenv->{'branch'};
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");
83 my $payselected = $input->param('payselected');
84 if ($payselected) {
85 payselected(@names);
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");
96 Koha::Account->new( { patron_id => $borrowernumber } )->pay(
98 amount => $amount,
99 lines => [ scalar Koha::Account::Lines->find($accountlines_id) ],
100 type => 'writeoff',
101 note => $payment_note,
102 library_id => $branch,
107 for (@names) {
108 if (/^pay_indiv_(\d+)$/) {
109 my $line_no = $1;
110 redirect_to_paycollect( 'pay_individual', $line_no );
111 } elsif (/^wo_indiv_(\d+)$/) {
112 my $line_no = $1;
113 redirect_to_paycollect( 'writeoff_individual', $line_no );
117 $template->param(
118 finesview => 1,
121 add_accounts_to_template();
123 output_html_with_http_headers $input, $cookie, $template->output;
125 sub add_accounts_to_template {
127 my $patron = Koha::Patrons->find( $borrowernumber );
128 my $total = $patron->account->balance;
129 my $account_lines = Koha::Account::Lines->search({ borrowernumber => $borrowernumber, amountoutstanding => { '!=' => 0 } }, { order_by => ['accounttype'] });
130 my @accounts;
131 while ( my $account_line = $account_lines->next ) {
132 $account_line = $account_line->unblessed;
133 if ( $account_line->{itemnumber} ) {
134 my $item = Koha::Items->find( $account_line->{itemnumber} );
135 my $biblio = $item->biblio;
136 $account_line->{biblionumber} = $biblio->biblionumber;
137 $account_line->{title} = $biblio->title;
139 push @accounts, $account_line;
141 borrower_add_additional_fields($patron->unblessed);
143 $template->param(
144 patron => $patron,
145 accounts => \@accounts,
146 total => $total,
148 return;
152 sub get_for_redirect {
153 my ( $name, $name_in, $money ) = @_;
154 my $s = q{&} . $name . q{=};
155 my $value;
156 if (defined $input->param($name_in)) {
157 $value = uri_escape_utf8( scalar $input->param($name_in) );
159 if ( !defined $value ) {
160 $value = ( $money == 1 ) ? 0 : q{};
162 if ($money) {
163 $s .= sprintf '%.2f', $value;
164 } else {
165 $s .= $value;
167 return $s;
170 sub redirect_to_paycollect {
171 my ( $action, $line_no ) = @_;
172 my $redirect =
173 "/cgi-bin/koha/members/paycollect.pl?borrowernumber=$borrowernumber";
174 $redirect .= q{&};
175 $redirect .= "$action=1";
176 $redirect .= get_for_redirect( 'accounttype', "accounttype$line_no", 0 );
177 $redirect .= get_for_redirect( 'amount', "amount$line_no", 1 );
178 $redirect .=
179 get_for_redirect( 'amountoutstanding', "amountoutstanding$line_no", 1 );
180 $redirect .= get_for_redirect( 'description', "description$line_no", 0 );
181 $redirect .= get_for_redirect( 'title', "title$line_no", 0 );
182 $redirect .= get_for_redirect( 'itemnumber', "itemnumber$line_no", 0 );
183 $redirect .= get_for_redirect( 'accountlines_id', "accountlines_id$line_no", 0 );
184 $redirect .= q{&} . 'payment_note' . q{=} . uri_escape_utf8( scalar $input->param("payment_note_$line_no") );
185 $redirect .= '&remote_user=';
186 $redirect .= $user;
187 return print $input->redirect($redirect);
190 sub writeoff_all {
191 my @params = @_;
192 my @wo_lines = grep { /^accountlines_id\d+$/ } @params;
194 my $borrowernumber = $input->param('borrowernumber');
196 for (@wo_lines) {
197 if (/(\d+)/) {
198 my $value = $1;
199 my $amount = $input->param("amountoutstanding$value");
200 my $accountlines_id = $input->param("accountlines_id$value");
201 my $payment_note = $input->param("payment_note_$value");
202 Koha::Account->new( { patron_id => $borrowernumber } )->pay(
204 amount => $amount,
205 lines => [ scalar Koha::Account::Lines->find($accountlines_id) ],
206 type => 'writeoff',
207 note => $payment_note,
208 library_id => $branch,
214 print $input->redirect("/cgi-bin/koha/members/boraccount.pl?borrowernumber=$borrowernumber");
215 return;
218 sub borrower_add_additional_fields {
219 my $b_ref = shift;
221 # some borrower info is not returned in the standard call despite being assumed
222 # in a number of templates. It should not be the business of this script but in lieu of
223 # a revised api here it is ...
224 if ( $b_ref->{category_type} eq 'C' ) {
225 my $patron_categories = Koha::Patron::Categories->search_limited({ category_type => 'A' }, {order_by => ['categorycode']});
226 $template->param( 'CATCODE_MULTI' => 1) if $patron_categories->count > 1;
227 $template->param( 'catcode' => $patron_categories->next->categorycode ) if $patron_categories->count == 1;
230 if (C4::Context->preference('ExtendedPatronAttributes')) {
231 $b_ref->{extendedattributes} = GetBorrowerAttributes($borrowernumber);
232 $template->param(
233 ExtendedPatronAttributes => 1,
237 return;
240 sub payselected {
241 my @params = @_;
242 my $amt = 0;
243 my @lines_to_pay;
244 foreach (@params) {
245 if (/^incl_par_(\d+)$/) {
246 my $index = $1;
247 push @lines_to_pay, scalar $input->param("accountlines_id$index");
248 $amt += $input->param("amountoutstanding$index");
251 $amt = '&amt=' . $amt;
252 my $sel = '&selected=' . join ',', @lines_to_pay;
253 my $notes = '&notes=' . join("%0A", map { scalar $input->param("payment_note_$_") } @lines_to_pay );
254 my $redirect =
255 "/cgi-bin/koha/members/paycollect.pl?borrowernumber=$borrowernumber"
256 . $amt
257 . $sel
258 . $notes;
260 print $input->redirect($redirect);
261 return;