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