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::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 vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  31
  32 BEGIN {
  33         require Exporter;
  34         $VERSION = 3.01;
  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         $xbiblio->{items} = GetItemsByBiblioitemnumber($xbib_data->{biblionumber});
  75     }
  76     return ($xbiblio);
  77 }
  78
  79 =head1 get_xisbns($isbn);
  80
  81 =head2 $isbn is an ISBN string
  82
  83 =cut
  84
  85 sub get_xisbns {
  86     my ( $isbn ) = @_;
  87     my ($response,$thing_response,$xisbn_response,$gapines_response,$syndetics_response);
  88     # THINGISBN
  89     if ( C4::Context->preference('ThingISBN') ) {
  90         my $url = "http://www.librarything.com/api/thingISBN/".$isbn;
  91         $thing_response = _get_url($url,'thingisbn');
  92     }
  93
  94         if ( C4::Context->preference("SyndeticsEnabled") && C4::Context->preference("SyndeticsEditions") ) {
  95         my $syndetics_preresponse = &get_syndetics_editions($isbn);
  96                 my @syndetics_response;
  97                 for my $response (@$syndetics_preresponse) {
  98                         push @syndetics_response, {content => $response->{a}};
  99                 }
 100                 $syndetics_response = {isbn => \@syndetics_response};
 101         }
 102
 103     # XISBN
 104     if ( C4::Context->preference('XISBN') ) {
 105         my $affiliate_id=C4::Context->preference('OCLCAffiliateID');
 106         my $limit = C4::Context->preference('XISBNDailyLimit') || 499;
 107         my $reached_limit = _service_throttle('xisbn',$limit);
 108         my $url = "http://xisbn.worldcat.org/webservices/xid/isbn/".$isbn."?method=getEditions&format=xml&fl=form,year,lang,ed";
 109         $url.="&ai=".$affiliate_id if $affiliate_id;
 110         unless ($reached_limit) {
 111             $xisbn_response = _get_url($url,'xisbn');
 112         }
 113     }
 114
 115     # PINES ISBN (Experimental)
 116     #if ( C4::Context->preference('PINESISBN') ) {
 117     #    my $url = "http://www.librarything.com/api/thingISBN/".$isbn;
 118     #    $gapines_response = _get_url($url,'thingisbn');
 119     #}
 120     $response->{isbn} = [ @{ $xisbn_response->{isbn} or [] },  @{ $syndetics_response->{isbn} or [] }, @{ $thing_response->{isbn} or [] }, @{ $gapines_response->{isbn} or [] } ];
 121     my @xisbns;
 122     my $unique_xisbns; # a hashref
 123
 124     # loop through each ISBN and scope to the local collection
 125     for my $response_data( @{ $response->{ isbn } } ) {
 126         next if $response_data->{'content'} eq $isbn;
 127         next if $isbn eq $response_data;
 128         next if $unique_xisbns->{ $response_data->{content} };
 129         $unique_xisbns->{ $response_data->{content} }++;
 130         my $xbiblio= _get_biblio_from_xisbn($response_data->{content});
 131         push @xisbns, $xbiblio if $xbiblio;
 132     }
 133     return \@xisbns;
 134 }
 135
 136 sub _get_url {
 137     my ($url,$service_type) = @_;
 138     my $ua = LWP::UserAgent->new(
 139         timeout => 2
 140         );
 141
 142     my $response = $ua->get($url);
 143     if ($response->is_success) {
 144         warn "WARNING could not retrieve $service_type $url" unless $response;
 145         if ($response) {
 146             my $xmlsimple = XML::Simple->new();
 147             my $content = $xmlsimple->XMLin(
 148             $response->content,
 149             ForceArray => [ qw(isbn) ],
 150             ForceContent => 1,
 151             );
 152             return $content;
 153         }
 154     } else {
 155         warn "WARNING: URL Request Failed " . $response->status_line . "\n";
 156     }
 157
 158 }
 159
 160
 161 # Throttle services to the specified amount
 162 sub _service_throttle {
 163     my ($service_type,$daily_limit) = @_;
 164     my $dbh = C4::Context->dbh;
 165     my $sth = $dbh->prepare("SELECT service_count FROM services_throttle WHERE service_type=?");
 166     $sth->execute($service_type);
 167     my $count = 1;
 168
 169     while (my $counter = $sth->fetchrow_hashref()) {
 170         $count = $counter->{service_count} if $counter->{service_count};
 171     }
 172
 173     # we're over the limit
 174     return 1 if $count >= $daily_limit;
 175
 176     # not over the limit
 177     $count++;
 178     $sth = $dbh->do("UPDATE services_throttle SET service_count=$count WHERE service_type='xisbn'");
 179     return undef;
 180 }
 181
 182 1;
 183 __END__
 184
 185 =head1 NOTES
 186
 187 =head1 AUTHOR
 188
 189 Joshua Ferraro <jmf@liblime.com>
 190
 191 =cut
 192