Bug 31095: Remove GetDebarments from circ/circulation.pl

This patch remove the use of GetDebarments from circ/circulation.pl,
replacing it with a reference to patron.restrictions in the template and
includes.

Test plan
1. Confirm that the 'Restrictions (x)' tab still appears on the checkout
   page for a user.
2. Confirm that the 'Restrictions (x)' tab count is correct
3. Confirm that the 'Restrictions (x)' tab table functions
4. Confirm that the 'Restrictions (x)' tab 'Add manual restriction' form
   works as expected

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

circ/circulation.pl

@@ -44,7 +44,6 @@ use CGI::Session;
 use Koha::AuthorisedValues;
 use Koha::CsvProfiles;
 use Koha::Patrons;
-use Koha::Patron::Debarments qw( GetDebarments );
 use Koha::DateUtils qw( dt_from_string );
 use Koha::Patron::Restriction::Types;
 use Koha::Plugins;
@@ -626,10 +625,9 @@ my $has_modifications = Koha::Patron::Modifications->search( { borrowernumber =>
 $template->param(
     debt_confirmed            => $debt_confirmed,
     SpecifyDueDate            => $duedatespec_allow,
-    PatronAutoComplete      => C4::Context->preference("PatronAutoComplete"),
-    debarments                => scalar GetDebarments({ borrowernumber => $borrowernumber }),
+    PatronAutoComplete        => C4::Context->preference("PatronAutoComplete"),
     todaysdate                => dt_from_string()->set(hour => 23)->set(minute => 59),
-    restriction_types         => scalar Koha::Patron::Restriction::Types->keyed_on_code(),
+    restriction_types         => scalar Koha::Patron::Restriction::Types->search(),
     has_modifications         => $has_modifications,
     override_high_holds       => $override_high_holds,
     nopermission              => scalar $query->param('nopermission'),

koha-tmpl/intranet-tmpl/prog/en/includes/patron-restrictions-tab.inc

@@ -0,0 +1,81 @@
+[% USE raw %]
+[% USE Koha %]
+[% PROCESS 'restriction-types.inc' %]
+<div id="reldebarments" role="tabpanel" class="tab-pane">
+    [% IF ( patron.restrictions.count == 0 ) %]
+        <p>Patron is currently unrestricted.</p>
+    [% ELSE %]
+        <table>
+            <thead>
+                <tr>
+                     <th>Type</th>
+                     <th>Comment</th>
+                     <th>Expiration</th>
+                     <th>Created</th>
+                     [% IF CAN_user_borrowers_edit_borrowers && CAN_user_circulate_manage_restrictions %]
+                         <th>&nbsp;</th>
+                     [% END %]
+                </tr>
+            </thead>
+            <tbody>
+                [% FOREACH restriction IN patron.restrictions %]
+                    <tr>
+                        <td>
+                            [% PROCESS restriction_type_description restriction_type=restriction.type %]
+                        </td>
+                        <td>
+                            [% IF restriction.comment.search('OVERDUES_PROCESS') %]
+                                <span>Restriction added by overdues process [% restriction.comment.remove('OVERDUES_PROCESS ') | $raw %]</span>
+                            [% ELSE %]
+                                [% restriction.comment | $raw %]
+                            [% END %]
+                        </td>
+                        <td>[% IF restriction.expiration %] [% restriction.expiration | $KohaDates %] [% ELSE %] <em>Indefinite</em> [% END %]</td>
+                        <td>[% restriction.created | $KohaDates %]</td>
+                        [% IF CAN_user_borrowers_edit_borrowers && CAN_user_circulate_manage_restrictions %]
+                            <td>
+                                <a class="remove_restriction btn btn-default btn-xs" href="/cgi-bin/koha/members/mod_debarment.pl?borrowernumber=[% patron.borrowernumber | html %]&amp;borrower_debarment_id=[% restriction.borrower_debarment_id | html %]&amp;action=del">
+                                    <i class="fa fa-trash"></i> Remove
+                                </a>
+                            </td>
+                        [% END %]
+                    </tr>
+                [% END %]
+            </tbody>
+        </table>
+    [% END %]
+    [% IF CAN_user_borrowers_edit_borrowers && CAN_user_circulate_manage_restrictions %]
+        <p><a href="#" id="add_manual_restriction"><i class="fa fa-plus"></i> Add manual restriction</a></p>
+        <form method="post" action="/cgi-bin/koha/members/mod_debarment.pl" class="clearfix">
+            <input type="hidden" name="borrowernumber" value="[% patron.borrowernumber | html %]" />
+            <input type="hidden" name="action" value="add" />
+            <fieldset class="rows" id="manual_restriction_form">
+                <legend>Add manual restriction</legend>
+                <ol>
+                    [% IF Koha.Preference('PatronRestrictionTypes') %]
+                    <li>
+                        <label for="debarred_type">Type:</label>
+                        <select name="debarred_type">
+                            [% FOREACH restriction_type IN restriction_types %]
+                                [% IF !restriction_type.is_system %]
+                                   [% IF restriction_type.is_default %]
+                                   <option value="[% code | html %]" selected>[% PROCESS restriction_type_description %]</option>
+                                   [% ELSE %]
+                                   <option value="[% code | html %]">[% PROCESS restriction_type_description %]</option>
+                                   [% END %]
+                                [% END %]
+                            [% END %]
+                        </select>
+                    </li>
+                    [% END %]
+                    <li><label for="rcomment">Comment:</label> <input type="text" id="rcomment" name="comment" /></li>
+                    <li>
+                        <label for="rexpiration">Expiration:</label>
+                        <input name="expiration" id="rexpiration" size="20" value="" class="flatpickr" data-flatpickr-futuredate="true" type="text" />
+                    </li>
+                </ol>
+            <fieldset class="action"><input type="submit" value="Add restriction" /> <a href="#" class="cancel" id="cancel_manual_restriction">Cancel</a></fieldset>
+            </fieldset>
+        </form>
+    [% END %]
+</div>

koha-tmpl/intranet-tmpl/prog/en/includes/restriction-types.inc

@@ -0,0 +1,10 @@
+[%- BLOCK restriction_type_description -%]
+    [%- ddisplay = restriction_type.display_text -%]
+    [%- SWITCH ddisplay -%]
+        [%- CASE 'Manual' -%]<span>Manual</span>
+        [%- CASE 'Overdues' -%]<span>Overdues</span>
+        [%- CASE 'Suspension' -%]<span>Suspension</span>
+        [%- CASE 'Discharge' -%]<span>Discharge</span>
+        [%- CASE -%]<span>[% ddisplay | html %]</span>
+    [%- END -%]
+[%- END -%]

koha-tmpl/intranet-tmpl/prog/en/modules/circ/circulation.tt

@@ -881,7 +881,7 @@
                         [% END %]
 
                         <li role="presentation">
-                            <a id="debarments-tab-link" href="#reldebarments" aria-controls="reldebarments" role="tab" data-toggle="tab">Restrictions ([% debarments.size || 0 | html %])</a>
+                            <a id="debarments-tab-link" href="#reldebarments" aria-controls="reldebarments" role="tab" data-toggle="tab">Restrictions ([% patron.restrictions.count || 0 | html %])</a>
                         </li>
 
                         [% SET enrollments = patron.get_club_enrollments %]
@@ -908,7 +908,7 @@
                             </div> <!-- /#clubs-tab -->
                         [% END %]
 
-                        [% INCLUDE borrower_debarments.inc %]
+                        [% INCLUDE "patron-restrictions-tab.inc" %]
 
                         <div id="reserves" role="tabpanel" class="tab-pane">
                             [% IF ( holds_count ) %]