Adds support for Syndetics Excerpts and Editions
[koha_fer] / 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 with
17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
18 # Suite 330, Boston, MA  02111-1307 USA
19
20 use XML::Simple;
21 #use LWP::Simple;
22 use C4::Biblio;
23 use C4::Items;
24 use C4::External::Syndetics qw(get_syndetics_editions);
25 use LWP::UserAgent;
26 use HTTP::Request::Common;
27
28 use strict;
29 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
30
31 BEGIN {
32         require Exporter;
33         $VERSION = 3.01;
34         @ISA = qw(Exporter);
35         @EXPORT_OK = qw(
36                 &get_xisbns
37                 &get_biblio_from_xisbn
38         &get_biblionumber_from_isbn
39         );
40 }
41
42 sub get_biblionumber_from_isbn {
43     my $isbn = shift;
44      if ($isbn =~ /(\d{9,}[X]*)/) {
45         $isbn = $1.'%';
46     }
47     my @biblionumbers;
48     my $dbh=C4::Context->dbh;
49     my $query = "SELECT biblionumber FROM biblioitems WHERE isbn LIKE ? LIMIT 10";
50     my $sth = $dbh->prepare($query);
51     $sth->execute($isbn);
52         return $sth->fetchall_arrayref({});
53 }
54 =head1 NAME
55
56 C4::XISBN - Functions for retrieving XISBN content in Koha
57
58 =head1 FUNCTIONS
59
60 This module provides facilities for retrieving ThingISBN and XISBN content in Koha
61
62 =cut
63
64 sub get_biblio_from_xisbn {
65     my $xisbn = shift;
66     $xisbn .='%' if ($xisbn =~ /(\d{9,}[X]*)/);
67     my $dbh = C4::Context->dbh;
68     my $query = "SELECT biblionumber FROM biblioitems WHERE isbn LIKE ?";
69     my $sth = $dbh->prepare($query);
70     $sth->execute($xisbn);
71     my $xbib_data =  $sth->fetchrow_hashref();
72     my $xbiblio;
73     if ($xbib_data->{biblionumber}) {
74         $xbiblio = GetBiblioData($xbib_data->{biblionumber});
75         $xbiblio->{isbn} =~ /(\d{9,}[X]*)/;
76         $xbiblio->{amazonisbn} = $1;
77         $xbiblio->{items} = GetItemsByBiblioitemnumber($xbib_data->{biblionumber});
78     }
79     return ($xbiblio);
80 }
81
82 =head1 get_xisbns($isbn);
83
84 =head2 $isbn is an ISBN string
85
86 =cut
87
88 sub get_xisbns {
89     my ( $isbn ) = @_;
90     my ($response,$thing_response,$xisbn_response,$gapines_response,$syndetics_response);
91     $isbn =~ /(\d{9,}[X]*)/;
92     $isbn = $1;
93     # THINGISBN
94     if ( C4::Context->preference('ThingISBN') ) {
95         my $url = "http://www.librarything.com/api/thingISBN/".$isbn;
96         $thing_response = _get_url($url,'thingisbn');
97     }
98
99         if ( C4::Context->preference("SyndeticsEnabled") && C4::Context->preference("SyndeticsEditions") ) {
100         my $syndetics_preresponse = &get_syndetics_editions($isbn);
101                 my @syndetics_response;
102                 for my $response (@$syndetics_preresponse) {
103                         push @syndetics_response, {content => $response->{a}};
104                 }
105                 $syndetics_response = {isbn => \@syndetics_response};
106         }
107
108     # XISBN
109     if ( C4::Context->preference('XISBN') ) {
110         my $affiliate_id=C4::Context->preference('OCLCAffiliateID');
111         my $limit = C4::Context->preference('XISBNDailyLimit') || 499;
112         my $reached_limit = _service_throttle('xisbn',$limit);
113         my $url = "http://xisbn.worldcat.org/webservices/xid/isbn/".$isbn."?method=getEditions&format=xml&fl=form,year,lang,ed";
114         $url.="&ai=".$affiliate_id if $affiliate_id;
115         unless ($reached_limit) {
116             $xisbn_response = _get_url($url,'xisbn');
117         }
118     }
119
120     # PINES ISBN (Experimental)
121     #if ( C4::Context->preference('PINESISBN') ) {
122     #    my $url = "http://www.librarything.com/api/thingISBN/".$isbn;
123     #    $gapines_response = _get_url($url,'thingisbn');
124     #}
125     $response->{isbn} = [ @{ $xisbn_response->{isbn} or [] },  @{ $syndetics_response->{isbn} or [] }, @{ $thing_response->{isbn} or [] }, @{ $gapines_response->{isbn} or [] } ];
126     my @xisbns;
127     my $unique_xisbns; # a hashref
128
129     # loop through each ISBN and scope to the local collection
130     for my $response_data( @{ $response->{ isbn } } ) {
131         next if $response_data->{'content'} eq $isbn;
132         next if $isbn eq $response_data;
133         next if $unique_xisbns->{ $response_data->{content} };
134         $unique_xisbns->{ $response_data->{content} }++;
135         my $xbiblio= get_biblio_from_xisbn($response_data->{content});
136         push @xisbns, $xbiblio if $xbiblio; #response_data->{xbiblio}; #->{biblionumber}; # if $xbiblionumber;
137     }
138     return \@xisbns;
139 }
140
141 sub _get_url {
142     my ($url,$service_type) = @_;
143     my $ua = LWP::UserAgent->new(
144         timeout => 2
145         );
146
147     my $response = $ua->get($url);
148     if ($response->is_success) {
149         warn "WARNING could not retrieve $service_type $url" unless $response;
150         if ($response) {
151             my $xmlsimple = XML::Simple->new();
152             my $content = $xmlsimple->XMLin(
153             $response->content,
154             ForceArray => [ qw(isbn) ],
155             ForceContent => 1,
156             );
157             return $content;
158         }
159     } else {
160         warn "WARNING: URL Request Failed " . $response->status_line . "\n";
161     }
162
163 }
164
165
166 # Throttle services to the specified amount
167 sub _service_throttle {
168     my ($service_type,$daily_limit) = @_;
169     my $dbh = C4::Context->dbh;
170     my $sth = $dbh->prepare("SELECT service_count FROM services_throttle WHERE service_type=?");
171     $sth->execute($service_type);
172     my $count = 1;
173
174     while (my $counter = $sth->fetchrow_hashref()) {
175         $count = $counter->{service_count} if $counter->{service_count};
176     }
177
178     # we're over the limit
179     return 1 if $count >= $daily_limit;
180
181     # not over the limit
182     $count++;
183     $sth = $dbh->do("UPDATE services_throttle SET service_count=$count WHERE service_type='xisbn'");
184     return undef;
185 }
186
187 1;
188 __END__
189
190 =head1 NOTES
191
192 =head1 AUTHOR
193
194 Joshua Ferraro <jmf@liblime.com>
195
196 =cut
197