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