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