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