From 0254b4e87df2879d9de97a8651fd1f325fc4495c Mon Sep 17 00:00:00 2001
From: Owen Leonard <oleonard@myacpl.org>
Date: Wed, 20 Jun 2018 17:16:16 +0000
Subject: [PATCH] Bug 20931: JS error "ReferenceError: $ is not defined" when
 CircSidebar is turned on

This patch reorganizes the way sidebar menus get highlighted based on
the current page. A global function is added to handle most cases.
Individual menu-handling scripts have been modified to handle only the
edge cases which aren't covered by the global one.

A new class is added to the global CSS file so that highlighted menu
links can be custom-styled.

To test, apply the patch and clear your cache if necessary.

View various pages to confirm that current-page-highlighting in the
sidebar menu is working correctly and that there are no JS errors in the
browser console. For example:

 - Administration -> Currencies and exchange rates.
 - Acquisitions -> Invoices
 - Tools -> Patron lists
 - Tools -> Export

And with CircSidebar turned on test various circulation pages, e.g.

 - Circulation -> Set library

Signed-off-by: Charles Farmer <charles.farmer@inLibro.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
---
 .../intranet-tmpl/prog/css/staff-global.css    |  6 +++++-
 .../prog/en/includes/circ-nav.inc              | 13 -------------
 koha-tmpl/intranet-tmpl/prog/js/acq.js         |  5 -----
 .../intranet-tmpl/prog/js/acquisitions-menu.js |  4 +---
 koha-tmpl/intranet-tmpl/prog/js/admin-menu.js  | 12 +++++-------
 .../intranet-tmpl/prog/js/staff-global.js      | 12 ++++++++++++
 koha-tmpl/intranet-tmpl/prog/js/tools-menu.js  | 18 ++++++++----------
 7 files changed, 31 insertions(+), 39 deletions(-)

diff --git a/koha-tmpl/intranet-tmpl/prog/css/staff-global.css b/koha-tmpl/intranet-tmpl/prog/css/staff-global.css
index 57d3622dd6..2f01f7a2fd 100644
--- a/koha-tmpl/intranet-tmpl/prog/css/staff-global.css
+++ b/koha-tmpl/intranet-tmpl/prog/css/staff-global.css
@@ -163,7 +163,11 @@ label input[type="radio"],
 }
 
 #navmenulist li a {
-	text-decoration : none;
+    text-decoration : none;
+}
+
+#navmenulist li a.current {
+    font-weight: bold;
 }
 
 #doc, #doc1, #doc2, #doc3 {
diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/circ-nav.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/circ-nav.inc
index 844926c83a..b6dc7fbdf6 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/includes/circ-nav.inc
+++ b/koha-tmpl/intranet-tmpl/prog/en/includes/circ-nav.inc
@@ -1,17 +1,4 @@
 [% USE Branches %]
-<script type="text/javascript">//<![CDATA[
-    $(document).ready(function() {
-        var path = location.pathname.substring(1);
-        var url = window.location.toString();
-        var params = '';
-        if ( url.match(/\?(.+)$/) ) {
-            params = "?" + RegExp.$1;
-        }
-        $('#navmenulist a[href$="/' + path + params + '"]').css('font-weight','bold');
-    });
-//]]>
-</script>
-
 <div id="navmenu">
     <div id="navmenulist">
 
diff --git a/koha-tmpl/intranet-tmpl/prog/js/acq.js b/koha-tmpl/intranet-tmpl/prog/js/acq.js
index 63575b34ea..9d3983c88a 100644
--- a/koha-tmpl/intranet-tmpl/prog/js/acq.js
+++ b/koha-tmpl/intranet-tmpl/prog/js/acq.js
@@ -374,8 +374,3 @@ function hideAllColumns(){
     $("#plan td:nth-child(2),#plan th:nth-child(2)").nextUntil("th:nth-child("+(allCols-1)+"),td:nth-child("+(allCols-1)+")").hide(); // hide all but the last two columns
     $("#hideall").prop("checked", true).parent().addClass("selected");
 }
-
-$(document).ready(function() {
-    var path = location.pathname.substring(1);
-    $('#navmenulist a[href$="/' + path + '"]').css('font-weight','bold');
-});
diff --git a/koha-tmpl/intranet-tmpl/prog/js/acquisitions-menu.js b/koha-tmpl/intranet-tmpl/prog/js/acquisitions-menu.js
index 08bcc85b79..30c0567630 100644
--- a/koha-tmpl/intranet-tmpl/prog/js/acquisitions-menu.js
+++ b/koha-tmpl/intranet-tmpl/prog/js/acquisitions-menu.js
@@ -1,8 +1,6 @@
 $(document).ready(function() {
     var path = location.pathname.substring(1);
     if (path.indexOf("invoice") >= 0) {
-        $('#navmenulist a[href$="/cgi-bin/koha/acqui/invoices.pl"]').css('font-weight','bold');
-    } else {
-        $('#navmenulist a[href$="/' + path + '"]').css('font-weight','bold');
+        $('#navmenulist a[href$="/cgi-bin/koha/acqui/invoices.pl"]').addClass("current");
     }
 });
diff --git a/koha-tmpl/intranet-tmpl/prog/js/admin-menu.js b/koha-tmpl/intranet-tmpl/prog/js/admin-menu.js
index d0557feecf..f7b69c77fe 100644
--- a/koha-tmpl/intranet-tmpl/prog/js/admin-menu.js
+++ b/koha-tmpl/intranet-tmpl/prog/js/admin-menu.js
@@ -1,16 +1,14 @@
 $(document).ready(function() {
     var path = location.pathname.substring(1);
     if (path == "cgi-bin/koha/admin/marctagstructure.pl" || path == "cgi-bin/koha/admin/marc_subfields_structure.pl") {
-        $('#navmenulist a[href$="/cgi-bin/koha/admin/biblio_framework.pl"]').css('font-weight','bold');
+        $('#navmenulist a[href$="/cgi-bin/koha/admin/biblio_framework.pl"]').addClass("current");
     } else if (path == "cgi-bin/koha/admin/auth_tag_structure.pl" || path == "cgi-bin/koha/admin/auth_subfields_structure.pl") {
-        $('#navmenulist a[href$="/cgi-bin/koha/admin/authtypes.pl"]').css('font-weight','bold');
+        $('#navmenulist a[href$="/cgi-bin/koha/admin/authtypes.pl"]').addClass("current");
     } else if (path == "cgi-bin/koha/admin/oai_set_mappings.pl") {
-        $('#navmenulist a[href$="/cgi-bin/koha/admin/oai_sets.pl"]').css('font-weight','bold');
+        $('#navmenulist a[href$="/cgi-bin/koha/admin/oai_sets.pl"]').addClass("current");
     } else if (path == "cgi-bin/koha/admin/items_search_field.pl") {
-        $('#navmenulist a[href$="/cgi-bin/koha/admin/items_search_fields.pl"]').css('font-weight','bold');
+        $('#navmenulist a[href$="/cgi-bin/koha/admin/items_search_fields.pl"]').addClass("current");
     } else if (path == "cgi-bin/koha/admin/clone-rules.pl") {
-        $('#navmenulist a[href$="/cgi-bin/koha/admin/smart-rules.pl"]').css('font-weight','bold');
-    } else {
-        $('#navmenulist a[href$="/' + path + '"]').css('font-weight','bold');
+        $('#navmenulist a[href$="/cgi-bin/koha/admin/smart-rules.pl"]').addClass("current");
     }
 });
diff --git a/koha-tmpl/intranet-tmpl/prog/js/staff-global.js b/koha-tmpl/intranet-tmpl/prog/js/staff-global.js
index cd586da4e3..db5539a6ec 100644
--- a/koha-tmpl/intranet-tmpl/prog/js/staff-global.js
+++ b/koha-tmpl/intranet-tmpl/prog/js/staff-global.js
@@ -62,6 +62,18 @@ $.fn.selectTabByID = function (tabID) {
         e.preventDefault();
         $( $(this).data("element") ).toggle();
     });
+
+    var navmenulist = $("#navmenulist");
+    if( navmenulist.length > 0 ){
+        var path = location.pathname.substring(1);
+        var url = window.location.toString();
+        var params = '';
+        if ( url.match(/\?(.+)$/) ) {
+            params = "?" + RegExp.$1;
+        }
+        $("a[href$=\"/" + path + params + "\"]", navmenulist).addClass("current");
+    }
+
 });
 
 // http://jennifermadden.com/javascript/stringEnterKeyDetector.html
diff --git a/koha-tmpl/intranet-tmpl/prog/js/tools-menu.js b/koha-tmpl/intranet-tmpl/prog/js/tools-menu.js
index 9751f76bb8..4b6e4a0121 100644
--- a/koha-tmpl/intranet-tmpl/prog/js/tools-menu.js
+++ b/koha-tmpl/intranet-tmpl/prog/js/tools-menu.js
@@ -1,22 +1,20 @@
   $(document).ready(function() {
       var path = location.pathname.substring(1);
       if (path.indexOf("labels") >= 0 && path.indexOf("spine") < 0 ) {
-        $('#navmenulist a[href$="/cgi-bin/koha/labels/label-home.pl"]').css('font-weight','bold');
+        $('#navmenulist a[href$="/cgi-bin/koha/labels/label-home.pl"]').addClass("current");
       } else if (path.indexOf("patroncards") >= 0 ) {
-        $('#navmenulist a[href$="/cgi-bin/koha/patroncards/home.pl"]').css('font-weight','bold');
+        $('#navmenulist a[href$="/cgi-bin/koha/patroncards/home.pl"]').addClass("current");
       } else if (path.indexOf("clubs") >= 0 ) {
-          $('#navmenulist a[href$="/cgi-bin/koha/clubs/clubs.pl"]').css('font-weight','bold');
+          $('#navmenulist a[href$="/cgi-bin/koha/clubs/clubs.pl"]').addClass("current");
       } else if (path.indexOf("patron_lists") >= 0 ) {
-        $('#navmenulist a[href$="/cgi-bin/koha/patron_lists/lists.pl"]').css('font-weight','bold');
+        $('#navmenulist a[href$="/cgi-bin/koha/patron_lists/lists.pl"]').addClass("current");
       } else if (path.indexOf("rotating_collections") >= 0 ){
-        $('#navmenulist a[href$="/cgi-bin/koha/rotating_collections/rotatingCollections.pl"]').css('font-weight','bold');
+        $('#navmenulist a[href$="/cgi-bin/koha/rotating_collections/rotatingCollections.pl"]').addClass("current");
       } else if ((path+location.search).indexOf("batchMod.pl?del=1") >= 0 ) {
-        $('#navmenulist a[href$="/cgi-bin/koha/tools/batchMod.pl?del=1"]').css('font-weight','bold');
+        $('#navmenulist a[href$="/cgi-bin/koha/tools/batchMod.pl?del=1"]').addClass("current");
       } else if (path.indexOf("quotes-upload.pl") >= 0 ){
-        $('#navmenulist a[href$="/cgi-bin/koha/tools/quotes.pl"]').css('font-weight','bold');
+        $('#navmenulist a[href$="/cgi-bin/koha/tools/quotes.pl"]').addClass("current");
       } else if (path.indexOf("plugins") >= 0 ) {
-          $('#navmenulist a[href$="/cgi-bin/koha/plugins/plugins-home.pl?method=tool"]').css('font-weight','bold');
-      } else {
-        $('#navmenulist a[href$="/' + path + '"]').css('font-weight','bold');
+          $('#navmenulist a[href$="/cgi-bin/koha/plugins/plugins-home.pl?method=tool"]').addClass("current");
       }
   });
-- 
2.39.5