From ed439f28c5b2bc390cdb7f94d309c1c815f5a9c1 Mon Sep 17 00:00:00 2001
From: Pedro Amorim <pedro.amorim@ptfs-europe.com>
Date: Fri, 2 Feb 2024 15:12:27 +0000
Subject: [PATCH] Bug 34478: ILL OPAC: method => op

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
---
 Koha/Illrequest/Workflow/Availability.pm      |  2 +-
 Koha/Illrequest/Workflow/TypeDisclaimer.pm    |  2 +-
 .../bootstrap/en/modules/opac-illrequests.tt  | 36 +++++++++----------
 opac/opac-illrequests.pl                      | 27 ++++++++++----
 4 files changed, 41 insertions(+), 26 deletions(-)

diff --git a/Koha/Illrequest/Workflow/Availability.pm b/Koha/Illrequest/Workflow/Availability.pm
index bcc50f6fe7..7094dcc3c8 100644
--- a/Koha/Illrequest/Workflow/Availability.pm
+++ b/Koha/Illrequest/Workflow/Availability.pm
@@ -137,7 +137,7 @@ sub availability_template_params {
         ? (
             illrequestsview => 1,
             message         => $params->{message},
-            method          => 'availability',
+            op              => 'availability',
           )
         : ()
     );
diff --git a/Koha/Illrequest/Workflow/TypeDisclaimer.pm b/Koha/Illrequest/Workflow/TypeDisclaimer.pm
index dea466d9be..51a20cce89 100644
--- a/Koha/Illrequest/Workflow/TypeDisclaimer.pm
+++ b/Koha/Illrequest/Workflow/TypeDisclaimer.pm
@@ -105,7 +105,7 @@ sub type_disclaimer_template_params {
         ? (
             illrequestsview => 1,
             message         => $params->{message},
-            method          => 'typedisclaimer',
+            op              => 'typedisclaimer',
           )
         : ()
     );
diff --git a/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-illrequests.tt b/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-illrequests.tt
index 4b7af4d7e6..3d39035b7d 100644
--- a/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-illrequests.tt
+++ b/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-illrequests.tt
@@ -28,19 +28,19 @@
             [% END %]
         [% END %]
 
-        [% IF method != 'list' %]
+        [% IF op != 'list' %]
             [% WRAPPER breadcrumb_item %]
                 <a href="/cgi-bin/koha/opac-illrequests.pl">Interlibrary loan requests</a>
             [% END %]
-            [% IF method == 'create' %]
+            [% IF op == 'create' %]
                 [% WRAPPER breadcrumb_item bc_active= 1 %]
                     <span>New interlibrary loan request</span>
                 [% END %]
-            [% ELSIF method == 'view' %]
+            [% ELSIF op == 'view' %]
                 [% WRAPPER breadcrumb_item bc_active= 1 %]
                     <span>View interlibrary loan request</span>
                 [% END %]
-            [% ELSIF method == 'typedisclaimer' %]
+            [% ELSIF op == 'typedisclaimer' %]
                 [% WRAPPER breadcrumb_item bc_active= 1 %]
                     <span>Ill request disclaimer</span>
                 [% END %]
@@ -72,7 +72,7 @@
                     <div class="alert alert-warning">ILL module configuration problem. Contact your administrator.</div>
                 [% ELSE %]
                     <div id="illrequests" class="maincontent">
-                        [% IF method == 'create' %]
+                        [% IF op == 'create' %]
                             <h1>New interlibrary loan request</h1>
                             [% IF stage == 'copyrightclearance' %]
                                 [% INCLUDE messages %]
@@ -101,7 +101,7 @@
                                             </select>
                                         </fieldset>
                                         <fieldset class="action">
-                                            <input type="hidden" name="method" value="create" />
+                                            <input type="hidden" name="op" value="create" />
                                             <input type="submit" name="create_select_backend" value="Next" />
                                         </fieldset>
                                     </form>
@@ -109,7 +109,7 @@
                                     [% PROCESS $whole.opac_template %]
                                 [% END %]
                             [% END # /IF stage == 'copyrightclearance' %]
-                        [% ELSIF method == 'list' %]
+                        [% ELSIF op == 'list' %]
                             <h1>Interlibrary loan requests</h1>
                             [% INCLUDE messages %]
 
@@ -121,11 +121,11 @@
                                         </button>
                                         <div id="backend-dropdown-options" class="dropdown-menu nojs" aria-labelledby="ill-backend-dropdown">
                                             [% FOREACH backend IN backends %]
-                                                <a class="dropdown-item" href="/cgi-bin/koha/opac-illrequests.pl?method=create&amp;backend=[% backend | uri %]">[% backend | html %]</a>
+                                                <a class="dropdown-item" href="/cgi-bin/koha/opac-illrequests.pl?op=create&amp;backend=[% backend | uri %]">[% backend | html %]</a>
                                             [% END %]
                                         </div>
                                     [% ELSE %]
-                                        <a id="ill-new" class="btn btn-primary" href="/cgi-bin/koha/opac-illrequests.pl?method=create&amp;backend=[% backends.0 | html %]">
+                                        <a id="ill-new" class="btn btn-primary" href="/cgi-bin/koha/opac-illrequests.pl?op=create&amp;backend=[% backends.0 | html %]">
                                             <i class="fa fa-plus" aria-hidden="true"></i> Create a new request
                                         </a>
                                     [% END %]
@@ -167,17 +167,17 @@
                                             <td data-order="[% request.placed | html %]">[% request.placed | $KohaDates %]</td>
                                             <td data-order="[% request.updated | html %]">[% request.updated | $KohaDates %]</td>
                                             <td>
-                                                <a href="/cgi-bin/koha/opac-illrequests.pl?method=view&amp;illrequest_id=[% request.id | uri %]" class="btn btn-primary btn-sm pull-right">View</a>
+                                                <a href="/cgi-bin/koha/opac-illrequests.pl?op=view&amp;illrequest_id=[% request.id | uri %]" class="btn btn-primary btn-sm pull-right">View</a>
                                             </td>
                                         </tr>
                                     [% END %]
                                 </tbody>
                             </table>
-                        [% ELSIF method == 'view' %]
+                        [% ELSIF op == 'view' %]
                             <h1>View interlibrary loan request</h1>
                             [% INCLUDE messages %]
                             [% status = request.status %]
-                            <form method="post" action="?method=update" id="illrequestupdate-form" novalidate="novalidate">
+                            <form method="post" action="?op=update" id="illrequestupdate-form" novalidate="novalidate">
                                 [% INCLUDE 'csrf-token.inc' %]
                                 <fieldset class="rows">
                                     <legend id="library_legend">Details from library</legend>
@@ -239,10 +239,10 @@
                             [% IF can_place_ill_in_opac %]
                                 <fieldset class="action illrequest-actions">
                                     <input type="hidden" name="illrequest_id" value="[% request.illrequest_id | html %]" />
-                                    <input type="hidden" name="method" value="update" />
+                                    <input type="hidden" name="op" value="update" />
                                     [% IF !request.completed %]
                                         [% IF request.status == "NEW" %]
-                                            <a class="cancel-illrequest btn btn-danger" href="/cgi-bin/koha/opac-illrequests.pl?method=cancreq&amp;illrequest_id=[% request.illrequest_id | html %]">Request cancellation</a>
+                                            <a class="cancel-illrequest btn btn-danger" href="/cgi-bin/koha/opac-illrequests.pl?op=cancreq&amp;illrequest_id=[% request.illrequest_id | html %]">Request cancellation</a>
                                         [% END %]
                                         <input type="submit" class="update-illrequest btn btn-primary" value="Submit modifications" />
                                     [% END %]
@@ -250,7 +250,7 @@
                                 </fieldset>
                             [% END %]
                             </form>
-                        [% ELSIF method == 'availability' %]
+                        [% ELSIF op == 'availability' %]
                             <h1>Interlibrary loan item availability</h1>
                             <div id="results">
                                 <form method="POST" action="/cgi-bin/koha/opac-illrequests.pl">
@@ -282,7 +282,7 @@
                                     [% INCLUDE 'ill-availability-table.inc' service=service %]
                                 [% END %]
                             </div> <!-- /#illrequestupdate-form -->
-                        [% ELSIF method == 'typedisclaimer' %]
+                        [% ELSIF op == 'typedisclaimer' %]
                             <h1>ILL request disclaimer</h1>
                             <div id="results" class="page-section">
                                 [% INCLUDE messages %]
@@ -321,7 +321,7 @@
                                     </fieldset>
                                 </form>
                             </div>
-                        [% END # / IF method == 'create' %]
+                        [% END # / IF op == 'create' %]
                     </div> <!-- / #illrequests -->
                 [% END # /IF !backends_available %]
             </div> <!-- / .col-lg-10/12 -->
@@ -351,7 +351,7 @@
             var metadata = "[% metadata | $raw %]";
         [% END %]
     </script>
-    [% IF method == 'availability' %]
+    [% IF op == 'availability' %]
         [% Asset.js("js/ill-availability.js") | $raw %]
         <script>
             $(document).ready(function() {
diff --git a/opac/opac-illrequests.pl b/opac/opac-illrequests.pl
index 4ad18ca42a..74ec1cad3b 100755
--- a/opac/opac-illrequests.pl
+++ b/opac/opac-illrequests.pl
@@ -27,6 +27,8 @@ use C4::Koha;
 use C4::Output qw( output_html_with_http_headers );
 use POSIX qw( strftime );
 
+use Mojo::Util qw(deprecated);
+
 use Koha::Illrequest::Config;
 use Koha::Illrequests;
 use Koha::Libraries;
@@ -60,7 +62,9 @@ my $backends_available = ( scalar @{$backends} > 0 );
 $template->param( backends_available => $backends_available );
 my $patron = Koha::Patrons->find($loggedinuser);
 
-my $op = $params->{'method'} || 'list';
+show_param_deprecation_message('"method" form param is DEPRECATED in favor of "op".') if ( $params->{'method'} );
+
+my $op = $params->{'op'} // $params->{'method'} // 'list';
 
 my ( $illrequest_id, $request );
 if ( $illrequest_id = $params->{illrequest_id} ) {
@@ -97,14 +101,14 @@ if ( $op eq 'list' ) {
     # Send a notice to staff alerting them of the update
     $request->send_staff_notice('ILL_REQUEST_MODIFIED');
     print $query->redirect(
-            '/cgi-bin/koha/opac-illrequests.pl?method=view&illrequest_id='
+            '/cgi-bin/koha/opac-illrequests.pl?op=view&illrequest_id='
           . $illrequest_id
           . '&message=1' );
     exit;
 } elsif ( $op eq 'cancreq') {
     $request->status('CANCREQ')->store;
     print $query->redirect(
-            '/cgi-bin/koha/opac-illrequests.pl?method=view&illrequest_id='
+            '/cgi-bin/koha/opac-illrequests.pl?op=view&illrequest_id='
           . $illrequest_id
           . '&message=1' );
     exit;
@@ -178,11 +182,22 @@ if ( $op eq 'list' ) {
     }
 }
 
+=head3 show_param_deprecation_message
+
+Generate deprecation message for the given parameter and append the backend information if available
+
+=cut
+sub show_param_deprecation_message {
+    my ($message) = @_;
+    $message .= ' Used by ' . $params->{'backend'} . ' backend' if $params->{'backend'};
+    deprecated $message;
+}
+
 $template->param(
     can_place_ill_in_opac => $patron->_result->categorycode->can_place_ill_in_opac,
-    message         => $params->{message},
-    illrequestsview => 1,
-    method          => $op
+    message               => $params->{message},
+    illrequestsview       => 1,
+    op                    => $op
 );
 
 output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };
-- 
2.39.2