Attachment 145457 Details for Bug 32680 – Bug 32680: Add hooks to allow cover art to come from plugins

[patch] Bug 32680: Add hooks to allow cover art to come from plugins

Bug-32680-Add-hooks-to-allow-cover-art-to-come-fro.patch (text/plain), 12.27 KB, created by Matt Blenkinsop on 2023-01-19 11:35:24 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Matt Blenkinsop

Created: 2023-01-19 11:35:24 UTC

Size: 12.27 KB

patch

obsolete

>From 294d9cf66e9277f7c31a299e51ff71429ef08b10 Mon Sep 17 00:00:00 2001
>From: Matt Blenkinsop <matt.blenkinsop@ptfs-europe.com>
>Date: Thu, 19 Jan 2023 11:31:31 +0000
>Subject: [PATCH] Bug 32680: Add hooks to allow cover art to come from plugins
>
>This patch adds hooks to Koha core that allow a plugin for cover art to inject the images into the OPAC and staff client. These hooks could be re-used for other providers. As an example, a plugin has been created for BDS covers, the link is in another comment
>
>Test plan:
>1) Apply patch
>2) Go to https://github.com/PTFS-Europe/koha-plugin-addBDSCovers
>3) In the releases section, download the .kpz file
>4) Upload this in the plugins section and enable the plugin
>5) In either the OPAC or staff client, search the catalog
>6) The results should have cover art from BDS covers
>7) Click on a result and the detail page should also have the cover art
>---
> C4/Auth.pm                                    | 10 ++++++++++
> .../prog/en/modules/catalogue/detail.tt       | 20 ++++++++-----------
> .../prog/en/modules/catalogue/results.tt      | 18 ++++++++++++++---
> .../bootstrap/en/modules/opac-detail.tt       |  8 +++++++-
> .../bootstrap/en/modules/opac-results.tt      | 18 +++++++++++++++--
> 5 files changed, 56 insertions(+), 18 deletions(-)
>
>diff --git a/C4/Auth.pm b/C4/Auth.pm
>index 8e5b5f6e545..5ce3968a90b 100644
>--- a/C4/Auth.pm
>+++ b/C4/Auth.pm
>@@ -51,6 +51,7 @@ use Net::CIDR;
> use C4::Log qw( logaction );
> use Koha::CookieManager;
> use Koha::Auth::Permissions;
>+use Koha::Template::Plugin::KohaPlugins;
> 
> # use utf8;
> 
>@@ -458,6 +459,15 @@ sub get_template_and_user {
>         $can_make_suggestions = Koha::Patrons->find(C4::Context->userenv->{'number'})->category->can_make_suggestions;
>     }
> 
>+    my $intranet_js_plugins = Koha::Template::Plugin::KohaPlugins->get_plugins_intranet_js;
>+    if(index($intranet_js_plugins, "Cover Image Plugin") != -1){
>+        $template->param( Cover_Images_Required => 1 )
>+    }
>+    my $opac_js_plugins = Koha::Template::Plugin::KohaPlugins->get_plugins_opac_js;
>+    if(index($opac_js_plugins, "Cover Image Plugin") != -1){
>+        $template->param( Cover_Images_Required => 1 )
>+    }
>+
>     my $minPasswordLength = C4::Context->preference('minPasswordLength');
>     $minPasswordLength = 3 if not $minPasswordLength or $minPasswordLength < 3;
>     $template->param(
>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 ace46656c9b..a2e3ebab4f8 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/detail.tt
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/detail.tt
>@@ -114,7 +114,7 @@
>         <span class="Z3988" title="[% ocoins | html %]"></span>
>     [% END %]
> 
>-    [% IF ( AmazonCoverImages  || LocalCoverImages || IntranetCoce || ( SyndeticsCovers ) || (Koha.Preference('CustomCoverImages') && Koha.Preference('CustomCoverImagesURL')) ) %]
>+    [% IF ( AmazonCoverImages  || Cover_Images_Required || LocalCoverImages || IntranetCoce || ( SyndeticsCovers ) || (Koha.Preference('CustomCoverImages') && Koha.Preference('CustomCoverImagesURL')) ) %]
>         <div id="catalogue_detail_biblio" class="col-xs-9">
>     [% ELSE %]
>         <div id="catalogue_detail_biblio" class="col-xs-12">
>@@ -204,10 +204,10 @@
>         [% END %]
>         </div> [%# .page-section %]
> 
>-        [% IF ( AmazonCoverImages  || LocalCoverImages || IntranetCoce || ( SyndeticsCovers ) || (Koha.Preference('CustomCoverImages') && Koha.Preference('CustomCoverImagesURL')) ) %]
>+        [% IF ( Cover_Images_Required || AmazonCoverImages  || LocalCoverImages || IntranetCoce || ( SyndeticsCovers ) || (Koha.Preference('CustomCoverImages') && Koha.Preference('CustomCoverImagesURL')) ) %]
>         </div>
>             <div class="col-xs-3 bookcoverimg">
>-                <div id="biblio-cover-slider" class="cover-slider">
>+                <div id="biblio-cover-slider" class="cover-slider cover_images_required">
>                     [% IF ( LocalCoverImages ) %]
>                         [% IF localimages.count %]
>                             [% FOREACH image IN localimages %]
>@@ -221,15 +221,6 @@
>                         [% END %]
>                     [% END %]
> 
>-                    [% IF ( AmazonCoverImages && normalized_isbn) %]
>-                        <div class="cover-image" id="amazon-bookcoverimg">
>-                            <a href="https://images-na.ssl-images-amazon.com/images/P/[% normalized_isbn | uri %].01.LZZZZZZZ.jpg" title="Amazon cover image">
>-                                <img src="https://images-na.ssl-images-amazon.com/images/P/[% normalized_isbn | uri %].01.MZZZZZZZ.jpg" alt="Amazon cover image" data-link="http://www.amazon[% AmazonTld | uri %]/gp/reader/[% normalized_isbn | uri %][% AmazonAssocTag | uri %]#reader-link"/>
>-                            </a>
>-                            <div class="hint">Image from Amazon.com</div>
>-                        </div>
>-                    [% END %]
>-
>                     [% IF ( IntranetCoce && CoceProviders && normalized_isbn ) %]
>                         [% coce_id = normalized_ean || normalized_isbn %]
>                         <div class="cover-image coce-coverimg">
>@@ -1310,6 +1301,11 @@ Note that permanent location is a code, and location may be an authval.
>     [% Asset.js("js/recalls.js") | $raw %]
>     [% Asset.js("js/coce.js") | $raw %]
>     [% Asset.js("lib/Chocolat/js/chocolat.js") | $raw %]
>+    [% IF ( Cover_Images_Required ) %]
>+        <script>
>+            var normalized_isbn = "[% normalized_isbn %]";   
>+        </script>
>+    [% END %]
>     <script>
>         var interface = "[% interface | html %]";
>         var theme = "[% theme | html %]";
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/results.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/results.tt
>index 82735d4be81..eb61a12dcd1 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/results.tt
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/results.tt
>@@ -449,7 +449,7 @@
>                                 <table>
>                                     <thead>
>                                     <tr>
>-                                        [% IF ( AmazonCoverImages  || LocalCoverImages || ( SyndeticsCovers ) || (Koha.Preference('CustomCoverImages') && Koha.Preference('CustomCoverImagesURL')) ) %]
>+                                        [% IF ( Cover_Images_Required || AmazonCoverImages  || LocalCoverImages || ( SyndeticsCovers ) || (Koha.Preference('CustomCoverImages') && Koha.Preference('CustomCoverImagesURL')) ) %]
>                                             <th>&nbsp;</th>
>                                         [% END %]
>                                         <th colspan="2">Results</th>
>@@ -461,9 +461,9 @@
>                                     <tbody>
>                                     [% FOREACH SEARCH_RESULT IN SEARCH_RESULTS %]
>                                         <tr id="row[% SEARCH_RESULT.biblionumber | html %]">
>-                                            [% IF ( AmazonCoverImages  || LocalCoverImages || IntranetCoce || ( SyndeticsCovers ) || (Koha.Preference('CustomCoverImages') && Koha.Preference('CustomCoverImagesURL')) ) %]
>+                                            [% IF ( Cover_Images_Required || AmazonCoverImages  || LocalCoverImages || IntranetCoce || ( SyndeticsCovers ) || (Koha.Preference('CustomCoverImages') && Koha.Preference('CustomCoverImagesURL')) ) %]
>     <td class="bookcoverimg">
>-        <div id="cover-slides-[% SEARCH_RESULT.biblionumber | html %]" class="cover-slides" data-biblionumber="[% SEARCH_RESULT.biblionumber | html %]">
>+        <div id="cover-slides-[% SEARCH_RESULT.biblionumber | html %]" class="cover-slides search_cover_images_required" data-biblionumber="[% SEARCH_RESULT.biblionumber | html %]">
>             [% IF ( LocalCoverImages ) %][% SEARCH_RESULT.localimage | html %]
>                 <div id="local-coverimg-[% SEARCH_RESULT.biblionumber | html %]" class="cover-image local-coverimg">
>                     <a href="[% PROCESS biblio_a_href biblionumber => SEARCH_RESULT.biblionumber %]">
>@@ -781,6 +781,18 @@
>     [% Asset.css("css/humanmsg.css") | $raw %]
>     [% Asset.js("lib/jquery/plugins/humanmsg.js") | $raw %]
>     [% INCLUDE 'select2.inc' %]
>+    [% IF ( Cover_Images_Required ) %]
>+        <script>
>+            const search_results = {};
>+            [% FOREACH SEARCH_RESULT IN SEARCH_RESULTS %]
>+                var cover_index = "[% loop.count %]";
>+                search_results[cover_index] = {};
>+                search_results[cover_index].isbn = "[% SEARCH_RESULT.normalized_isbn | html %]";
>+                search_results[cover_index].biblionumber = "[% SEARCH_RESULT.biblionumber | html %]";
>+                search_results[cover_index].processedBiblio = "[% PROCESS biblio_a_href biblionumber => SEARCH_RESULT.biblionumber | html %]"
>+            [% END %]   
>+        </script>
>+    [% END %]
>     <script>
>         var PREF_AmazonCoverImages = parseInt( "[% Koha.Preference('AmazonCoverImages') | html %]", 10);
>         var q_array = new Array();  // will hold search terms, if present
>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 e97198aed4a..49df70e0914 100644
>--- a/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-detail.tt
>+++ b/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-detail.tt
>@@ -59,7 +59,7 @@
> 
>                     <div class="bookcover">
> 
>-                        <div id="biblio-cover-slider" class="cover-slider">
>+                        <div id="biblio-cover-slider" class="cover-slider cover_images_required">
>                             [% IF ( OPACLocalCoverImages ) %]
>                                 [% IF localimages.count %]
>                                     [% FOREACH image IN localimages %]
>@@ -1447,6 +1447,12 @@
>         [% Asset.js("js/ratings.js") | $raw %]
>     [% END %]
> 
>+    [% IF ( Cover_Images_Required ) %]
>+        <script>
>+            var normalized_isbn = "[% normalized_isbn %]";   
>+        </script>
>+    [% END %]
>+
>     [% IF ( OpacHighlightedWords ) %][% Asset.js("lib/jquery/plugins/jquery.highlight-3.js") | $raw %][% END %]
>     [% IF ( Koha.Preference('OPACDetailQRCode') ) %]
>         [% Asset.js("lib/kjua/kjua.min.js") | $raw %]
>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 95fa8d63046..da5284f5ccb 100644
>--- a/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-results.tt
>+++ b/koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-results.tt
>@@ -341,7 +341,7 @@
> 
>                                             [% # Cell 4: Search result details and controls %]
>                                             <td class="bibliocol">
>-                                                <div class="coverimages itemtype_[% SEARCH_RESULT.itemtype | html %]">
>+                                                <div class="coverimages search_cover_images_required itemtype_[% SEARCH_RESULT.itemtype | html %]">
>                                                     <a class="p1" href="/cgi-bin/koha/opac-detail.pl?biblionumber=[% SEARCH_RESULT.biblionumber | uri %]">
>                                                         [% IF ( SEARCH_RESULT.title ) %]
>                                                             [% img_title = SEARCH_RESULT.title %]
>@@ -587,7 +587,21 @@
>     [% IF OpenLibraryCovers || OpenLibrarySearch %]
>         [% Asset.js("js/openlibrary.js") | $raw %]
>     [% END %]
>-
>+    [% IF ( Cover_Images_Required ) %]
>+        <script>
>+            const search_results = {};
>+            [% FOREACH SEARCH_RESULT IN SEARCH_RESULTS %]
>+                var cover_index = "[% loop.count %]";
>+                search_results[cover_index] = {};
>+                search_results[cover_index].isbn = "[% SEARCH_RESULT.normalized_isbn | html %]";
>+                [% IF SEARCH_RESULT.img_title %]
>+                    search_results[cover_index].img_title = "[% SEARCH_RESULT.img_title | html %]";
>+                [% ELSE %]
>+                    search_results[cover_index].img_title = "[% SEARCH_RESULT.biblionumber | html %]";
>+                [% END %]
>+            [% END %]   
>+        </script>
>+    [% END %]
>     <script>
>         [% IF ( Koha.Preference( 'opacuserlogin' ) == 1 ) && ( Koha.Preference( 'OPACHoldRequests' ) == 1 ) %]
>             function holdMultiple() {
>-- 
>2.37.1 (Apple Git-137.1)

Actions: View | Diff | Splinter Review

Attachments on bug 32680: 145457 | 145458 | 145459 | 145474 | 145475 | 145898 | 145899 | 146695 | 147992 | 147993 | 147996 | 147997 | 148129 | 148158 | 148159 | 149868 | 149869 | 149886 | 149887 | 149888 | 149889 | 151191 | 151192 | 151193