[Bug 20181] New: Allow plugins to add css and javascript to OPAC
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 Bug ID: 20181 Summary: Allow plugins to add css and javascript to OPAC Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: OPAC Assignee: oleonard@myacpl.org Reporter: kyle@bywatersolutions.com QA Contact: testopia@bugs.koha-community.org A number of Koha plugins have been written that enhance Koha's public catalog. These plugins often make due to adding css and javascript to the various opac system preferences. It would be nice if the plugin system had hooks so plugin developers could add code the the head block and the area where we include javascript in the opac template. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|oleonard@myacpl.org |kyle@bywatersolutions.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs Signoff Patch complexity|--- |Small patch -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 --- Comment #1 from Kyle M Hall <kyle@bywatersolutions.com> --- Created attachment 71481 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=71481&action=edit Bug 20181: Allow plugins to add css and javascript to OPAC A number of Koha plugins have been written that enhance Koha's public catalog. These plugins often make due to adding css and javascript to the various opac system preferences. It would be nice if the plugin system had hooks so plugin developers could add code the the head block and the area where we include javascript in the opac template. Test Plan: 1) Apply this patch 2) Download and install the Kitchen Sink plugin ( v2.1.12 or later ) https://github.com/bywatersolutions/koha-plugin-kitchen-sink/releases/downlo... 3) Install the plugin 4) Restart all the things if you can ( restart_all if you are using kohadevbox ) This will ensure the plugin takes effect right away, it should be necessary but it won't hurt anything! 5) Load the opac, notice you get an alert message and the background for your opac is now orange ( assuming you've not customized the opac in any way ) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 --- Comment #2 from Kyle M Hall <kyle@bywatersolutions.com> --- Created attachment 71483 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=71483&action=edit Bug 20181 - Unit Tests -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 --- Comment #3 from M. Tompsett <mtompset@hotmail.com> --- Created attachment 71563 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=71563&action=edit Bug 20181: Followup to ensure test runs If EnablePlugins was 0, this test before this patch fails. After this patch, it passes. TEST PLAN --------- 1) Apply all but this patch 2) Run the following commands kshell prove t/Koha_Template_Plugin_KohaPlugins.t -- two tests fail, if you have the conf or syspref set to 0. 3) Apply this patch 4) Repeat step 2. -- all tests pass, including the positive and negative case checks. 5) run koha qa test tools -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 --- Comment #4 from Kyle M Hall <kyle@bywatersolutions.com> --- (In reply to M. Tompsett from comment #3)
Created attachment 71563 [details] [review] Bug 20181: Followup to ensure test runs
If EnablePlugins was 0, this test before this patch fails. After this patch, it passes.
TEST PLAN --------- 1) Apply all but this patch 2) Run the following commands kshell prove t/Koha_Template_Plugin_KohaPlugins.t -- two tests fail, if you have the conf or syspref set to 0. 3) Apply this patch 4) Repeat step 2. -- all tests pass, including the positive and negative case checks. 5) run koha qa test tools
Doh, thanks Mark! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 --- Comment #5 from Kyle M Hall <kyle@bywatersolutions.com> --- Created attachment 71565 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=71565&action=edit Bug 20181: Add POD for new plugin -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 M. Tompsett <mtompset@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #71481|0 |1 is obsolete| | --- Comment #6 from M. Tompsett <mtompset@hotmail.com> --- Created attachment 71566 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=71566&action=edit Bug 20181: Allow plugins to add css and javascript to OPAC A number of Koha plugins have been written that enhance Koha's public catalog. These plugins often make due to adding css and javascript to the various opac system preferences. It would be nice if the plugin system had hooks so plugin developers could add code the the head block and the area where we include javascript in the opac template. Test Plan: 1) Apply this patch 2) Download and install the Kitchen Sink plugin ( v2.1.12 or later ) https://github.com/bywatersolutions/koha-plugin-kitchen-sink/releases/downlo... 3) Install the plugin 4) Restart all the things if you can ( restart_all if you are using kohadevbox ) This will ensure the plugin takes effect right away, it should be necessary but it won't hurt anything! 5) Load the opac, notice you get an alert message and the background for your opac is now orange ( assuming you've not customized the opac in any way ) Signed-off-by: Mark Tompsett <mtompset@hotmail.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 M. Tompsett <mtompset@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #71483|0 |1 is obsolete| | --- Comment #7 from M. Tompsett <mtompset@hotmail.com> --- Created attachment 71567 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=71567&action=edit Bug 20181 - Unit Tests Signed-off-by: Mark Tompsett <mtompset@hotmail.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 M. Tompsett <mtompset@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #71563|0 |1 is obsolete| | --- Comment #8 from M. Tompsett <mtompset@hotmail.com> --- Created attachment 71568 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=71568&action=edit Bug 20181: Followup to ensure test runs If EnablePlugins was 0, this test before this patch fails. After this patch, it passes. TEST PLAN --------- 1) Apply all but this patch 2) Run the following commands kshell prove t/Koha_Template_Plugin_KohaPlugins.t -- two tests fail, if you have the conf or syspref set to 0. 3) Apply this patch 4) Repeat step 2. -- all tests pass, including the positive and negative case checks. 5) run koha qa test tools Signed-off-by: Mark Tompsett <mtompset@hotmail.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 M. Tompsett <mtompset@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #71565|0 |1 is obsolete| | --- Comment #9 from M. Tompsett <mtompset@hotmail.com> --- Created attachment 71569 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=71569&action=edit Bug 20181: Add POD for new plugin Signed-off-by: Mark Tompsett <mtompset@hotmail.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 M. Tompsett <mtompset@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |mtompset@hotmail.com Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Summary|Allow plugins to add css |Allow plugins to add CSS |and javascript to OPAC |and Javascript to OPAC CC| |katrin.fischer@bsz-bw.de -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #71566|0 |1 is obsolete| | --- Comment #10 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Created attachment 73264 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=73264&action=edit Bug 20181: Allow plugins to add css and javascript to OPAC A number of Koha plugins have been written that enhance Koha's public catalog. These plugins often make due to adding css and javascript to the various opac system preferences. It would be nice if the plugin system had hooks so plugin developers could add code the the head block and the area where we include javascript in the opac template. Test Plan: 1) Apply this patch 2) Download and install the Kitchen Sink plugin ( v2.1.12 or later ) https://github.com/bywatersolutions/koha-plugin-kitchen-sink/releases/downlo... 3) Install the plugin 4) Restart all the things if you can ( restart_all if you are using kohadevbox ) This will ensure the plugin takes effect right away, it should be necessary but it won't hurt anything! 5) Load the opac, notice you get an alert message and the background for your opac is now orange ( assuming you've not customized the opac in any way ) Signed-off-by: Mark Tompsett <mtompset@hotmail.com> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 --- Comment #11 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Created attachment 73265 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=73265&action=edit Bug 20181: Unit tests Signed-off-by: Mark Tompsett <mtompset@hotmail.com> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 --- Comment #12 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Created attachment 73266 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=73266&action=edit Bug 20181: (follow-up) Ensure test runs If EnablePlugins was 0, this test before this patch fails. After this patch, it passes. TEST PLAN --------- 1) Apply all but this patch 2) Run the following commands kshell prove t/Koha_Template_Plugin_KohaPlugins.t -- two tests fail, if you have the conf or syspref set to 0. 3) Apply this patch 4) Repeat step 2. -- all tests pass, including the positive and negative case checks. 5) run koha qa test tools Signed-off-by: Mark Tompsett <mtompset@hotmail.com> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #71569|0 |1 is obsolete| | --- Comment #13 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Created attachment 73267 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=73267&action=edit Bug 20181: Add POD for new plugin Signed-off-by: Mark Tompsett <mtompset@hotmail.com> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #71568|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #71567|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |jonathan.druart@bugs.koha-c | |ommunity.org --- Comment #14 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- It sounds weird to me to test UseKohaPlugins and enable_plugins in the Koha::Template::Plugin::KohaPlugins I would have expected more something like my $p = Koha::Plugins->new; return unless $p; my @plugins = $p->GetPlugins; as Koha::Plugins->new already test UseKohaPlugins. Not blocker. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 --- Comment #15 from Kyle M Hall <kyle@bywatersolutions.com> --- Created attachment 73417 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=73417&action=edit Bug 20181 [QA Followup]: Remove double check -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 --- Comment #16 from Kyle M Hall <kyle@bywatersolutions.com> --- (In reply to Jonathan Druart from comment #14)
It sounds weird to me to test UseKohaPlugins and enable_plugins in the Koha::Template::Plugin::KohaPlugins I would have expected more something like my $p = Koha::Plugins->new; return unless $p; my @plugins = $p->GetPlugins;
as Koha::Plugins->new already test UseKohaPlugins.
Not blocker.
I wonder if we could move the syspref check into new() as well. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 --- Comment #17 from M. Tompsett <mtompset@hotmail.com> --- (In reply to Kyle M Hall from comment #16)
I wonder if we could move the syspref check into new() as well.
If there was a way to determine why a new() failed, then I'd say go for it. Because there may exist cases where we wish to know why a new() failed. Did it fail because the system administrator side of it wasn't configured? Did it fail because the koha administrator turned off plugins system preference? Did it fail for some other reason? -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 --- Comment #18 from Kyle M Hall <kyle@bywatersolutions.com> --- (In reply to M. Tompsett from comment #17)
(In reply to Kyle M Hall from comment #16)
I wonder if we could move the syspref check into new() as well.
If there was a way to determine why a new() failed, then I'd say go for it. Because there may exist cases where we wish to know why a new() failed. Did it fail because the system administrator side of it wasn't configured? Did it fail because the koha administrator turned off plugins system preference? Did it fail for some other reason?
Good thoughts. I'd say it's out of scope for this bug. I'll file a new bug report where we can deal with it. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |20496 Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20496 [Bug 20496] Consolidate the checks to see if plugins are enabled in Koha::Plugin::new -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Passed QA |Pushed to Master --- Comment #19 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- Pushed to master for 18.05, thanks to everybody involved! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |20766 Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20766 [Bug 20766] KohaPlugins.t does not clean up -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 Nick Clemens <nick@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Pushed to Master |RESOLVED CC| |nick@bywatersolutions.com Resolution|--- |FIXED --- Comment #20 from Nick Clemens <nick@bywatersolutions.com> --- Enhancement, not backported for 17.11.x -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 Fridolin SOMERS <fridolin.somers@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |21352 Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=21352 [Bug 21352] Allow plugins to add CSS and Javascript to Staff interface -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 Fridolin SOMERS <fridolin.somers@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |fridolin.somers@biblibre.co | |m --- Comment #21 from Fridolin SOMERS <fridolin.somers@biblibre.com> --- I've decided to backport to 17.11.x, this is very useful and not risky. Pushed to 17.11.x for 17.11.11 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20181 Fridolin SOMERS <fridolin.somers@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |20764 Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20764 [Bug 20764] t/Koha_Template_Plugin_KohaPlugins.t is DB dependent -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org