From d23dd4f2c1f44a79c39bd600fb55c025d0f65407 Mon Sep 17 00:00:00 2001
From: Julian Maurice
Date: Fri, 3 Feb 2023 12:00:39 +0100
Subject: [PATCH] Bug 30975: Use event delegation for framework plugins
Content-Type: text/plain; charset=utf-8
This is to avoid using private jQuery method _data.
Here's what jQuery 1.8.0 release notes says about it:
"this is not a supported public interface; the actual data structures
may change incompatibly from version to version."
So we should not rely on it.
What this patch does is use event delegation [1].
Events are bound to a parent container, so when elements are added
dynamically inside that container, we don't need to re-attach event
handlers manually
This patch also comes with a bit of cleanup, and introduce "breaking
changes" (they are breaking changes only if you happen to have custom
framework plugins):
1) 'mouseover', 'mousemove', 'keypress' events are no longer listened to
'mouseover' and 'mousemove' are not used and would trigger too much
events.
'keypress' is also not used, and is deprecated
2) Event handlers now takes a single parameter that is an Event object
It just makes the code a lot less complicated.
3) Event handlers do not pollute the global scope anymore
[1] https://learn.jquery.com/events/event-delegation/
Test plan:
- Go to every page that has a MARC editor and verify that plugins still
work. This includes addbiblio.pl, additem.pl, authorities.pl,
neworderempty.pl, orderreceive.pl
- Test plugins that use 'focus' event (for instance barcode.pl), 'blur'
event (callnumber.pl) and 'click' event (almost all the others)
- Test that plugins work on cloned fields/subfields
Rebased-by: Victor Grousset/tuxayo
Signed-off-by: Marcel de Rooy
---
C4/Items.pm | 2 +-
Koha/FrameworkPlugin.pm | 84 ++-------------
Koha/UI/Form/Builder/Item.pm | 1 +
authorities/authorities.pl | 1 +
cataloguing/value_builder/EXAMPLE.pl | 26 +----
.../prog/en/includes/html_helpers.inc | 6 +-
.../prog/en/modules/acqui/neworderempty.tt | 2 +-
.../prog/en/modules/acqui/orderreceive.tt | 2 +-
.../en/modules/authorities/authorities.tt | 4 +-
.../prog/en/modules/cataloguing/addbiblio.tt | 8 +-
.../prog/en/modules/cataloguing/additem.tt | 2 +-
koha-tmpl/intranet-tmpl/prog/js/additem.js | 14 ---
koha-tmpl/intranet-tmpl/prog/js/cataloging.js | 101 ++++++++----------
13 files changed, 72 insertions(+), 181 deletions(-)
diff --git a/C4/Items.pm b/C4/Items.pm
index 82882dccf8..4f396be9d9 100644
--- a/C4/Items.pm
+++ b/C4/Items.pm
@@ -1558,7 +1558,7 @@ sub PrepareItemrecordDisplay {
my $tab= $plugin->noclick? '-1': '';
my $class= $plugin->noclick? ' disabled': '';
my $title= $plugin->noclick? 'No popup': 'Tag editor';
- $subfield_data{marc_value} = qq[...\n].$plugin->javascript;
+ $subfield_data{marc_value} = qq[...\n].$plugin->javascript;
} else {
warn $plugin->errstr;
$subfield_data{marc_value} = qq(); # supply default input form
diff --git a/Koha/FrameworkPlugin.pm b/Koha/FrameworkPlugin.pm
index dab6c4f471..96a5945bf5 100644
--- a/Koha/FrameworkPlugin.pm
+++ b/Koha/FrameworkPlugin.pm
@@ -307,94 +307,24 @@ sub _process_javascript {
$script =~ s/\
-HERE
+JS
}
=head1 AUTHOR
diff --git a/Koha/UI/Form/Builder/Item.pm b/Koha/UI/Form/Builder/Item.pm
index cbc52522c3..b93b3862b6 100644
--- a/Koha/UI/Form/Builder/Item.pm
+++ b/Koha/UI/Form/Builder/Item.pm
@@ -359,6 +359,7 @@ sub generate_subfield_form {
class => $class,
nopopup => $plugin->noclick,
javascript => $plugin->javascript,
+ plugin => $plugin->name,
};
}
else {
diff --git a/authorities/authorities.pl b/authorities/authorities.pl
index 2133008f4f..8f99777b41 100755
--- a/authorities/authorities.pl
+++ b/authorities/authorities.pl
@@ -200,6 +200,7 @@ sub create_input {
maxlength => $max_length,
javascript => $plugin->javascript,
noclick => $plugin->noclick,
+ plugin => $plugin->name,
};
} else { # warn and supply default field
warn $plugin->errstr;
diff --git a/cataloguing/value_builder/EXAMPLE.pl b/cataloguing/value_builder/EXAMPLE.pl
index 691e69f8e2..31319494e1 100755
--- a/cataloguing/value_builder/EXAMPLE.pl
+++ b/cataloguing/value_builder/EXAMPLE.pl
@@ -65,37 +65,19 @@ my $builder= sub {
|;
};
diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/html_helpers.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/html_helpers.inc
index 50d618f392..32864104aa 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/includes/html_helpers.inc
+++ b/koha-tmpl/intranet-tmpl/prog/en/includes/html_helpers.inc
@@ -144,11 +144,11 @@
[% IF mv.readonly %]
[% ELSE %]
-
+
[% IF ( mv.nopopup ) %]
- ...
+ ...
[% ELSE %]
- ...
+ ...
[% END %]
[% UNLESS no_plugin %][%# FIXME - from batchMod-edit, jQuery is included at the end of the template and cataloguing plugins are not working in this situation %]
[%- mv.javascript | $raw -%]
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/neworderempty.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/neworderempty.tt
index 5cf600951c..3cdeb46c59 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/neworderempty.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/neworderempty.tt
@@ -546,7 +546,7 @@
The autoBarcode system preference is set to [% Koha.Preference('autoBarcode') | html %] and items with blank barcodes will have barcodes generated upon save to database
[% END %]
-
+
[% END %][%# | html UNLESS subscriptionid %]
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/orderreceive.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/orderreceive.tt
index 3c3aa4c64b..5deb54eefd 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/orderreceive.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/orderreceive.tt
@@ -248,7 +248,7 @@
used