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 strict;
  30 #use warnings; FIXME - Bug 2505
  31 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  32
  33 BEGIN {
  34         require Exporter;
  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     my $dbh = C4::Context->dbh;
  65
  66     my ( $errors, $results, $total_hits ) = C4::Search::SimpleSearch( "nb=$xisbn", 0, 1 );
  67     return unless ( !$errors && scalar @$results );
  68
  69     my $record = C4::Search::new_record_from_zebra( 'biblioserver', $results->[0] );
  70     my $biblionumber = C4::Biblio::get_koha_field_from_marc('biblio', 'biblionumber', $record, '');
  71     return unless $biblionumber;
  72
  73     my $xbiblio = GetBiblioData($biblionumber);
  74     return unless $xbiblio;
  75     $xbiblio->{normalized_isbn} = GetNormalizedISBN($xbiblio->{isbn});
  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,$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') || 999;
 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     $response->{isbn} = [ @{ $xisbn_response->{isbn} or [] },  @{ $syndetics_response->{isbn} or [] }, @{ $thing_response->{isbn} or [] } ];
 116     my @xisbns;
 117     my $unique_xisbns; # a hashref
 118
 119     # loop through each ISBN and scope to the local collection
 120     for my $response_data( @{ $response->{ isbn } } ) {
 121         next if $response_data->{'content'} eq $isbn;
 122         next if $isbn eq $response_data;
 123         next if $unique_xisbns->{ $response_data->{content} };
 124         $unique_xisbns->{ $response_data->{content} }++;
 125         my $xbiblio= _get_biblio_from_xisbn($response_data->{content});
 126         push @xisbns, $xbiblio if $xbiblio;
 127     }
 128     return \@xisbns;
 129 }
 130
 131 sub _get_url {
 132     my ($url,$service_type) = @_;
 133     my $ua = LWP::UserAgent->new(
 134         timeout => 2
 135         );
 136
 137     my $response = $ua->get($url);
 138     if ($response->is_success) {
 139         warn "WARNING could not retrieve $service_type $url" unless $response;
 140         if ($response) {
 141             my $xmlsimple = XML::Simple->new();
 142             my $content = $xmlsimple->XMLin(
 143             $response->content,
 144             ForceArray => [ qw(isbn) ],
 145             ForceContent => 1,
 146             );
 147             return $content;
 148         }
 149     } else {
 150         warn "WARNING: URL Request Failed " . $response->status_line . "\n";
 151     }
 152
 153 }
 154
 155
 156 # Throttle services to the specified amount
 157 sub _service_throttle {
 158     my ($service_type,$daily_limit) = @_;
 159     my $dbh = C4::Context->dbh;
 160     my $sth = $dbh->prepare(q{ SELECT service_count FROM services_throttle WHERE service_type=? });
 161     $sth->execute($service_type);
 162     my $count = 0;
 163
 164     if ($sth->rows == 0) {
 165         # initialize services throttle
 166         my $sth2 = $dbh->prepare(q{ INSERT INTO services_throttle (service_type, service_count) VALUES (?, ?) });
 167         $sth2->execute($service_type, $count);
 168     } else {
 169         $count = $sth->fetchrow_array;
 170     }
 171
 172     # we're over the limit
 173     return 1 if $count >= $daily_limit;
 174
 175     # not over the limit
 176     $count++;
 177     my $sth3 = $dbh->prepare(q{ UPDATE services_throttle SET service_count=? WHERE service_type=? });
 178     $sth3->execute($count, $service_type);
 179
 180     return undef;
 181 }
 182
 183 1;
 184 __END__
 185
 186 =head1 NOTES
 187
 188 =cut
 189
 190 =head1 AUTHOR
 191
 192 Joshua Ferraro <jmf@liblime.com>
 193
 194 =cut
 195