help.pl - bugfix module usage (HTML::Template::Pro)
[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 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
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         );
39 }
40
41 =head1 NAME
42
43 C4::XISBN - Functions for retrieving XISBN content in Koha
44
45 =head1 FUNCTIONS
46
47 This module provides facilities for retrieving ThingISBN and XISBN content in Koha
48
49 =cut
50
51 sub get_biblio_from_xisbn {
52     my $xisbn = shift;
53     my $dbh = C4::Context->dbh;
54     my $query = "SELECT biblionumber FROM biblioitems WHERE isbn=?";
55     my $sth = $dbh->prepare($query);
56     $sth->execute($xisbn);
57     my $xbib_data =  $sth->fetchrow_hashref();
58     my $xbiblio;
59     if ($xbib_data->{biblionumber}) {
60         $xbiblio = GetBiblioData($xbib_data->{biblionumber});
61         $xbiblio->{items} = GetItemsByBiblioitemnumber($xbib_data->{biblionumber});
62     }
63     return ($xbiblio);
64 }
65
66 =head1 get_xisbns($isbn);
67
68 =head2 $isbn is an ISBN string
69
70 =cut
71
72 sub get_xisbns {
73     my ( $isbn ) = @_;
74     my ($response,$thing_response,$xisbn_response,$gapines_response);
75
76     # THINGISBN
77     if ( C4::Context->preference('ThingISBN') ) {
78         my $url = "http://www.librarything.com/api/thingISBN/".$isbn;
79         $thing_response = _get_url($url,'thingisbn');
80     }
81
82     # XISBN
83     if ( C4::Context->preference('XISBN') ) {
84         my $affiliate_id=C4::Context->preference('OCLCAffiliateID');
85         my $limit = C4::Context->preference('XISBNDailyLimit') || 499;
86         my $reached_limit = _service_throttle('xisbn',$limit);
87         my $url = "http://xisbn.worldcat.org/webservices/xid/isbn/".$isbn."?method=getEditions&format=xml&fl=form,year,lang,ed";
88         $url.="&ai=".$affiliate_id if $affiliate_id;
89         unless ($reached_limit) {
90             $xisbn_response = _get_url($url,'xisbn');
91         }
92     }
93
94     # PINES ISBN (Experimental)
95     #if ( C4::Context->preference('PINESISBN') ) {
96     #    my $url = "http://www.librarything.com/api/thingISBN/".$isbn;
97     #    $gapines_response = _get_url($url,'thingisbn');
98     #}
99     $response->{isbn} = [ @{ $xisbn_response->{isbn} or [] }, @{ $thing_response->{isbn} or [] }, @{ $gapines_response->{isbn} or [] } ];
100     my @xisbns;
101     my $unique_xisbns; # a hashref
102
103     # loop through each ISBN and scope to the local collection
104     for my $response_data( @{ $response->{ isbn } } ) {
105         next if $unique_xisbns->{ $response_data->{content} };
106         $unique_xisbns->{ $response_data->{content} }++;
107         my $xbiblio= get_biblio_from_xisbn($response_data->{content});
108         push @xisbns, $xbiblio if $xbiblio; #response_data->{xbiblio}; #->{biblionumber}; # if $xbiblionumber;
109     }
110     return \@xisbns;
111 }
112
113 sub _get_url {
114     my ($url,$service_type) = @_;
115     my $ua = LWP::UserAgent->new(
116         timeout => 2
117         );
118
119     my $response = $ua->get($url);
120     if ($response->is_success) {
121         warn "WARNING could not retrieve $service_type $url" unless $response;
122         if ($response) {
123             my $xmlsimple = XML::Simple->new();
124             my $content = $xmlsimple->XMLin(
125             $response->content,
126             ForceArray => [ qw(isbn) ],
127             ForceContent => 1,
128             );
129             return $content;
130         }
131     } else {
132         warn "WARNING: URL Request Failed " . $response->status_line . "\n";
133     }
134
135 }
136
137
138 # Throttle services to the specified amount
139 sub _service_throttle {
140     my ($service_type,$daily_limit) = @_;
141     my $dbh = C4::Context->dbh;
142     my $sth = $dbh->prepare("SELECT service_count FROM services_throttle WHERE service_type=?");
143     $sth->execute($service_type);
144     my $count = 1;
145
146     while (my $counter = $sth->fetchrow_hashref()) {
147         $count = $counter->{service_count} if $counter->{service_count};
148     }
149
150     # we're over the limit
151     return 1 if $count >= $daily_limit;
152
153     # not over the limit
154     $count++;
155     $sth = $dbh->do("UPDATE services_throttle SET service_count=$count WHERE service_type='xisbn'");
156     return undef;
157 }
158
159 1;
160 __END__
161
162 =head1 NOTES
163
164 =head1 AUTHOR
165
166 Joshua Ferraro <jmf@liblime.com>
167
168 =cut
169