Bug 20892: Correct basketgroup link in histsearch.pl
[koha.git] / C4 / XISBN.pm
blob884d772a413a0661b3344dce28445658f8315e91
1 package C4::XISBN;
2 # Copyright (C) 2007 LibLime
3 # Joshua Ferraro <jmf@liblime.com>
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
20 use XML::Simple;
21 #use LWP::Simple;
22 use C4::Biblio;
23 use C4::Koha;
24 use C4::Search;
25 use C4::External::Syndetics qw(get_syndetics_editions);
26 use LWP::UserAgent;
27 use HTTP::Request::Common;
29 use Koha::Biblios;
30 use Koha::SearchEngine;
31 use Koha::SearchEngine::Search;
33 use strict;
34 #use warnings; FIXME - Bug 2505
35 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
37 BEGIN {
38 require Exporter;
39 @ISA = qw(Exporter);
40 @EXPORT_OK = qw(
41 &get_xisbns
45 =head1 NAME
47 C4::XISBN - Functions for retrieving XISBN content in Koha
49 =head1 FUNCTIONS
51 This module provides facilities for retrieving ThingISBN and XISBN content in Koha
53 =cut
55 sub _get_biblio_from_xisbn {
56 my $xisbn = shift;
57 my $dbh = C4::Context->dbh;
59 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
60 my ( $errors, $results, $total_hits ) = $searcher->simple_search_compat( "nb=$xisbn", 0, 1 );
61 return unless ( !$errors && scalar @$results );
63 my $record = C4::Search::new_record_from_zebra( 'biblioserver', $results->[0] );
64 my $biblionumber = C4::Biblio::TransformMarcToKohaOneField( 'biblio.biblionumber', $record );
65 return unless $biblionumber;
67 my $biblio = Koha::Biblios->find( $biblionumber );
68 return unless $biblio;
69 my $isbn = $biblio->biblioitem->isbn;
70 $biblio = $biblio->unblessed;
71 $biblio->{normalized_isbn} = GetNormalizedISBN($isbn);
72 return $biblio;
75 =head1 get_xisbns($isbn);
77 =head2 $isbn is an ISBN string
79 =cut
81 sub get_xisbns {
82 my ( $isbn ) = @_;
83 my ($response,$thing_response,$xisbn_response,$syndetics_response,$errors);
84 # THINGISBN
85 if ( C4::Context->preference('ThingISBN') ) {
86 my $url = "http://www.librarything.com/api/thingISBN/".$isbn;
87 $thing_response = _get_url($url,'thingisbn');
90 if ( C4::Context->preference("SyndeticsEnabled") && C4::Context->preference("SyndeticsEditions") ) {
91 my $syndetics_preresponse = &get_syndetics_editions($isbn);
92 my @syndetics_response;
93 for my $response (@$syndetics_preresponse) {
94 push @syndetics_response, {content => $response->{a}};
96 $syndetics_response = {isbn => \@syndetics_response};
99 # XISBN
100 if ( C4::Context->preference('XISBN') ) {
101 my $affiliate_id=C4::Context->preference('OCLCAffiliateID');
102 my $limit = C4::Context->preference('XISBNDailyLimit') || 999;
103 my $reached_limit = _service_throttle('xisbn',$limit);
104 my $url = "http://xisbn.worldcat.org/webservices/xid/isbn/".$isbn."?method=getEditions&format=xml&fl=form,year,lang,ed";
105 $url.="&ai=".$affiliate_id if $affiliate_id;
106 unless ($reached_limit) {
107 $xisbn_response = _get_url($url,'xisbn');
109 $errors->{xisbn} = $xisbn_response->{ stat }
110 if $xisbn_response->{ stat } ne 'ok';
113 $response->{isbn} = [ @{ $xisbn_response->{isbn} or [] }, @{ $syndetics_response->{isbn} or [] }, @{ $thing_response->{isbn} or [] } ];
114 my @xisbns;
115 my $unique_xisbns; # a hashref
117 # loop through each ISBN and scope to the local collection
118 for my $response_data( @{ $response->{ isbn } } ) {
119 next if $response_data->{'content'} eq $isbn;
120 next if $isbn eq $response_data;
121 next if $unique_xisbns->{ $response_data->{content} };
122 $unique_xisbns->{ $response_data->{content} }++;
123 my $xbiblio= _get_biblio_from_xisbn($response_data->{content});
124 push @xisbns, $xbiblio if $xbiblio;
126 if ( wantarray ) {
127 return (\@xisbns, $errors);
129 else {
130 return \@xisbns;
134 sub _get_url {
135 my ($url,$service_type) = @_;
136 my $ua = LWP::UserAgent->new(
137 timeout => 2
140 my $response = $ua->get($url);
141 if ($response->is_success) {
142 warn "WARNING could not retrieve $service_type $url" unless $response;
143 if ($response) {
144 my $xmlsimple = XML::Simple->new();
145 my $content = $xmlsimple->XMLin(
146 $response->content,
147 ForceArray => [ qw(isbn) ],
148 ForceContent => 1,
150 return $content;
152 } else {
153 warn "WARNING: URL Request Failed " . $response->status_line . "\n";
159 # Throttle services to the specified amount
160 sub _service_throttle {
161 my ($service_type,$daily_limit) = @_;
162 my $dbh = C4::Context->dbh;
163 my $sth = $dbh->prepare(q{ SELECT service_count FROM services_throttle WHERE service_type=? });
164 $sth->execute($service_type);
165 my $count = 0;
167 if ($sth->rows == 0) {
168 # initialize services throttle
169 my $sth2 = $dbh->prepare(q{ INSERT INTO services_throttle (service_type, service_count) VALUES (?, ?) });
170 $sth2->execute($service_type, $count);
171 } else {
172 $count = $sth->fetchrow_array;
175 # we're over the limit
176 return 1 if $count >= $daily_limit;
178 # not over the limit
179 $count++;
180 my $sth3 = $dbh->prepare(q{ UPDATE services_throttle SET service_count=? WHERE service_type=? });
181 $sth3->execute($count, $service_type);
183 return undef;
187 __END__
189 =head1 NOTES
191 =cut
193 =head1 AUTHOR
195 Joshua Ferraro <jmf@liblime.com>
197 =cut