From 25d005be9398c4419858f7fde070de4985ee28fc Mon Sep 17 00:00:00 2001
From: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Date: Tue, 16 Aug 2022 12:36:55 +0100
Subject: [PATCH] Bug 31028: Add 'Add catalog concern' to cataloguing toolbar

This patch moves the add concern modal js and template markup into their
own files and then references them to add the 'Add concern' option to
the cataloguing toolbar.
---
 .../prog/en/includes/cat-toolbar.inc          |  5 +-
 .../includes/modals/add_catalog_concern.inc   | 36 +++++++++++
 .../prog/en/modules/catalogue/ISBDdetail.tt   | 11 ++++
 .../prog/en/modules/catalogue/MARCdetail.tt   | 10 ++++
 .../prog/en/modules/catalogue/detail.tt       | 11 ++++
 .../prog/en/modules/catalogue/imageviewer.tt  | 11 ++++
 .../en/modules/catalogue/labeledMARCdetail.tt | 11 ++++
 .../prog/en/modules/catalogue/moredetail.tt   | 11 ++++
 .../prog/en/modules/cataloguing/concerns.tt   | 59 +------------------
 .../prog/en/modules/circ/returns.tt           | 12 +++-
 .../prog/js/modals/add_catalog_concern.js     | 26 ++++++++
 11 files changed, 144 insertions(+), 59 deletions(-)
 create mode 100644 koha-tmpl/intranet-tmpl/prog/en/includes/modals/add_catalog_concern.inc
 create mode 100644 koha-tmpl/intranet-tmpl/prog/js/modals/add_catalog_concern.js

diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/cat-toolbar.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/cat-toolbar.inc
index a1ca101dba..b9a4c3184f 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/includes/cat-toolbar.inc
+++ b/koha-tmpl/intranet-tmpl/prog/en/includes/cat-toolbar.inc
@@ -2,7 +2,7 @@
 [% INCLUDE 'blocking_errors.inc' %]
 <div id="toolbar" class="btn-toolbar">
 
-[% IF ( CAN_user_editcatalogue_edit_catalogue || CAN_user_editcatalogue_edit_items || CAN_user_serials_create_subscription ) %]
+[% IF ( CAN_user_editcatalogue_edit_catalogue || CAN_user_editcatalogue_edit_items || CAN_user_serials_create_subscription || Koha.Preference('CatalogConcerns') ) %]
     <div class="btn-group">
     <button class="btn btn-default dropdown-toggle" data-toggle="dropdown"><i class="fa fa-plus"></i> New <span class="caret"></span></button>
         <ul class="dropdown-menu">
@@ -23,6 +23,9 @@
             [% IF CAN_user_editcatalogue_edit_catalogue && ! EasyAnalyticalRecords %]
                 <li><a href="/cgi-bin/koha/cataloguing/addbiblio.pl?parentbiblionumber=[% biblionumber | uri %]">New child record</a></li>
             [% END %]
+            [% IF Koha.Preference('CatalogConcerns') %]
+                <li><a id="newconcern" role="button" href="#" data-toggle="modal" data-target="#addConcernModal">New catalog concern</a></li>
+            [% END %]
     </ul>
     </div>
 [% END %]
diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/modals/add_catalog_concern.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/modals/add_catalog_concern.inc
new file mode 100644
index 0000000000..10bf54c9bb
--- /dev/null
+++ b/koha-tmpl/intranet-tmpl/prog/en/includes/modals/add_catalog_concern.inc
@@ -0,0 +1,36 @@
+<!-- Add concern modal -->
+<div class="modal" id="addConcernModal" tabindex="-1" role="dialog" aria-labelledby="addConcernLabel">
+    <div class="modal-dialog" role="document">
+        <div class="modal-content">
+            <div class="modal-header">
+                <button type="button" class="closebtn" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
+                <h4 class="modal-title" id="addConcernLabel">Add concern</h4>
+            </div>
+            <div class="modal-body">
+                <fieldset class="rows">
+                    <ol>
+                        [% IF biblionumber %]
+                        <input type="hidden" id="biblio_add" name="biblio_id" value="[% biblionumber %]">
+                        [% ELSE %]
+                        <li>
+                            <label class="required" for="biblio_id">Biblio: </label>
+                            <input type="text" name="biblio_id" id="biblio_add">
+                            <span class="required">Required</span>
+                        </li>
+                        [% END %]
+                        <li>
+                            <label class="required" for="message">Please describe your concern: </label>
+                            <textarea id="message_add" name="message" required="required"></textarea>
+                            <span class="required">Required</span>
+                            <p id="helpBlock" class="help-block">A short summary of what the library policy is for dealing with such concerns and what constitutes a valid concern</p>
+                        </li>
+                    </ol>
+                </fieldset>
+            </div> <!-- /.modal-body -->
+            <div class="modal-footer">
+                <button type="submit" class="btn btn-default" id="addConfirm">Confirm</button>
+                <button type="button" class="btn btn-default" data-dismiss="modal">Cancel</button>
+            </div> <!-- /.modal-footer -->
+        </div> <!-- /.modal-content -->
+    </div> <!-- /.modal-dialog -->
+</div> <!-- /#addConcernModal -->
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/ISBDdetail.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/ISBDdetail.tt
index 00e019de88..c64a7f5886 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/ISBDdetail.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/ISBDdetail.tt
@@ -82,10 +82,21 @@
         </div> <!-- /.col-sm-2.col-sm-pull-10 -->
      </div> <!-- /.row -->
 
+    [% IF ( Koha.Preference('CatalogConcerns') ) %]
+    [% INCLUDE 'modals/add_catalog_concern.inc' %]
+    [% END %]
+
 [% MACRO jsinclude BLOCK %]
     [% INCLUDE 'catalog-strings.inc' %]
     [% Asset.js("js/catalog.js") | $raw %]
     [% Asset.js("js/browser.js") | $raw %]
+    [% IF ( Koha.Preference('CatalogConcerns') ) %]
+        <script>
+            /* Set a variable needed by add_catalog_concern.js */
+            var logged_in_user_borrowernumber = "[% logged_in_user.borrowernumber | html %]";
+        </script>
+        [% Asset.js("js/modals/add_catalog_concern.js") | $raw %]
+    [% END %]
     <script>
         var browser = KOHA.browser('[% searchid | html %]', parseInt('[% biblionumber | html %]', 10));
         browser.show();
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/MARCdetail.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/MARCdetail.tt
index 1a4ecb6b86..0b21b142d9 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/MARCdetail.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/MARCdetail.tt
@@ -206,11 +206,21 @@
 
 [% END %]
 
+    [% IF ( Koha.Preference('CatalogConcerns') ) %]
+    [% INCLUDE 'modals/add_catalog_concern.inc' %]
+    [% END %]
 
 [% MACRO jsinclude BLOCK %]
     [% INCLUDE 'catalog-strings.inc' %]
     [% Asset.js("js/catalog.js") | $raw %]
     [% Asset.js("js/browser.js") | $raw %]
+    [% IF ( Koha.Preference('CatalogConcerns') ) %]
+        <script>
+            /* Set a variable needed by add_catalog_concern.js */
+            var logged_in_user_borrowernumber = "[% logged_in_user.borrowernumber | html %]";
+        </script>
+        [% Asset.js("js/modals/add_catalog_concern.js") | $raw %]
+    [% END %]
     <script>
         var browser = KOHA.browser('[% searchid | html %]', parseInt('[% biblionumber | html %]', 10));
         browser.show();
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/detail.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/detail.tt
index f48413a010..022c126190 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/detail.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/detail.tt
@@ -1294,12 +1294,23 @@ Note that permanent location is a code, and location may be an authval.
     </div>
     [% END %]
 
+    [% IF ( Koha.Preference('CatalogConcerns') ) %]
+    [% INCLUDE 'modals/add_catalog_concern.inc' %]
+    [% END %]
+
 [% MACRO jsinclude BLOCK %]
     [% INCLUDE 'catalog-strings.inc' %]
     [% Asset.js("js/catalog.js") | $raw %]
     [% Asset.js("js/recalls.js") | $raw %]
     [% Asset.js("js/coce.js") | $raw %]
     [% Asset.js("lib/Chocolat/js/chocolat.js") | $raw %]
+    [% IF ( Koha.Preference('CatalogConcerns') ) %]
+        <script>
+            /* Set a variable needed by add_catalog_concern.js */
+            var logged_in_user_borrowernumber = "[% logged_in_user.borrowernumber | html %]";
+        </script>
+        [% Asset.js("js/modals/add_catalog_concern.js") | $raw %]
+    [% END %]
     <script>
         var interface = "[% interface | html %]";
         var theme = "[% theme | html %]";
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/imageviewer.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/imageviewer.tt
index 63cbeea4c4..03c2550f94 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/imageviewer.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/imageviewer.tt
@@ -130,9 +130,20 @@
         </div> <!-- /.col-sm-2.col-sm-pull-10 -->
      </div> <!-- /.row -->
 
+    [% IF ( Koha.Preference('CatalogConcerns') ) %]
+    [% INCLUDE 'modals/add_catalog_concern.inc' %]
+    [% END %]
+
 [% MACRO jsinclude BLOCK %]
     [% INCLUDE 'catalog-strings.inc' %]
     [% Asset.js("js/catalog.js") | $raw %]
+    [% IF ( Koha.Preference('CatalogConcerns') ) %]
+        <script>
+            /* Set a variable needed by add_catalog_concern.js */
+            var logged_in_user_borrowernumber = "[% logged_in_user.borrowernumber | html %]";
+        </script>
+        [% Asset.js("js/modals/add_catalog_concern.js") | $raw %]
+    [% END %]
     <script>
         var interface = "[% interface | html %]";
         var theme = "[% theme | html %]";
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/labeledMARCdetail.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/labeledMARCdetail.tt
index 81732a1ce6..c17b5eab61 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/labeledMARCdetail.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/labeledMARCdetail.tt
@@ -92,10 +92,21 @@
      </div> <!-- /.row -->
 [% END %]
 
+[% IF ( Koha.Preference('CatalogConcerns') ) %]
+[% INCLUDE 'modals/add_catalog_concern.inc' %]
+[% END %]
+
 [% MACRO jsinclude BLOCK %]
     [% INCLUDE 'catalog-strings.inc' %]
     [% Asset.js("js/catalog.js") | $raw %]
     [% Asset.js("js/browser.js") | $raw %]
+    [% IF ( Koha.Preference('CatalogConcerns') ) %]
+        <script>
+            /* Set a variable needed by add_catalog_concern.js */
+            var logged_in_user_borrowernumber = "[% logged_in_user.borrowernumber | html %]";
+        </script>
+        [% Asset.js("js/modals/add_catalog_concern.js") | $raw %]
+    [% END %]
     <script>
     //<![CDATA[
         var browser = KOHA.browser('[% searchid | html %]', parseInt('[% biblionumber | html %]', 10));
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/moredetail.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/moredetail.tt
index 7b8cf7c8ba..9064d29d71 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/moredetail.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/moredetail.tt
@@ -386,6 +386,10 @@
         </div> <!-- /.col-sm-2.col-sm-pull-10 -->
      </div> <!-- /.row -->
 
+[% IF ( Koha.Preference('CatalogConcerns') ) %]
+[% INCLUDE 'modals/add_catalog_concern.inc' %]
+[% END %]
+
 [% MACRO jsinclude BLOCK %]
     [% INCLUDE 'catalog-strings.inc' %]
     [% INCLUDE 'modals/checkout_renewals.inc' %]
@@ -395,6 +399,13 @@
     [% Asset.js("js/catalog.js") | $raw %]
     [% Asset.js("js/browser.js") | $raw %]
     [% Asset.js("js/checkout_renewals_modal.js") | $raw %]
+    [% IF ( Koha.Preference('CatalogConcerns') ) %]
+        <script>
+            /* Set a variable needed by add_catalog_concern.js */
+            var logged_in_user_borrowernumber = "[% logged_in_user.borrowernumber | html %]";
+        </script>
+        [% Asset.js("js/modals/add_catalog_concern.js") | $raw %]
+    [% END %]
     <script>
         var browser = KOHA.browser('[% searchid | html %]', parseInt('[% biblionumber | html %]', 10));
         browser.show();
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/cataloguing/concerns.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/cataloguing/concerns.tt
index 1b5ff16e49..1415ce6d8a 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/cataloguing/concerns.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/cataloguing/concerns.tt
@@ -65,38 +65,7 @@
             </div> <!-- /.col-sm-2.col-sm-pull-10 -->
         </div> <!-- /.row -->
 
-        <!-- Add concern modal -->
-        <div class="modal" id="addConcernModal" tabindex="-1" role="dialog" aria-labelledby="addConcernLabel">
-            <div class="modal-dialog" role="document">
-                <div class="modal-content">
-                    <div class="modal-header">
-                        <button type="button" class="closebtn" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
-                        <h4 class="modal-title" id="addConcernLabel">Add concern</h4>
-                    </div>
-                    <div class="modal-body">
-                        <fieldset class="rows">
-                            <ol>
-                                <li>
-                                    <label class="required" for="biblio_id">Biblio: </label>
-                                    <input type="text" name="biblio_id" id="biblio_add">
-                                    <span class="required">Required</span>
-                                </li>
-                                <li>
-                                    <label class="required" for="message">Please describe your concern: </label>
-                                    <textarea id="message_add" name="message" required="required"></textarea>
-                                    <span class="required">Required</span>
-                                    <p id="helpBlock" class="help-block">A short summary of what the library policy is for dealing with such concerns and what constitutes a valid concern</p>
-                                </li>
-                            </ol>
-                        </fieldset>
-                    </div> <!-- /.modal-body -->
-                    <div class="modal-footer">
-                        <button type="submit" class="btn btn-default" id="addConfirm">Confirm</button>
-                        <button type="button" class="btn btn-default" data-dismiss="modal">Cancel</button>
-                    </div> <!-- /.modal-footer -->
-                </div> <!-- /.modal-content -->
-            </div> <!-- /.modal-dialog -->
-        </div> <!-- /#addConcernModal -->
+        [% INCLUDE 'modals/add_catalog_concern.inc' %]
 
         <!-- Resolve concern modal -->
         <div class="modal" id="resolveConcernModal" tabindex="-1" role="dialog" aria-labelledby="resolveConcernLabel">
@@ -137,6 +106,7 @@
     [% INCLUDE 'js-date-format.inc' %]
     [% INCLUDE 'js-patron-format.inc' %]
     [% INCLUDE 'js-biblio-format.inc' %]
+    [% Asset.js("js/modals/add_catalog_concern.js") | $raw %]
     <script>
         $(document).ready(function() {
 
@@ -262,31 +232,6 @@
                     $("#concern_resolve_error").html(_("Error resolving concern #%s. Check the logs.").format(concern_id)).show();
                 });
             });
-
-            $('#addConcernModal').on('click', '#addConfirm', function(e) {
-                let biblio_id = $('#biblio_add').val();
-                let message = $('#message_add').val();
-
-                params = {
-                    message: message,
-                    biblio_id: biblio_id,
-                    reporter_id: logged_in_user_borrowernumber,
-                };
-
-                $.ajax({
-                    url: '/api/v1/catalog/concerns',
-                    type: 'POST',
-                    data: JSON.stringify(params),
-                    success: function(data) {
-                        $('#AddConcernModal').modal('hide');
-
-                        if ( $.fn.dataTable.isDataTable("#table_concerns") ) {
-                            $("#table_concerns").DataTable().ajax.reload();
-                        }
-                    },
-                    contentType: "json"
-                });
-            });
         });
     </script>
 [% END %]
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/circ/returns.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/circ/returns.tt
index be91ab7be7..19931dfbee 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/circ/returns.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/circ/returns.tt
@@ -1350,6 +1350,10 @@
     </div> <!-- /#bundleMissingModal -->
     [% END %]
 
+[% IF ( Koha.Preference('CatalogConcerns') ) %]
+[% INCLUDE 'modals/add_catalog_concern.inc' %]
+[% END %]
+
 [% MACRO jsinclude BLOCK %]
     [% INCLUDE 'datatables.inc' %]
     [% INCLUDE 'columns_settings.inc' %]
@@ -1362,7 +1366,13 @@
         </script>
         [% Asset.js("js/resolve_claim_modal.js") | $raw %]
     [% END %]
-
+    [% IF ( Koha.Preference('CatalogConcerns') ) %]
+        <script>
+            /* Set a variable needed by add_catalog_concern.js */
+            var logged_in_user_borrowernumber = "[% logged_in_user.borrowernumber | html %]";
+        </script>
+        [% Asset.js("js/modals/add_catalog_concern.js") | $raw %]
+    [% END %]
     <script>
         function Dopop(link) {
             var newin = window.open(link, 'popup', 'width=600,height=400,resizable=1,toolbar=0,scrollbars=1,top');
diff --git a/koha-tmpl/intranet-tmpl/prog/js/modals/add_catalog_concern.js b/koha-tmpl/intranet-tmpl/prog/js/modals/add_catalog_concern.js
new file mode 100644
index 0000000000..defef12eea
--- /dev/null
+++ b/koha-tmpl/intranet-tmpl/prog/js/modals/add_catalog_concern.js
@@ -0,0 +1,26 @@
+$(document).ready(function() {
+    $('#addConcernModal').on('click', '#addConfirm', function(e) {
+        let biblio_id = $('#biblio_add').val();
+        let message = $('#message_add').val();
+
+        let params = {
+            message: message,
+            biblio_id: biblio_id,
+            reporter_id: logged_in_user_borrowernumber,
+        };
+
+        $.ajax({
+            url: '/api/v1/catalog/concerns',
+            type: 'POST',
+            data: JSON.stringify(params),
+            success: function(data) {
+                $('#addConcernModal').modal('hide');
+
+                if ($.fn.dataTable.isDataTable("#table_concerns")) {
+                    $("#table_concerns").DataTable().ajax.reload();
+                }
+            },
+            contentType: "json"
+        });
+    });
+});
-- 
2.20.1