Bug 11210: Writeoff partial amounts
[koha.git] / members / pay.pl
blob2295061a890a071b83bd06478cbe8fdc976b2d12
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 strict;
30 use warnings;
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;
46 use Koha::Patron::Categories;
47 use URI::Escape;
49 our $input = CGI->new;
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,
62 my @names = $input->param;
64 our $borrowernumber = $input->param('borrowernumber');
65 if ( !$borrowernumber ) {
66 $borrowernumber = $input->param('borrowernumber0');
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;
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{};
82 our $branch = C4::Context->userenv->{'branch'};
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");
90 my $payselected = $input->param('payselected');
91 if ($payselected) {
92 payselected(@names);
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");
103 Koha::Account->new( { patron_id => $borrowernumber } )->pay(
105 amount => $amount,
106 lines => [ scalar Koha::Account::Lines->find($accountlines_id) ],
107 type => 'writeoff',
108 note => $payment_note,
109 library_id => $branch,
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 );
124 $template->param(
125 finesview => 1,
126 RoutingSerials => C4::Context->preference('RoutingSerials'),
129 add_accounts_to_template();
131 output_html_with_http_headers $input, $cookie, $template->output;
133 sub add_accounts_to_template {
135 my ( $total, undef, undef ) = GetMemberAccountRecords($borrowernumber);
136 my $accounts = [];
137 my @notify = NumberNotifyId($borrowernumber);
139 my $notify_groups = [];
140 for my $notify_id (@notify) {
141 my ( $acct_total, $accountlines, undef ) =
142 GetBorNotifyAcctRecord( $borrowernumber, $notify_id );
143 if ( @{$accountlines} ) {
144 my $totalnotify = AmountNotify( $notify_id, $borrowernumber );
145 push @{$accounts},
146 { accountlines => $accountlines,
147 notify => $notify_id,
148 total => $totalnotify,
152 borrower_add_additional_fields($borrower);
154 $template->param(%$borrower);
156 my $patron_image = Koha::Patron::Images->find($borrower->{borrowernumber});
157 $template->param( picture => 1 ) if $patron_image;
158 $template->param(
159 accounts => $accounts,
160 borrower => $borrower,
161 categoryname => $borrower->{'description'},
162 total => $total,
164 return;
168 sub get_for_redirect {
169 my ( $name, $name_in, $money ) = @_;
170 my $s = q{&} . $name . q{=};
171 my $value;
172 if (defined $input->param($name_in)) {
173 $value = uri_escape_utf8( scalar $input->param($name_in) );
175 if ( !defined $value ) {
176 $value = ( $money == 1 ) ? 0 : q{};
178 if ($money) {
179 $s .= sprintf '%.2f', $value;
180 } else {
181 $s .= $value;
183 return $s;
186 sub redirect_to_paycollect {
187 my ( $action, $line_no ) = @_;
188 my $redirect =
189 "/cgi-bin/koha/members/paycollect.pl?borrowernumber=$borrowernumber";
190 $redirect .= q{&};
191 $redirect .= "$action=1";
192 $redirect .= get_for_redirect( 'accounttype', "accounttype$line_no", 0 );
193 $redirect .= get_for_redirect( 'amount', "amount$line_no", 1 );
194 $redirect .=
195 get_for_redirect( 'amountoutstanding', "amountoutstanding$line_no", 1 );
196 $redirect .= get_for_redirect( 'description', "description$line_no", 0 );
197 $redirect .= get_for_redirect( 'title', "title$line_no", 0 );
198 $redirect .= get_for_redirect( 'itemnumber', "itemnumber$line_no", 0 );
199 $redirect .= get_for_redirect( 'notify_id', "notify_id$line_no", 0 );
200 $redirect .= get_for_redirect( 'notify_level', "notify_level$line_no", 0 );
201 $redirect .= get_for_redirect( 'accountlines_id', "accountlines_id$line_no", 0 );
202 $redirect .= q{&} . 'payment_note' . q{=} . uri_escape_utf8( scalar $input->param("payment_note_$line_no") );
203 $redirect .= '&remote_user=';
204 $redirect .= $user;
205 return print $input->redirect($redirect);
208 sub writeoff_all {
209 my @params = @_;
210 my @wo_lines = grep { /^accountlines_id\d+$/ } @params;
212 my $borrowernumber = $input->param('borrowernumber');
214 for (@wo_lines) {
215 if (/(\d+)/) {
216 my $value = $1;
217 my $amount = $input->param("amountoutstanding$value");
218 my $accountlines_id = $input->param("accountlines_id$value");
219 my $payment_note = $input->param("payment_note_$value");
220 Koha::Account->new( { patron_id => $borrowernumber } )->pay(
222 amount => $amount,
223 lines => [ scalar Koha::Account::Lines->find($accountlines_id) ],
224 type => 'writeoff',
225 note => $payment_note,
226 library_id => $branch,
232 print $input->redirect("/cgi-bin/koha/members/boraccount.pl?borrowernumber=$borrowernumber");
233 return;
236 sub borrower_add_additional_fields {
237 my $b_ref = shift;
239 # some borrower info is not returned in the standard call despite being assumed
240 # in a number of templates. It should not be the business of this script but in lieu of
241 # a revised api here it is ...
242 if ( $b_ref->{category_type} eq 'C' ) {
243 my $patron_categories = Koha::Patron::Categories->search_limited({ category_type => 'A' }, {order_by => ['categorycode']});
244 $template->param( 'CATCODE_MULTI' => 1) if $patron_categories->count > 1;
245 $template->param( 'catcode' => $patron_categories->next ) if $patron_categories->count == 1;
246 } elsif ( $b_ref->{category_type} eq 'A' || $b_ref->{category_type} eq 'I' ) {
247 $b_ref->{adultborrower} = 1;
250 if (C4::Context->preference('ExtendedPatronAttributes')) {
251 $b_ref->{extendedattributes} = GetBorrowerAttributes($borrowernumber);
252 $template->param(
253 ExtendedPatronAttributes => 1,
257 return;
260 sub payselected {
261 my @params = @_;
262 my $amt = 0;
263 my @lines_to_pay;
264 foreach (@params) {
265 if (/^incl_par_(\d+)$/) {
266 my $index = $1;
267 push @lines_to_pay, scalar $input->param("accountlines_id$index");
268 $amt += $input->param("amountoutstanding$index");
271 $amt = '&amt=' . $amt;
272 my $sel = '&selected=' . join ',', @lines_to_pay;
273 my $notes = '&notes=' . join("%0A", map { scalar $input->param("payment_note_$_") } @lines_to_pay );
274 my $redirect =
275 "/cgi-bin/koha/members/paycollect.pl?borrowernumber=$borrowernumber"
276 . $amt
277 . $sel
278 . $notes;
280 print $input->redirect($redirect);
281 return;