bug 8215: (followup) make sure C4::CourseReserves doesn't export anything
[koha.git] / C4 / XISBN.pm
1 package C4::XISBN;
2 # Copyright (C) 2007 LibLime
3 # Joshua Ferraro <jmf@liblime.com>
4 #
5 # This file is part of Koha.
6 #
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
10 # version.
11 #
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19
20 use XML::Simple;
21 #use LWP::Simple;
22 use C4::Biblio;
23 use C4::Koha;
24 use C4::External::Syndetics qw(get_syndetics_editions);
25 use LWP::UserAgent;
26 use HTTP::Request::Common;
27
28 use strict;
29 #use warnings; FIXME - Bug 2505
30 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
31
32 BEGIN {
33         require Exporter;
34     $VERSION = 3.07.00.049;
35         @ISA = qw(Exporter);
36         @EXPORT_OK = qw(
37                 &get_xisbns
38         &get_biblionumber_from_isbn
39         );
40 }
41
42 sub get_biblionumber_from_isbn {
43     my $isbn = shift;
44         $isbn.='%';
45     my @biblionumbers;
46     my $dbh=C4::Context->dbh;
47     my $query = "SELECT biblionumber FROM biblioitems WHERE isbn LIKE ? LIMIT 10";
48     my $sth = $dbh->prepare($query);
49     $sth->execute($isbn);
50         return $sth->fetchall_arrayref({});
51 }
52 =head1 NAME
53
54 C4::XISBN - Functions for retrieving XISBN content in Koha
55
56 =head1 FUNCTIONS
57
58 This module provides facilities for retrieving ThingISBN and XISBN content in Koha
59
60 =cut
61
62 sub _get_biblio_from_xisbn {
63     my $xisbn = shift;
64     $xisbn.='%';
65     my $dbh = C4::Context->dbh;
66     my $query = "SELECT biblionumber FROM biblioitems WHERE isbn LIKE ?";
67     my $sth = $dbh->prepare($query);
68     $sth->execute($xisbn);
69     my $xbib_data =  $sth->fetchrow_hashref();
70     my $xbiblio;
71     if ($xbib_data->{biblionumber}) {
72         $xbiblio = GetBiblioData($xbib_data->{biblionumber});
73         $xbiblio->{normalized_isbn} = GetNormalizedISBN($xbiblio->{isbn});
74     }
75     return ($xbiblio);
76 }
77
78 =head1 get_xisbns($isbn);
79
80 =head2 $isbn is an ISBN string
81
82 =cut
83
84 sub get_xisbns {
85     my ( $isbn ) = @_;
86     my ($response,$thing_response,$xisbn_response,$syndetics_response);
87     # THINGISBN
88     if ( C4::Context->preference('ThingISBN') ) {
89         my $url = "http://www.librarything.com/api/thingISBN/".$isbn;
90         $thing_response = _get_url($url,'thingisbn');
91     }
92
93         if ( C4::Context->preference("SyndeticsEnabled") && C4::Context->preference("SyndeticsEditions") ) {
94         my $syndetics_preresponse = &get_syndetics_editions($isbn);
95                 my @syndetics_response;
96                 for my $response (@$syndetics_preresponse) {
97                         push @syndetics_response, {content => $response->{a}};
98                 }
99                 $syndetics_response = {isbn => \@syndetics_response};
100         }
101
102     # XISBN
103     if ( C4::Context->preference('XISBN') ) {
104         my $affiliate_id=C4::Context->preference('OCLCAffiliateID');
105         my $limit = C4::Context->preference('XISBNDailyLimit') || 999;
106         my $reached_limit = _service_throttle('xisbn',$limit);
107         my $url = "http://xisbn.worldcat.org/webservices/xid/isbn/".$isbn."?method=getEditions&format=xml&fl=form,year,lang,ed";
108         $url.="&ai=".$affiliate_id if $affiliate_id;
109         unless ($reached_limit) {
110             $xisbn_response = _get_url($url,'xisbn');
111         }
112     }
113
114     $response->{isbn} = [ @{ $xisbn_response->{isbn} or [] },  @{ $syndetics_response->{isbn} or [] }, @{ $thing_response->{isbn} or [] } ];
115     my @xisbns;
116     my $unique_xisbns; # a hashref
117
118     # loop through each ISBN and scope to the local collection
119     for my $response_data( @{ $response->{ isbn } } ) {
120         next if $response_data->{'content'} eq $isbn;
121         next if $isbn eq $response_data;
122         next if $unique_xisbns->{ $response_data->{content} };
123         $unique_xisbns->{ $response_data->{content} }++;
124         my $xbiblio= _get_biblio_from_xisbn($response_data->{content});
125         push @xisbns, $xbiblio if $xbiblio;
126     }
127     return \@xisbns;
128 }
129
130 sub _get_url {
131     my ($url,$service_type) = @_;
132     my $ua = LWP::UserAgent->new(
133         timeout => 2
134         );
135
136     my $response = $ua->get($url);
137     if ($response->is_success) {
138         warn "WARNING could not retrieve $service_type $url" unless $response;
139         if ($response) {
140             my $xmlsimple = XML::Simple->new();
141             my $content = $xmlsimple->XMLin(
142             $response->content,
143             ForceArray => [ qw(isbn) ],
144             ForceContent => 1,
145             );
146             return $content;
147         }
148     } else {
149         warn "WARNING: URL Request Failed " . $response->status_line . "\n";
150     }
151
152 }
153
154
155 # Throttle services to the specified amount
156 sub _service_throttle {
157     my ($service_type,$daily_limit) = @_;
158     my $dbh = C4::Context->dbh;
159     my $sth = $dbh->prepare(q{ SELECT service_count FROM services_throttle WHERE service_type=? });
160     $sth->execute($service_type);
161     my $count = 0;
162
163     if ($sth->rows == 0) {
164         # initialize services throttle
165         my $sth2 = $dbh->prepare(q{ INSERT INTO services_throttle (service_type, service_count) VALUES (?, ?) });
166         $sth2->execute($service_type, $count);
167     } else {
168         $count = $sth->fetchrow_array;
169     }
170
171     # we're over the limit
172     return 1 if $count >= $daily_limit;
173
174     # not over the limit
175     $count++;
176     my $sth3 = $dbh->prepare(q{ UPDATE services_throttle SET service_count=? WHERE service_type=? });
177     $sth3->execute($count, $service_type);
178
179     return undef;
180 }
181
182 1;
183 __END__
184
185 =head1 NOTES
186
187 =cut
188
189 =head1 AUTHOR
190
191 Joshua Ferraro <jmf@liblime.com>
192
193 =cut
194