From 3c7ea65923a47d99af76a1bd3f43fc7ddc334a2b Mon Sep 17 00:00:00 2001 From: Andreas Roussos Date: Tue, 21 Feb 2023 20:02:19 +0100 Subject: [PATCH] Bug 29578: Upgrade the jQuery highlighter plugin MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Under certain conditions, the jQuery term highlighter can break and in the process make the "Highlight" / "Unhighlight" button disappear altogether. This affects catalog searches in both the OPAC and the Staff Client, with UNIMARC-based instances affected the most as the "Highlight" / "Unhighlight" button disappears if you perform a specific OPAC search (see Test plan below). This patch fixes that by upgrading the highlighter plugin to its latest version for both the OPAC and the Staff interface. Then, the changes from commit 2e4b574074 (Bug 5844) are applied to the plugin code. Also, Koha uses "term" instead of "highlight" as the class name for the highlighting elements, so the plugin code is modified for that aspect, too. Finally, the plugin file is renamed to reflect the version change (v3 -> v5) and all references to the old filename in the Template files are updated. Test plan: 0) In a UNIMARC instance, catalogue two books using the titles given below (Title subfield = 200$a): Book 1: Συλλογής των εν επιτομή τοῖς πάλαι γεωγραφηθέντων Book 2: Επιτομή της ιστορίας των Βαλκανικών Πολέμων (1912-1913) 1) OpacHighlightedWords and StaffHighlightedWords should both be set to "Highlight". 2) Search the OPAC for "επιτομή των" (without the quotes). In the results page, notice that: a) You get an Uncaught DOMException error in the web browswer's JavaScript Console (press F12): "Failed to execute 'splitText' on 'Text': The offset 3 is larger than the Text node's length." b) the "Highlight" / "Unhighlight" button vanishes c) some search terms matches are not highlighted (for example "των" in the 2nd Book) 3) Repeat the same search in the Staff interface. In the results page, notice that: a) You get an Uncaught DOMException error in the web browswer's JavaScript Console (press F12): "Failed to execute 'splitText' on 'Text': The offset 3 is larger than the Text node's length." b) Even though some terms are highlighted, the button still says "Highlight" c) some search terms matches are not highlighted (for example "των" in the 2nd Book) 4) Apply this patch. 5) Repeat the searches (you may have to press CTRL-F5 to reload the JavaScript code). This time the "Highlight" / "Unhighlight" button is displayed in the OPAC, and all your search terms should be highlighted in yellow. Toggling the highlight should cause no problems, and there shouldn't be any errors logged in your browser's Console. --- .../{jquery.highlight-3.js => jquery.highlight-5.js} | 7 ++++--- koha-tmpl/intranet-tmpl/prog/en/includes/js_includes.inc | 2 +- koha-tmpl/intranet-tmpl/prog/en/modules/circ/offline-mf.tt | 2 +- koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-detail.tt | 2 +- koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-results.tt | 2 +- .../{jquery.highlight-3.js => jquery.highlight-5.js} | 7 ++++--- 6 files changed, 12 insertions(+), 10 deletions(-) rename koha-tmpl/intranet-tmpl/lib/jquery/plugins/{jquery.highlight-3.js => jquery.highlight-5.js} (86%) rename koha-tmpl/opac-tmpl/bootstrap/lib/jquery/plugins/{jquery.highlight-3.js => jquery.highlight-5.js} (86%) diff --git a/koha-tmpl/intranet-tmpl/lib/jquery/plugins/jquery.highlight-3.js b/koha-tmpl/intranet-tmpl/lib/jquery/plugins/jquery.highlight-5.js similarity index 86% rename from koha-tmpl/intranet-tmpl/lib/jquery/plugins/jquery.highlight-3.js rename to koha-tmpl/intranet-tmpl/lib/jquery/plugins/jquery.highlight-5.js index 8eabca4bfd..578da60639 100644 --- a/koha-tmpl/intranet-tmpl/lib/jquery/plugins/jquery.highlight-3.js +++ b/koha-tmpl/intranet-tmpl/lib/jquery/plugins/jquery.highlight-5.js @@ -1,6 +1,6 @@ /* -highlight v3 +highlight v5 Highlights arbitrary terms. @@ -19,6 +19,7 @@ jQuery.fn.highlight = function(pat) { var skip = 0; if (node.nodeType == 3) { var pos = node.data.toUpperCase().indexOf(pat); + pos -= (node.data.substr(0, pos).toUpperCase().length - node.data.substr(0, pos).length); if (pos >= 0) { var spannode = document.createElement('span'); spannode.className = 'term'; @@ -37,9 +38,9 @@ jQuery.fn.highlight = function(pat) { } return skip; } - return this.each(function() { + return this.length && pat && pat.length ? this.each(function() { innerHighlight(this, pat.toUpperCase()); - }); + }) : this; }; jQuery.fn.removeHighlight = function() { diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/js_includes.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/js_includes.inc index 2d1af01c4f..ee2cd87a16 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/includes/js_includes.inc +++ b/koha-tmpl/intranet-tmpl/prog/en/includes/js_includes.inc @@ -21,7 +21,7 @@ [% Asset.js("lib/jquery/jquery-ui-1.13.1.min.js") | $raw %] [% Asset.js("lib/shortcut/shortcut.js") | $raw %] [% Asset.js("lib/js-cookie/js.cookie-2.2.1.min.js") | $raw %] -[% Asset.js("lib/jquery/plugins/jquery.highlight-3.js") | $raw %] +[% Asset.js("lib/jquery/plugins/jquery.highlight-5.js") | $raw %] [% Asset.js("lib/bootstrap/bootstrap.min.js") | $raw %] [% Asset.js("lib/jquery/plugins/jquery.validate.min.js") | $raw %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/circ/offline-mf.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/circ/offline-mf.tt index b937207c3c..54ae6fb288 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/circ/offline-mf.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/circ/offline-mf.tt @@ -11,7 +11,7 @@ CACHE: [% interface | html %]/lib/jquery/jquery-ui-1.13.1.min.js [% interface | html %]/lib/jquery/jquery-3.6.0.min.js [% interface | html %]/lib/jquery/jquery-migrate-3.3.2.min.js -[% interface | html %]/lib/jquery/plugins/jquery.highlight-3.js +[% interface | html %]/lib/jquery/plugins/jquery.highlight-5.js [% interface | html %]/lib/shortcut/shortcut.js [% interface | html %]/lib/jquery/plugins/jquery.indexeddb.js [% interface | html %]/lib/jquery/plugins/jquery.validate.min.js diff --git a/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-detail.tt b/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-detail.tt index 61eae02a36..d455cf2775 100644 --- a/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-detail.tt +++ b/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-detail.tt @@ -1447,7 +1447,7 @@ [% Asset.js("js/ratings.js") | $raw %] [% END %] - [% IF ( OpacHighlightedWords ) %][% Asset.js("lib/jquery/plugins/jquery.highlight-3.js") | $raw %][% END %] + [% IF ( OpacHighlightedWords ) %][% Asset.js("lib/jquery/plugins/jquery.highlight-5.js") | $raw %][% END %] [% IF ( Koha.Preference('OPACDetailQRCode') ) %] [% Asset.js("lib/kjua/kjua.min.js") | $raw %] [% END %] diff --git a/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-results.tt b/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-results.tt index 95fa8d6304..54ee883349 100644 --- a/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-results.tt +++ b/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-results.tt @@ -582,7 +582,7 @@ [% Asset.js("js/authtoresults.js") | $raw %] [% Asset.js("lib/hc-sticky.js") | $raw %] [% IF ( OpacHighlightedWords ) %] - [% Asset.js("lib/jquery/plugins/jquery.highlight-3.js") | $raw %] + [% Asset.js("lib/jquery/plugins/jquery.highlight-5.js") | $raw %] [% END %] [% IF OpenLibraryCovers || OpenLibrarySearch %] [% Asset.js("js/openlibrary.js") | $raw %] diff --git a/koha-tmpl/opac-tmpl/bootstrap/lib/jquery/plugins/jquery.highlight-3.js b/koha-tmpl/opac-tmpl/bootstrap/lib/jquery/plugins/jquery.highlight-5.js similarity index 86% rename from koha-tmpl/opac-tmpl/bootstrap/lib/jquery/plugins/jquery.highlight-3.js rename to koha-tmpl/opac-tmpl/bootstrap/lib/jquery/plugins/jquery.highlight-5.js index 8eabca4bfd..578da60639 100644 --- a/koha-tmpl/opac-tmpl/bootstrap/lib/jquery/plugins/jquery.highlight-3.js +++ b/koha-tmpl/opac-tmpl/bootstrap/lib/jquery/plugins/jquery.highlight-5.js @@ -1,6 +1,6 @@ /* -highlight v3 +highlight v5 Highlights arbitrary terms. @@ -19,6 +19,7 @@ jQuery.fn.highlight = function(pat) { var skip = 0; if (node.nodeType == 3) { var pos = node.data.toUpperCase().indexOf(pat); + pos -= (node.data.substr(0, pos).toUpperCase().length - node.data.substr(0, pos).length); if (pos >= 0) { var spannode = document.createElement('span'); spannode.className = 'term'; @@ -37,9 +38,9 @@ jQuery.fn.highlight = function(pat) { } return skip; } - return this.each(function() { + return this.length && pat && pat.length ? this.each(function() { innerHighlight(this, pat.toUpperCase()); - }); + }) : this; }; jQuery.fn.removeHighlight = function() { -- 2.20.1