ebsco/edsapi-koha-plugin

EBSCO Koha Plugin

edsapi-koha-plugin

edsapi-koha-plugin

The EDS API Plugin for Koha is a project that enables EDS searching in the open source Koha ILS application found at https://koha-community.org/. Development and testing are performed against the code published to the Koha community. While EBSCO does attempt to address issues as they are reported, we can only test and support against the official Koha releases and cannot support modified Koha installs or modified versions of the plugin that have been forked elsewhere. In addition, we cannot guarantee compatibility with other plugins. In order to best support our customers, we encourage pull requests and suggestions that are built against the standard release of Koha.

Refer to the release on the right to download the stable KPZ for your version needs.

IMPORTANT UPGRADE NOTE: When upgrading any version after 20.05002, be sure to go into configure and save the configuration even if values are already present so that templates will generate new javascript properly.

Release 21.11-Stable is valid only for 21.11.05+ and 22.05

Release 21.05-Stable is valid only for 21.05

Release 20.11-Stable is valid only for 20.11

Release 20.05-Stable is valid only for 20.05

Release 19.11-Stable is valid only for 19.11

Release 1905-Stable is valid for 17.05-19.05

use the branch:KohaV16.11x for Koha 16.11x (depricated)

user branch:Koha-v3.22.1x-to-Koha-v16.05.0x for Koha3.22.1 to Koha v16.05 (depricated)

user branch:Koha-v3.16.x-to-Koha-v3.22.0x for Koha3.16 to Koha v3.22 (depricated)

use the branch:KohaV3.14x for Koha 3.14x (depricated)

use the branch:KohaV3.12x for Koha 3.12x (depricated)

minimum Koha version required is Koha 3.12 with plugins enabled

Installation Guide: https://github.com/ebsco/edsapi-koha-plugin/wiki

Quick Installation Steps

Download the package file EDS_Plugin_xx.kpz

Login to Koha Admin and go to the plugin screen

Upload Plugin

Click on Configure and complete the form. Contact [email protected] for field values.

Click Load settings from EBSCOAdmin. Wait for the page to refresh. You might have to click Update Info twice if it initiating connection takes time the first time.

Video Presentations

KohaCon18 | Presentation | Video Recording

KohaCon17 | Presentation | Video Recording

KohaCon16 | Presentation | Video Recording

KohaCon14 | Presentation | Video Recording

Quick Links

Wiki: https://github.com/ebsco/edsapi-koha-plugin/wiki/001.-Home

https://github.com/ebsco/edsapi-koha-plugin/wiki/Patches

https://github.com/ebsco/edsapi-koha-plugin/wiki/Creating-KPZ-files

OpenAthens plugin: https://github.com/ebsco/openathens-koha-plugin

edsapi-koha-plugin's Issues

gss.ebscohost.com/cwu/apps/mgt/gi.png should be served over HTTPS

At the moment gss.ebscohost.com/cwu/apps/mgt/gi.png is served over HTTP which gives you the following warning in the browser console:

"Mixed Content: The page at 'https://xxxxxxx.xxx/' was loaded over HTTPS, but requested an insecure image 'http://gss.ebscohost.com/cwu/apps/mgt/gi.png'. This content should also be served over HTTPS."

I've noticed there is a HTTPS version available, so there's no reason not to use it. I'll send a pull request in a moment.

defaultsearch parameter from configuration doesn't seem to be loading on page

When changing the defaultsearch we don't seem to see this data populated into to page:

Worked around using this in opacuserjs:

// Uncomment the following line to re-enable EDS plugin in the opac.
$.getScript("/plugin/Koha/Plugin/EDS/js/EDSScript.js");
// This overrides the defaultsearch param in plugin config which doesn't seem to be working
$("head").append("

");

included scripts should use https

For SSL sites we get an error on the tool setup, need to fetch the script below as https:

<script type="text/javascript" src="http://widgets.ebscohost.com/prod/common/javascript/gss-common.js"></script>

eds-raw.pl is rendered as text when Load setting from EBSCO Admin now button is clicked

Hi! Using Koha 16.11, running over https, Debian 8 and using Plugin version 16.1103. Whenever I click the "Load setting from EBSCO Admin now" button, the eds-raw.pl is rendered as text. There must be a problem with my setting. I followed this: https://github.com/ebsco/edsapi-koha-plugin/wiki/Apache-Setup and this: #24 but still not successful in getting rid of eds-raw not rendered as text. Any help? Thanks in advance!

Plugin broken in 16.11

Remove use of C4:Branches in EDS.pm

Remove use of C4 Branches in eds-search.pl
Replace
my $branches = Getbranches();
with
my $branches = { map { $->branchcode => $->unblessed } Koha::Libraries->search };

Remove use of C4::Ratings in eds-search.pl

Detailed Error Description Invalid IP

Hi Alvet! I'm trying to configure in a Koha ILS 3.22.x EDS plugin version 3.2205 and I am getting the following errors "{"DetailedErrorDescription":"Invalid IP.","ErrorDescription":"Invalid IP","ErrorNumber":"139"}" whenever I update the information. I tried the IP address of local computers and the IP address of my internet connection using GetLocalIP. Whenever I click the Update info, a new tab is opened and leads me to the IP address of my opac without the ":", i.e. http//domainname.of.opac/plugin/Koha/Plugin/EDS/opac/eds-raw.pl?q=info. There was no username and password set also, does that matter? Thanks in advance!

Software error when plugin tries to update the database

It looks like the plugin is trying to update OpacUserJS and it's creating a fatal software error because whatever it's adding isn't playing well with the existing value in that field.

Can't upload eds_plugin_17.05.kpz from master branch

This is the error message that I'm seeing:

"eds_plugin_17.05.kpz failed to unpack.
Please verify the integrity of the zip file and retry."

Newer versions of perl have trouble with require 'eds-methods.pl' with strict on

The result is that eds-methods.pl won't load, as . isn't in @inc.

can't install plugin on koha 3.18

http://kohageek.blogspot.com/2013/09/how-to-setup-plugin-system-in-koha.html I followed all the steps.
But When I upload the plugin, I am getting the following error.
Cannot unpack file to the plugins directory.Please verify that the Apache
user can write to the plugins directory.
Please help me to fix the problem.

EDSScript.js StartEDS() "basketcount" is used incorrectly

"basketcount" is used incorrectly as a variable at https://github.com/ebsco/edsapi-koha-plugin/blob/master/Koha/Plugin/EDS/js/EDSScript.js#L100-L101.

The only reason it's not "undefined" is because jquery creates a variable "basketcount" as there is an HTML element with an ID of "basketcount". If you console.log(basketcount), you'll get the HTML element and not the actual count.

We actually want to use "basketCount()" which is a function defined in basket.js. That way, we're comparing the contents of the "bib_list" cookie with the "bib_list" in local storage. Or we could not bother doing a comparison and just execute "updateBasket" since it seems we're already overriding the "bib_list" cookie at this stage.

EDS Enabled cart doesn't clear sessions when browser is closed

The normal way a cart is used in Koha is as temporary storage - its contents are cleared when the window is closed.

With EDS enabled and the files patched, the sessions are no longer cleared - closing the window and reopening it and then clicking on the "0 items in your cart," there will still be discovery things there.

custom.js 404

When viewing the OPAC with the plugin enabled, there is an attempt at loading http://example.com/plugin/Koha/Plugin/EDS/js/custom/custom.js but since this file does not exist, it results in a 404 status.

README.md appears to be incorrect regarding versions

On the README it says "use branch:Master for 19.11+ (includes latest features and updates)". However, the KPZ provided on master is eds_plugin_20.05002.kpz and it is listed as having a minimum version of 20.05

Invalid IP

Hi!

I had a Koha installation where the EDS plugin was working nicely, but after some upgrades it does not work. I have narrowed the problem down to this:

When I go to the configure page, I enter the username, password, profileid and customerid, plus all the other information requested. Then I click on "Load setting from EBSCOadmin now", a small window appears and disappears, the button says to wait 10 seconds and then an error is displayed in the "ED settings" field:

{"DetailedErrorDescription":"Invalid IP.","ErrorDescription":"Invalid IP","ErrorNumber":"139"}

I also notice that the password field has changed. The customer's password contains a @, but this has disappeared!

EBSCO Support has provided me with the information "In EBSCOAdmin you have the following IP addresses registered...", and I have entered them into the "IP Addresses" field.

So I am confused as to which IP is invalid? Do I have to do the configuration from one of the IPs that are recognized as belonging to the customer? Can I enter my own IP into the IP field? Any clarification would be most welcome!

Best regards,
Magnus Enger
Libriotech, Norway

Please release the newest version

The kpz in the main directory doesn't seem to work when downloaded - can you double check and add the newest version to the release page?

Error when updating credentials

When trying to update credentials in the config we get a 500 error on submitting the form

The issue appears to be that the edsinfo field contains unescaped quotes and is breaking form submission.

Patch to opac-downloadcart.pl doesn't detect active state of EDS Plugin

We noticed that the cart with the EDS patch applied exhibits the following problem when the EDS plugin is either not installed (well, duh, why would you have the patch then, amirite) or simply disabled (which is a more likely scenario).

It would be nice to have a check around the EDS code to make sure the EDS plugin is enabled. Such an addition might make it possible to upstream the changes to downloadcart to Koha, as well.

EDSScript.js StartEDS() updateBasket(jbib_list.length-1) uses string instead of array

As I mentioned on wizzyrea's issue, "updateBasket(jbib_list.length-1)" is actually using the length of the "bib_list" string coming from local storage rather than the length of the array created by splitting that string on the slash.

https://github.com/ebsco/edsapi-koha-plugin/blob/master/Koha/Plugin/EDS/js/EDSScript.js#L102

require eds-methods.pl needs full path

In Debian 9 the current path is not included by default, moving the line and using $PluginDir seems to fix

Must be done in both eds-search.pl and eds-raw.pl

my $PluginDir = C4::Context->config("pluginsdir");
$PluginDir = $PluginDir.'/Koha/Plugin/EDS';
require $PluginDir.'/opac/eds-methods.pl';

Changing default search engine requires clearing browser storage

When a library set defaultSearch it is saved in browser storage.

If they make a change they must ask all users to clear their browsers to see this take effect

Cannot send basket with Koha 19.05 & plugin 19.05009

Upon trying to send the contents of the basket, we receive the following error:
Undefined subroutine &main::decode_json called at /var/lib/koha/cust/plugins/Koha/Plugin/EDS/opac/eds-methods.pl line 521.
Explicitly adding an import for decode_json alongside the existing encode_json import appears to fix the issue though, checking the mail logs, the mail is never sent. It is silently failing somehow as there are no errors in the log.

Koha: 19.11.03.000 running Plack
Plugin: 19.05009

debug code in EDSScript.js

When downloading a cart there is an alert('asdf');

Issues loading plugin in IE, EDGE, Safari

We are getting reports that on some browsers the dropdown does not correctly load.

After loading the selected option is "Switch to all resources"
If a user attempts to search, it fails. They must select "Library catalog" to search

Error when enabling OpacBrowseResults

OpacBrowseResults causes an 'Internal server error' on details.tt when the plugin is enabled.

EDSscript.js depends on cart (opacbookbag) being enabled

If cart is disabled in 17.05 the 'Switch to catalogue' link ends up creating a blank drop down.

The issue seems to be in the ShowInfo function - without the cart it hangs/dies

Plugin fails on Koha master

https://github.com/ebsco/edsapi-koha-plugin/blob/master/Koha/Plugin/EDS.pm#L6 has this:

use C4::Branch;

but this module has been moved to Koha::Library/Libraries:

Bug 15294 - Move the C4::Branch related code to Koha::Libraries - part 1
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=15294

So it looks like the plugin will need an update to work with current Kohas.

A period is added after opac-detail.pl?biblionumber= when bibliographic details is clicked in eds-search.pl

Hi all! Using Debian 9 and Koha 19.11. I'm getting error 404 when accessing the bibliographic details of records in eds-search.pl. It seems a period is being added in the URL, such that the url is "cgi-bin/koha/opac-detail.pl?biblionumber=.21412&resultid=1" instead of "cgi-bin/koha/opac-detail.pl?biblionumber=.21412&resultid=1". I'm trying to check the plugin where to edit the particular line but I don't know yet what to edit. Any kind soul who can lead me to what to edit. Thanks in advance!

Getting a 404 for a non-existent file /plugin/Koha/Plugin/EDS/bootstrap/includes/lang/en.inc

"/plugin/Koha/Plugin/EDS/bootstrap/includes/lang/en.inc 404 (Not Found)"

Updates for 17.05

We need a second version for 17.05, in:
/var/lib/koha/model/plugins/Koha/Plugin/EDS/opac/eds-search.pl
line 389, the function GetItemTypes has been removed

replace it with:
my $itemtypes = Koha::ItemTypes->search_with_localization;
my %itemtypes = map { $->{itemtype} => $ } @{ $itemtypes->unblessed };

Out of date templates with Koha 20.11

As more and more of our customers move to 20.11 we're encountering problems with the template provided being out of date. Specifically, class names such as row-fluid, span2 & span10 are no longer used, so styles no longer correctly apply.

Advanced search is impossible on branch 3.14.x

Hi,

We recently install EDSAPI-Koha plugin on our 3.14.11 Koha instance. Unfortunately, advanced search seems to be impossible : pressing search button returns a JS alert saying "Please enter a valid year in YYYY format".
After a quick look in EDSScript.js, this message is sent when #common_DT1_ToYear or #common_DT1_FromYear values aren't numeric. However, these fields, presents on master branch, are replaced by a single field without id attribute accepting YYYY-MM/YYYY-MM period form.

Could you please revert EDSScript.js to a functional state or evolve the advanced search on 3.14.x branch to master/3.16.x state ?
Thank you,

Gwendal JONCOUR

EDS titles not added to cart

Since the plugin indicates no patching of core Koha files is required, I've omitted patching the cart on Koha 17.11, and EDS items don't seem to get added to the cart anymore.

can't install plugin on koha 3.14.x

Hi,
I would like to test this plugin, but can not install it on Koha 3.14.x.
KPZ is uploaded but nothing appears then, only the message "No plugins installed".

koha-conf and koha-httpd are well configured as described here and syspref UseKohaPlugins is enabled :-(

Any assistance would be greatly appreciated.
Thanks in advance.
Julien

Remaining use of GetItemTypes Koha/Plugin/EDS/opac/pfi-search.pl

Remote Content (Integrated Search Connectors)

Are there plans to include "Remote Content (Integrated Search Connectors)" Databases as a widget or similar to the way it is displayed in the EDS Search from EBSCO? Also is this the right place to ask this question? Sorry if it isn't.

OPACBaseURL prefixed with http:// in admin/configure.tt

According to Koha systempreferences, OPACBaseURL ... should be a complete URL, starting with http:// or https://.

However, in admin/configure.tt in this plugin, it's prefixed with http:// so retrieving authorization token doesn't work but instead opens new window. (To be honest, it still doesn't work after this change but at least it's a start). It doesn't work because most Koha installations have Intranet installed on different port than OPAC, so using OPACBaseURL to get intranet URL won't work.

Koha version: 3.21.00.037

Bad template paths on 17.11

Change in the way paths are used in Koha

see this commit:
bywatersolutions/koha-plugin-coverflow@6b8886c

I fixed with this:
my $PluginDir = C4::Context->config("pluginsdir");#dirname(abs_path($0));
$PluginDir .= "/Koha/Plugin/EDS";

No longer possible to change labels for 'Discovery'/'Catalogue'

in previous versions it was possible to configure the wording in the search, can this functionality be restored?

Error when trying to email cart

After filling out the form to email the cart order and clicking the 'Submit' button, the following error occurs:

Software error:

Wrong CSRF token at /var/lib/koha/luther/plugins/Koha/Plugin/EDS/opac/1611/opac-sendbasket.pl line 58.

self->store_data inception

There is a strange call at :

edsapi-koha-plugin/Koha/Plugin/EDS.pm

Line 137 in 6a73949

$self->store_data

$self->store_data called inside a $self->store_data.
$seft beeing a Koha::Plugins::Base.

Generates the error
Odd number of elements in anonymous hash at Koha/Plugin/EDS.pm line 132.

Link to full text does not show for items that utilize EBSCO's Digital Archive Viewer

Hello,
We own a couple of different historical archives collections (ATLA Historical Monographs, AAS Historical Periodicals). I recently discovered that when items from these collections appear in a Discovery search within Koha, the link to full text does not appear. Screen shots from an example are attached.
Are there plans to address this in a future release of the plugin?
In the meantime, would it help if I imported MARC records for these collections into Koha, or would that make it worse by causing duplication in Discovery search results? The biggest reason we have Discovery is so that I don't have to import MARC records into Koha for our electronic content.
Thanks for your help,
Myka Kennedy Stephens
Lancaster Theological Seminary
Lancaster, PA

Not Working

It's not working on koha common stable.

Incorrect assignment instead of equality

EDS.pm line 189:
if ($ENV{HTTPS} = "on") {

Should be:
if ($ENV{HTTPS} == "on") {

https://widgets.ebscohost.com/prod/api/koha/apps/gtrans_maori.js contains encoding issue

(I think it's been said that Cam already fixed this, but I haven't seen a fix come through in a while now.)

Looking at https://widgets.ebscohost.com/prod/api/koha/apps/gtrans_maori.js and I see the following:

#google_translate_element > .m::after {
content: "Translate to te reo MÄori";\

In Koha, it actually shows up as "Translate to te reo MÄori"

Looks to me like an encoding issue.

Looks like the UTF-8 hex for ā is 0xC4 0x81. Ä is 00C4 in Latin-1. Of course, à is 00C3 in Latin-1 but „ isn't a Latin-1 character; it's a UTF-8 character of 0xE2 0x80 0x9E and à is 0xC3 0x83 in UTF-8, so I'm not sure what's going up in the actual Javascript.

Search select delayed population can cause user confusion

The final rendering of the <select> that displays search scope options is dependent on the response from the eds-raw.pl API request. We've found this request can take between 2 and 3 seconds to respond, at which point the EDS option is added. Since the EDS option is set to be the default, we encounter a poor user experience as the option is not initially available, so a user may select an alternative, then have their choice altered, or they may simply not know where the EDS option is.

We cannot shortcut this process, since the EDS option cannot be added until the API responds. So a possible solution would be to initially hide or disable the select box until the API response has arrived. This is not an ideal solution, but it is better than the current situation.

Adding catalog items to cart fails

When clickthe add to cart button it seems the local catalog prefix is being added ot koha records, this prevents viewing those records in the cart

Document changes to Apache config?

To get the OPAC scripts to do anything I had to add this to my Apache site config:

   ScriptAlias /plugin/Koha/Plugin/EDS/opac /var/lib/koha/prv/plugins/Koha/Plugin/EDS/opac
   Alias /plugin "/var/lib/koha/prv/plugins"
   # The stanza below is needed for Apache 2.4+
   <Directory /var/lib/koha/prv/plugins>
      Options Indexes FollowSymLinks
      AllowOverride None
      Require all granted
   </Directory>

Is that considered to be part of enabling plugins in Koha, or should it be documented somewhere?

Can't make edsapi-koha-plugin work

Hi! I'm getting the following error:
Software error:
Can't locate eds-methods.pl in @inc (@inc contains: /usr/share/koha/lib /etc/perl /usr/local/lib/x86_64-linux-gnu/perl/5.24.1 /usr/local/share/perl/5.24.1 /usr/lib/x86_64-linux-gnu/perl5/5.24 /usr/share/perl5 /usr/lib/x86_64-linux-gnu/perl/5.24 /usr/share/perl/5.24 /usr/local/lib/site_perl /usr/lib/x86_64-linux-gnu/perl-base) at /var/lib/koha/krc/plugins/Koha/Plugin/EDS/opac/eds-search.pl line 68.

Currently using Koha 18.05.14.000 Perl version 5.024001. eds_plugin_17.11006.kpz is the kpz version I'm trying to use. Lowered it to eds_plugin_17.11005.kpz but still it does not work. eds_plugin_17.11005.kpz worked with 18.05.07.000 production server that we have. Tested first with 19.05 and 18.11 but can't make it work hence lowering it to 18.05. Any idea on how to go about this issue?

EDS plugin filling Koha logs with needless warnings

For the most part, these are warnings about the experimental use of given/when.

Koha doesn't use given/when for this reason, and there have been patches to remove its use in the past:
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=11478
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=11479

I thought there was a line in Koha's coding guidelines but I haven't found it. It might be one of those things which is implicitly understood in the Koha community but isn't recorded explicitly anywhere.