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::TransformMarcToKohaOneField(
  76         'biblio.biblionumber', $record, # Default framework used
  77     );
  78     return unless $biblionumber;
  79
  80     my $biblio = Koha::Biblios->find( $biblionumber );
  81     return unless $biblio;
  82     my $isbn = $biblio->biblioitem->isbn;
  83     $biblio = $biblio->unblessed;
  84     $biblio->{normalized_isbn} = GetNormalizedISBN($isbn);
  85     return $biblio;
  86 }
  87
  88 =head1 get_xisbns($isbn);
  89
  90 =head2 $isbn is an ISBN string
  91
  92 =cut
  93
  94 sub get_xisbns {
  95     my ( $isbn ) = @_;
  96     my ($response,$thing_response,$xisbn_response,$syndetics_response,$errors);
  97     # THINGISBN
  98     if ( C4::Context->preference('ThingISBN') ) {
  99         my $url = "http://www.librarything.com/api/thingISBN/".$isbn;
 100         $thing_response = _get_url($url,'thingisbn');
 101     }
 102
 103         if ( C4::Context->preference("SyndeticsEnabled") && C4::Context->preference("SyndeticsEditions") ) {
 104         my $syndetics_preresponse = &get_syndetics_editions($isbn);
 105                 my @syndetics_response;
 106                 for my $response (@$syndetics_preresponse) {
 107                         push @syndetics_response, {content => $response->{a}};
 108                 }
 109                 $syndetics_response = {isbn => \@syndetics_response};
 110         }
 111
 112     # XISBN
 113     if ( C4::Context->preference('XISBN') ) {
 114         my $affiliate_id=C4::Context->preference('OCLCAffiliateID');
 115         my $limit = C4::Context->preference('XISBNDailyLimit') || 999;
 116         my $reached_limit = _service_throttle('xisbn',$limit);
 117         my $url = "http://xisbn.worldcat.org/webservices/xid/isbn/".$isbn."?method=getEditions&format=xml&fl=form,year,lang,ed";
 118         $url.="&ai=".$affiliate_id if $affiliate_id;
 119         unless ($reached_limit) {
 120             $xisbn_response = _get_url($url,'xisbn');
 121         }
 122         $errors->{xisbn} = $xisbn_response->{ stat }
 123             if $xisbn_response->{ stat } ne 'ok';
 124     }
 125
 126     $response->{isbn} = [ @{ $xisbn_response->{isbn} or [] },  @{ $syndetics_response->{isbn} or [] }, @{ $thing_response->{isbn} or [] } ];
 127     my @xisbns;
 128     my $unique_xisbns; # a hashref
 129
 130     # loop through each ISBN and scope to the local collection
 131     for my $response_data( @{ $response->{ isbn } } ) {
 132         next if $response_data->{'content'} eq $isbn;
 133         next if $isbn eq $response_data;
 134         next if $unique_xisbns->{ $response_data->{content} };
 135         $unique_xisbns->{ $response_data->{content} }++;
 136         my $xbiblio= _get_biblio_from_xisbn($response_data->{content});
 137         push @xisbns, $xbiblio if $xbiblio;
 138     }
 139     if ( wantarray ) {
 140         return (\@xisbns, $errors);
 141     }
 142     else {
 143         return \@xisbns;
 144     }
 145 }
 146
 147 sub _get_url {
 148     my ($url,$service_type) = @_;
 149     my $ua = LWP::UserAgent->new(
 150         timeout => 2
 151         );
 152
 153     my $response = $ua->get($url);
 154     if ($response->is_success) {
 155         warn "WARNING could not retrieve $service_type $url" unless $response;
 156         if ($response) {
 157             my $xmlsimple = XML::Simple->new();
 158             my $content = $xmlsimple->XMLin(
 159             $response->content,
 160             ForceArray => [ qw(isbn) ],
 161             ForceContent => 1,
 162             );
 163             return $content;
 164         }
 165     } else {
 166         warn "WARNING: URL Request Failed " . $response->status_line . "\n";
 167     }
 168
 169 }
 170
 171
 172 # Throttle services to the specified amount
 173 sub _service_throttle {
 174     my ($service_type,$daily_limit) = @_;
 175     my $dbh = C4::Context->dbh;
 176     my $sth = $dbh->prepare(q{ SELECT service_count FROM services_throttle WHERE service_type=? });
 177     $sth->execute($service_type);
 178     my $count = 0;
 179
 180     if ($sth->rows == 0) {
 181         # initialize services throttle
 182         my $sth2 = $dbh->prepare(q{ INSERT INTO services_throttle (service_type, service_count) VALUES (?, ?) });
 183         $sth2->execute($service_type, $count);
 184     } else {
 185         $count = $sth->fetchrow_array;
 186     }
 187
 188     # we're over the limit
 189     return 1 if $count >= $daily_limit;
 190
 191     # not over the limit
 192     $count++;
 193     my $sth3 = $dbh->prepare(q{ UPDATE services_throttle SET service_count=? WHERE service_type=? });
 194     $sth3->execute($count, $service_type);
 195
 196     return undef;
 197 }
 198
 199 1;
 200 __END__
 201
 202 =head1 NOTES
 203
 204 =cut
 205
 206 =head1 AUTHOR
 207
 208 Joshua Ferraro <jmf@liblime.com>
 209
 210 =cut
 211