Attachment 111255 Details for Bug 24603 – Bug 24603: Allow to cancel charges in patron accounting

[patch] Bug 24603: Allow to cancel charges in patron accounting

Bug-24603-Allow-to-cancel-charges-in-patron-accoun.patch (text/plain), 11.75 KB, created by David Nind on 2020-10-05 19:31:17 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: David Nind

Created: 2020-10-05 19:31:17 UTC

Size: 11.75 KB

patch

obsolete

>From 5ad6b6896d76283b9521b24d09a70a09617be727 Mon Sep 17 00:00:00 2001
>From: Julian Maurice <julian.maurice@biblibre.com>
>Date: Thu, 6 Feb 2020 14:13:44 +0100
>Subject: [PATCH] Bug 24603: Allow to cancel charges in patron accounting
>
>There is already a button to void a payment. It should be possible to
>cancel a charge too.
>
>This patch adds a button in patron's accounting section (Transactions
>tab) that allow to cancel charges.
>Charges that have been fully or partially paid cannot be cancelled.
>
>It also fixes Koha::Account::Line::is_credit by looking at
>credit_type_code instead of amount (amount can be 0 for voided payments)
>
>It also fixes the tests for Koha::Account::Line::void when database does
>not contain the borrowernumber 51 (the default in
>t::lib::Mocks::mock_userenv)
>
>Test plan:
>1. Go to a patron's accounting section
>2. Create a manual invoice
>3. In Transactions tab, you should see a 'Cancel charge' button. Click
>   on it. It should now be marked as cancelled
>4. Create another manual invoice
>5. Pay it (partially or fully)
>6. Notice that the 'Cancel charge' button is not available
>7. Void the payment
>8. 'Cancel charge' button is available again. Click on it and verify
>   that it still works
>9. prove t/db_dependent/Koha/Account/Lines.t
>
>Signed-off-by: David Nind <david@davidnind.com>
>
>Signed-off-by: David Nind <david@davidnind.com>
>---
> Koha/Account/Line.pm                               | 50 +++++++++++++++-
> .../intranet-tmpl/prog/en/includes/accounts.inc    |  1 +
> .../prog/en/modules/members/boraccount.tt          | 15 ++++-
> members/boraccount.pl                              |  6 ++
> members/cancel-charge.pl                           | 48 ++++++++++++++++
> t/db_dependent/Koha/Account/Line.t                 | 66 ++++++++++++++++++++++
> 6 files changed, 183 insertions(+), 3 deletions(-)
> create mode 100755 members/cancel-charge.pl
>
>diff --git a/Koha/Account/Line.pm b/Koha/Account/Line.pm
>index 98d7ef3c15..475ec1a7b6 100644
>--- a/Koha/Account/Line.pm
>+++ b/Koha/Account/Line.pm
>@@ -285,6 +285,54 @@ sub void {
> 
> }
> 
>+=head3 cancel
>+
>+  $debit_accountline->cancel();
>+
>+Cancel a charge. It will mark the debit as 'cancelled' by updating its
>+status to 'CANCELLED'.
>+Charges that have been fully or partially paid cannot be cancelled.
>+
>+Return self in case of success, undef otherwise
>+
>+=cut
>+
>+sub cancel {
>+    my ($self) = @_;
>+
>+    # Make sure it is a charge we are cancelling
>+    return unless $self->is_debit;
>+
>+    # Make sure it is not already cancelled
>+    return if $self->status && $self->status eq 'CANCELLED';
>+
>+    # Make sure it has not be paid yet
>+    return if $self->amount != $self->amountoutstanding;
>+
>+    if ( C4::Context->preference("FinesLog") ) {
>+        logaction('FINES', 'CANCEL', $self->borrowernumber, Dumper({
>+            action => 'cancel_charge',
>+            borrowernumber => $self->borrowernumber,
>+            amount => $self->amount,
>+            amountoutstanding => $self->amountoutstanding,
>+            description => $self->description,
>+            debit_type_code => $self->debit_type_code,
>+            note => $self->note,
>+            itemnumber => $self->itemnumber,
>+            manager_id => $self->manager_id,
>+        }));
>+    }
>+
>+    $self->set({
>+        status => 'CANCELLED',
>+        amountoutstanding => 0,
>+        amount => 0,
>+    });
>+    $self->store();
>+
>+    return $self;
>+}
>+
> =head3 reduce
> 
>   $charge_accountline->reduce({
>@@ -755,7 +803,7 @@ sub adjust {
> sub is_credit {
>     my ($self) = @_;
> 
>-    return ( $self->amount < 0 );
>+    return defined $self->credit_type_code;
> }
> 
> =head3 is_debit
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/accounts.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/accounts.inc
>index 62ea570040..fae860d4cf 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/includes/accounts.inc
>+++ b/koha-tmpl/intranet-tmpl/prog/en/includes/accounts.inc
>@@ -55,6 +55,7 @@
>         [%- CASE 'FORGIVEN'   -%]<span> (Forgiven)</span>
>         [%- CASE 'VOID'       -%]<span> (Voided)</span>
>         [%- CASE 'LOST'       -%]<span> (Lost)</span>
>+        [%- CASE 'CANCELLED'  -%]<span> (Cancelled)</span>
>         [%- CASE              -%]
>     [%- END -%]
> [%- END -%]
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/members/boraccount.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/members/boraccount.tt
>index a6a8cdc485..cc6d0f0cbd 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/members/boraccount.tt
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/members/boraccount.tt
>@@ -89,8 +89,19 @@
>         [% IF account.is_debit && account.amountoutstanding > 0 %]
>             <a class="btn btn-default btn-xs" href="/cgi-bin/koha/members/paycollect.pl?borrowernumber=[% account.borrowernumber | html %]&pay_individual=1&debit_type_code=[% account.debit_type_code | html %]&amount=[% account.amount | html %]&amountoutstanding=[% account.amountoutstanding | html %]&description=[% account.description | html %]&itemnumber=[% account.itemnumber | html %]&accountlines_id=[% account.accountlines_id | html %]">Pay</a>
>         [% END %]
>-        [% IF account.is_credit %]
>-          <a href="boraccount.pl?action=void&amp;accountlines_id=[% account.accountlines_id | uri %]&amp;borrowernumber=[% account.borrowernumber | uri %]" class="btn btn-default btn-xs void"><i class="fa fa-ban"></i> Void</a>
>+        [% IF account.is_credit && account.status != 'VOID' %]
>+          <a href="boraccount.pl?action=void&amp;accountlines_id=[% account.accountlines_id | uri %]&amp;borrowernumber=[% account.borrowernumber | uri %]" class="btn btn-default btn-xs void"><i class="fa fa-ban"></i> Void payment</a>
>+        [% END %]
>+        [% IF account.is_debit && account.amount == account.amountoutstanding && account.status != 'CANCELLED' %]
>+          <form method="post" action="/cgi-bin/koha/members/cancel-charge.pl">
>+            <input type="hidden" name="csrf_token" value="[% csrf_token | html %]">
>+            <input type="hidden" name="borrowernumber" value="[% patron.borrowernumber | html %]">
>+            <input type="hidden" name="accountlines_id" value="[% account.accountlines_id | html %]">
>+            <button type="submit" class="btn btn-default btn-xs">
>+                <i class="fa fa-ban"></i>
>+                Cancel charge
>+            </button>
>+          </form>
>         [% END %]
>         [% IF CAN_user_updatecharges_payout && account.is_credit && ( account.amountoutstanding < 0 ) %]
>           <button type="button" data-toggle="modal" data-target="#issuePayoutModal" data-account="[%- PROCESS account_type_description account=account -%]" data-accountline="[% account.accountlines_id | html %]" data-amount="[% account.amountoutstanding | $Price %]" class="btn btn-default btn-xs"><i class="fa fa-money"></i> Issue payout</button>
>diff --git a/members/boraccount.pl b/members/boraccount.pl
>index 71546a7efc..7eebf1f5b5 100755
>--- a/members/boraccount.pl
>+++ b/members/boraccount.pl
>@@ -34,6 +34,7 @@ use Koha::Cash::Registers;
> use Koha::Patrons;
> use Koha::Patron::Categories;
> use Koha::Items;
>+use Koha::Token;
> 
> my $input=new CGI;
> 
>@@ -202,6 +203,10 @@ foreach my $renew_result(@renew_results) {
>     };
> }
> 
>+my $csrf_token = Koha::Token->new->generate_csrf({
>+    session_id => scalar $input->cookie('CGISESSID'),
>+});
>+
> $template->param(
>     patron              => $patron,
>     finesview           => 1,
>@@ -211,6 +216,7 @@ $template->param(
>     payment_id          => $payment_id,
>     change_given        => $change_given,
>     renew_results       => $renew_results_display,
>+    csrf_token          => $csrf_token,
> );
> 
> output_html_with_http_headers $input, $cookie, $template->output;
>diff --git a/members/cancel-charge.pl b/members/cancel-charge.pl
>new file mode 100755
>index 0000000000..4aa0b00517
>--- /dev/null
>+++ b/members/cancel-charge.pl
>@@ -0,0 +1,48 @@
>+#!/usr/bin/perl
>+
>+# 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>.
>+
>+use Modern::Perl;
>+
>+use CGI;
>+
>+use C4::Auth;
>+use Koha::Token;
>+
>+my $cgi = CGI->new;
>+
>+my $authnotrequired = 0;
>+my $flags = { updatecharges => 'remaining_permissions' };
>+my $type = 'intranet';
>+my ($user, $cookie) = C4::Auth::checkauth($cgi, $authnotrequired, $flags, $type);
>+
>+my $csrf_token_is_valid = Koha::Token->new->check_csrf( {
>+    session_id => scalar $cgi->cookie('CGISESSID'),
>+    token  => scalar $cgi->param('csrf_token'),
>+});
>+unless ($csrf_token_is_valid) {
>+    print $cgi->header('text/plain', '403 Forbidden');
>+    print 'Wrong CSRF token';
>+    exit;
>+}
>+
>+my $borrowernumber = $cgi->param('borrowernumber');
>+my $accountlines_id = $cgi->param('accountlines_id');
>+
>+my $line = Koha::Account::Lines->find($accountlines_id);
>+$line->cancel();
>+
>+print $cgi->redirect('/cgi-bin/koha/members/boraccount.pl?borrowernumber=' . $borrowernumber);
>diff --git a/t/db_dependent/Koha/Account/Line.t b/t/db_dependent/Koha/Account/Line.t
>index fe0376388c..f757ae0f92 100755
>--- a/t/db_dependent/Koha/Account/Line.t
>+++ b/t/db_dependent/Koha/Account/Line.t
>@@ -1076,4 +1076,70 @@ subtest "reduce() tests" => sub {
>     $schema->storage->txn_rollback;
> };
> 
>+subtest "cancel() tests" => sub {
>+    plan tests => 9;
>+
>+    $schema->storage->txn_begin;
>+
>+    # Create a borrower
>+    my $categorycode = $builder->build({ source => 'Category' })->{ categorycode };
>+    my $branchcode   = $builder->build({ source => 'Branch' })->{ branchcode };
>+
>+    my $borrower = Koha::Patron->new( {
>+        cardnumber => 'dariahall',
>+        surname => 'Hall',
>+        firstname => 'Daria',
>+    } );
>+    $borrower->categorycode( $categorycode );
>+    $borrower->branchcode( $branchcode );
>+    $borrower->store;
>+
>+    t::lib::Mocks::mock_userenv({ branchcode => $branchcode, borrowernumber => $borrower->borrowernumber });
>+
>+    my $account = Koha::Account->new({ patron_id => $borrower->id });
>+
>+    my $line1 = Koha::Account::Line->new(
>+        {
>+            borrowernumber    => $borrower->borrowernumber,
>+            amount            => 10,
>+            amountoutstanding => 10,
>+            interface         => 'commandline',
>+            debit_type_code   => 'OVERDUE',
>+        }
>+    )->store();
>+    my $line2 = Koha::Account::Line->new(
>+        {
>+            borrowernumber    => $borrower->borrowernumber,
>+            amount            => 20,
>+            amountoutstanding => 20,
>+            interface         => 'commandline',
>+            debit_type_code   => 'OVERDUE',
>+        }
>+    )->store();
>+
>+    my $id = $account->pay({
>+        lines  => [$line2],
>+        amount => 5,
>+    });
>+
>+    is( $account->balance(), 25, "Account balance is 25" );
>+    is( $line1->amountoutstanding+0, 10, 'First fee has amount outstanding of 10' );
>+    is( $line2->amountoutstanding+0, 15, 'Second fee has amount outstanding of 15' );
>+
>+    my $ret = $line1->cancel();
>+    is( ref($ret), 'Koha::Account::Line', 'Cancel returns the account line' );
>+    is( $account->balance(), 15, "Account balance is 15" );
>+    is( $line1->amount+0, 0, 'First fee has amount of 0' );
>+    is( $line1->amountoutstanding+0, 0, 'First fee has amount outstanding of 0' );
>+
>+    $ret = $line2->cancel();
>+    is ($ret, undef, 'cancel returns undef when line cannot be cancelled');
>+
>+    my $account_payment = Koha::Account::Lines->find($id);
>+    $ret = $account_payment->cancel();
>+    is ($ret, undef, 'payment cannot be cancelled');
>+
>+    $schema->storage->txn_rollback;
>+};
>+
> 1;
>-- 
>2.11.0

Actions: View | Diff | Splinter Review

Attachments on bug 24603: 98534 | 98551 | 102005 | 106772 | 111217 | 111218 | 111255 | 111256 | 111794 | 111795 | 111796 | 111797 | 111914 | 113048 | 113049 | 113050 | 113051 | 113052 | 113113 | 113114