Display special characters correctly when writing off an invoice. The issue arises because pay.pl does not perform UTF-8 encoding on the “notes” parameter before redirecting the page. By using uri_escape_utf8, characters with a code above 255 are also UTF-8 encoded. Then, paycollect.pl can collect the information without any trouble. This patch work with “;” and “:” characters. TEST PLAN 1) Go to any patron profile > Accounting 2) Click “Create manual invoice” 3) Fill the fields and click the “Save” button 4) Repeat steps 2 and 3 5) Click “Make a payment” 6) Add a note with special characters for each one (e.g., éçö) 7) Select the created invoices and click the “Write off selected” button 8) In the note field, you should see “�” symbols where the special characters are supposed to be 9) Click the “Cancel” button 10) Now add a note with “:;” for one of the invoices 11) Select the invoices and click the “Write off selected” button 12) You should see a page with an error 500 13) Go back to the “Make a payment” page 14) Apply the patch 15) Add a note with special characters for each one (e.g., éçö) 16) Add “:;” to one of the note fields 17) Select the invoices and click the “Write off selected” button 18) Now the special characters are displayed correctly Signed-off-by: David Nind <david@davidnind.com> Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl> Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> (cherry picked from commit1c01617634
) Signed-off-by: Fridolin Somers <fridolin.somers@biblibre.com> (cherry picked from commiteea0310a62
) Signed-off-by: Matt Blenkinsop <matt.blenkinsop@ptfs-europe.com>
306 lines
10 KiB
Perl
Executable file
306 lines
10 KiB
Perl
Executable file
#!/usr/bin/perl
|
|
|
|
# Copyright 2000-2002 Katipo Communications
|
|
# Copyright 2010 BibLibre
|
|
# Copyright 2010,2011 PTFS-Europe Ltd
|
|
#
|
|
# This file is part of Koha.
|
|
#
|
|
# Koha is free software; you can redistribute it and/or modify it
|
|
# under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Koha is distributed in the hope that it will be useful, but
|
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Koha; if not, see <http://www.gnu.org/licenses>.
|
|
|
|
=head1 pay.pl
|
|
|
|
written 11/1/2000 by chris@katipo.oc.nz
|
|
part of the koha library system, script to facilitate paying off fines
|
|
|
|
=cut
|
|
|
|
use Modern::Perl;
|
|
|
|
use URI::Escape qw( uri_escape_utf8 uri_unescape );
|
|
use C4::Context;
|
|
use C4::Auth qw( get_template_and_user );
|
|
use C4::Output qw( output_and_exit_if_error output_and_exit output_html_with_http_headers );
|
|
use CGI qw ( -utf8 );
|
|
use C4::Members;
|
|
use C4::Accounts;
|
|
use C4::Stats;
|
|
use C4::Koha;
|
|
use C4::Overdues;
|
|
use Koha::Patrons;
|
|
use Koha::Items;
|
|
|
|
use Koha::Patron::Categories;
|
|
use URI::Escape qw( uri_escape_utf8 uri_unescape );
|
|
|
|
our $input = CGI->new;
|
|
|
|
my $updatecharges_permissions = $input->param('woall') ? 'writeoff' : 'remaining_permissions';
|
|
our ( $template, $loggedinuser, $cookie ) = get_template_and_user(
|
|
{ template_name => 'members/pay.tt',
|
|
query => $input,
|
|
type => 'intranet',
|
|
flagsrequired => { borrowers => 'edit_borrowers', updatecharges => $updatecharges_permissions },
|
|
}
|
|
);
|
|
|
|
my @names = $input->param;
|
|
|
|
our $borrowernumber = $input->param('borrowernumber');
|
|
if ( !$borrowernumber ) {
|
|
$borrowernumber = $input->param('borrowernumber0');
|
|
}
|
|
|
|
my $payment_id = $input->param('payment_id');
|
|
our $change_given = $input->param('change_given');
|
|
our @renew_results = $input->multi_param('renew_result');
|
|
|
|
# get borrower details
|
|
my $logged_in_user = Koha::Patrons->find( $loggedinuser );
|
|
our $patron = Koha::Patrons->find($borrowernumber);
|
|
output_and_exit_if_error( $input, $cookie, $template, { module => 'members', logged_in_user => $logged_in_user, current_patron => $patron } );
|
|
|
|
our $user = $input->remote_user;
|
|
$user ||= q{};
|
|
|
|
our $branch = C4::Context->userenv->{'branch'};
|
|
|
|
if ( $input->param('paycollect') ) {
|
|
output_and_exit_if_error($input, $cookie, $template, { check => 'csrf_token' });
|
|
print $input->redirect(
|
|
"/cgi-bin/koha/members/paycollect.pl?borrowernumber=$borrowernumber&change_given=$change_given");
|
|
}
|
|
elsif ( $input->param('payselected') ) {
|
|
output_and_exit_if_error($input, $cookie, $template, { check => 'csrf_token' });
|
|
payselected({ params => \@names });
|
|
}
|
|
elsif ( $input->param('writeoff_selected') ) {
|
|
output_and_exit_if_error($input, $cookie, $template, { check => 'csrf_token' });
|
|
payselected({ params => \@names, type => 'WRITEOFF' });
|
|
}
|
|
elsif ( $input->param('woall') ) {
|
|
output_and_exit_if_error($input, $cookie, $template, { check => 'csrf_token' });
|
|
writeoff_all(@names);
|
|
}
|
|
elsif ( $input->param('apply_credits') ) {
|
|
output_and_exit_if_error($input, $cookie, $template, { check => 'csrf_token' });
|
|
apply_credits({ patron => $patron, cgi => $input });
|
|
}
|
|
elsif ( $input->param('confirm_writeoff') ) {
|
|
output_and_exit_if_error($input, $cookie, $template, { check => 'csrf_token' });
|
|
my $item_id = $input->param('itemnumber');
|
|
my $accountlines_id = $input->param('accountlines_id');
|
|
my $amount = $input->param('amountwrittenoff');
|
|
my $payment_note = $input->param("payment_note");
|
|
|
|
my $accountline = Koha::Account::Lines->find( $accountlines_id );
|
|
|
|
$amount = $accountline->amountoutstanding if (abs($amount - $accountline->amountoutstanding) < 0.01) && C4::Context->preference('RoundFinesAtPayment');
|
|
if ( $amount > $accountline->amountoutstanding ) {
|
|
print $input->redirect( "/cgi-bin/koha/members/paycollect.pl?"
|
|
. "borrowernumber=$borrowernumber"
|
|
. "&amount=" . $accountline->amount
|
|
. "&amountoutstanding=" . $accountline->amountoutstanding
|
|
. "&debit_type_code=" . $accountline->debit_type_code
|
|
. "&accountlines_id=" . $accountlines_id
|
|
. "&change_given=" . $change_given
|
|
. "&writeoff_individual=1"
|
|
. "&error_over=1" );
|
|
|
|
} else {
|
|
$payment_id = Koha::Account->new( { patron_id => $borrowernumber } )->pay(
|
|
{
|
|
amount => $amount,
|
|
lines => [ Koha::Account::Lines->find($accountlines_id) ],
|
|
type => 'WRITEOFF',
|
|
note => $payment_note,
|
|
interface => C4::Context->interface,
|
|
item_id => $item_id,
|
|
library_id => $branch,
|
|
}
|
|
)->{payment_id};
|
|
}
|
|
}
|
|
|
|
for (@names) {
|
|
if (/^pay_indiv_(\d+)$/) {
|
|
output_and_exit_if_error($input, $cookie, $template, { check => 'csrf_token' });
|
|
my $line_no = $1;
|
|
redirect_to_paycollect( 'pay_individual', $line_no );
|
|
} elsif (/^wo_indiv_(\d+)$/) {
|
|
output_and_exit_if_error($input, $cookie, $template, { check => 'csrf_token' });
|
|
my $line_no = $1;
|
|
redirect_to_paycollect( 'writeoff_individual', $line_no );
|
|
}
|
|
}
|
|
|
|
# Populate an arrayref with everything we need to display any
|
|
# renew results that occurred based on what we were passed
|
|
my $renew_results_display = [];
|
|
foreach my $renew_result(@renew_results) {
|
|
my ($itemnumber, $success, $info) = split(/,/, $renew_result);
|
|
my $item = Koha::Items->find($itemnumber);
|
|
if ($success) {
|
|
$info = uri_unescape($info);
|
|
}
|
|
push @{$renew_results_display}, {
|
|
item => $item,
|
|
success => $success,
|
|
info => $info
|
|
};
|
|
}
|
|
|
|
$template->param(
|
|
finesview => 1,
|
|
payment_id => $payment_id,
|
|
change_given => $change_given,
|
|
renew_results => $renew_results_display
|
|
);
|
|
|
|
add_accounts_to_template();
|
|
|
|
output_html_with_http_headers $input, $cookie, $template->output;
|
|
|
|
sub add_accounts_to_template {
|
|
|
|
my $patron = Koha::Patrons->find( $borrowernumber );
|
|
my $account = $patron->account;
|
|
my $outstanding_credits = $account->outstanding_credits;
|
|
my $account_lines = $account->outstanding_debits;
|
|
my $total = $account_lines->total_outstanding;
|
|
my @accounts;
|
|
while ( my $account_line = $account_lines->next ) {
|
|
push @accounts, $account_line;
|
|
}
|
|
|
|
$template->param(
|
|
patron => $patron,
|
|
accounts => \@accounts,
|
|
total => $total,
|
|
outstanding_credits => $outstanding_credits
|
|
);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
sub get_for_redirect {
|
|
my ( $name, $name_in, $money ) = @_;
|
|
my $s = q{&} . $name . q{=};
|
|
my $value;
|
|
if (defined $input->param($name_in)) {
|
|
$value = uri_escape_utf8( scalar $input->param($name_in) );
|
|
}
|
|
if ( !defined $value ) {
|
|
$value = ( $money == 1 ) ? 0 : q{};
|
|
}
|
|
if ($money) {
|
|
$s .= sprintf '%.2f', $value;
|
|
} else {
|
|
$s .= $value;
|
|
}
|
|
return $s;
|
|
}
|
|
|
|
sub redirect_to_paycollect {
|
|
my ( $action, $line_no ) = @_;
|
|
my $redirect =
|
|
"/cgi-bin/koha/members/paycollect.pl?borrowernumber=$borrowernumber";
|
|
$redirect .= q{&};
|
|
$redirect .= "$action=1";
|
|
$redirect .= get_for_redirect( 'debit_type_code', "debit_type_code$line_no", 0 );
|
|
$redirect .= get_for_redirect( 'amount', "amount$line_no", 1 );
|
|
$redirect .=
|
|
get_for_redirect( 'amountoutstanding', "amountoutstanding$line_no", 1 );
|
|
$redirect .= get_for_redirect( 'description', "description$line_no", 0 );
|
|
$redirect .= get_for_redirect( 'title', "title$line_no", 0 );
|
|
$redirect .= get_for_redirect( 'itemnumber', "itemnumber$line_no", 0 );
|
|
$redirect .= get_for_redirect( 'accountlines_id', "accountlines_id$line_no", 0 );
|
|
$redirect .= q{&} . 'payment_note' . q{=} . uri_escape_utf8( scalar $input->param("payment_note_$line_no") );
|
|
$redirect .= '&remote_user=';
|
|
$redirect .= "change_given=$change_given";
|
|
$redirect .= $user;
|
|
return print $input->redirect($redirect);
|
|
}
|
|
|
|
sub writeoff_all {
|
|
my @params = @_;
|
|
my @wo_lines = grep { /^accountlines_id\d+$/ } @params;
|
|
|
|
my $borrowernumber = $input->param('borrowernumber');
|
|
|
|
for (@wo_lines) {
|
|
if (/(\d+)/) {
|
|
my $value = $1;
|
|
my $amount = $input->param("amountoutstanding$value");
|
|
my $accountlines_id = $input->param("accountlines_id$value");
|
|
my $payment_note = $input->param("payment_note_$value");
|
|
Koha::Account->new( { patron_id => $borrowernumber } )->pay(
|
|
{
|
|
amount => $amount,
|
|
lines => [ Koha::Account::Lines->find($accountlines_id) ],
|
|
type => 'WRITEOFF',
|
|
note => $payment_note,
|
|
interface => C4::Context->interface,
|
|
library_id => $branch,
|
|
}
|
|
);
|
|
}
|
|
}
|
|
|
|
print $input->redirect("/cgi-bin/koha/members/boraccount.pl?borrowernumber=$borrowernumber");
|
|
return;
|
|
}
|
|
|
|
sub payselected {
|
|
my $parameters = shift;
|
|
|
|
my @params = @{ $parameters->{params} };
|
|
my $type = $parameters->{type} || 'PAYMENT';
|
|
|
|
my $amt = 0;
|
|
my @lines_to_pay;
|
|
foreach (@params) {
|
|
if (/^incl_par_(\d+)$/) {
|
|
my $index = $1;
|
|
push @lines_to_pay, scalar $input->param("accountlines_id$index");
|
|
$amt += $input->param("amountoutstanding$index");
|
|
}
|
|
}
|
|
$amt = '&amt=' . $amt;
|
|
my $sel = '&selected=' . join ',', @lines_to_pay;
|
|
my $notes =
|
|
'¬es=' . uri_escape_utf8( join( "\n", map { scalar $input->param("payment_note_$_") } @lines_to_pay ) );
|
|
my $redirect =
|
|
"/cgi-bin/koha/members/paycollect.pl?borrowernumber=$borrowernumber"
|
|
. "&type=$type"
|
|
. $amt
|
|
. $sel
|
|
. $notes;
|
|
|
|
print $input->redirect($redirect);
|
|
return;
|
|
}
|
|
|
|
sub apply_credits {
|
|
my ($args) = @_;
|
|
|
|
my $patron = $args->{patron};
|
|
my $cgi = $args->{cgi};
|
|
|
|
$patron->account->reconcile_balance();
|
|
|
|
print $cgi->redirect("/cgi-bin/koha/members/pay.pl?borrowernumber=" . $patron->borrowernumber );
|
|
return;
|
|
}
|