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     my @biblionumbers;
  45     my $dbh=C4::Context->dbh;
  46     my $query = "SELECT biblionumber FROM biblioitems WHERE isbn=?";
  47     my $sth = $dbh->prepare($query);
  48     $sth->execute($isbn);
  49     while ( my $biblionumber = $sth->fetchrow_hashref() ) {
  50         push (@biblionumbers, $biblionumber);
  51     }
  52     return \@biblionumbers;
  53 }
  54 =head1 NAME
  55
  56 C4::XISBN - Functions for retrieving XISBN content in Koha
  57
  58 =head1 FUNCTIONS
  59
  60 This module provides facilities for retrieving ThingISBN and XISBN content in Koha
  61
  62 =cut
  63
  64 sub get_biblio_from_xisbn {
  65     my $xisbn = shift;
  66     my $dbh = C4::Context->dbh;
  67     my $query = "SELECT biblionumber FROM biblioitems WHERE isbn=?";
  68     my $sth = $dbh->prepare($query);
  69     $sth->execute($xisbn);
  70     my $xbib_data =  $sth->fetchrow_hashref();
  71     my $xbiblio;
  72     if ($xbib_data->{biblionumber}) {
  73         $xbiblio = GetBiblioData($xbib_data->{biblionumber});
  74         $xbiblio->{items} = GetItemsByBiblioitemnumber($xbib_data->{biblionumber});
  75     }
  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,$gapines_response);
  88
  89     # THINGISBN
  90     if ( C4::Context->preference('ThingISBN') ) {
  91         my $url = "http://www.librarything.com/api/thingISBN/".$isbn;
  92         $thing_response = _get_url($url,'thingisbn');
  93     }
  94
  95     # XISBN
  96     if ( C4::Context->preference('XISBN') ) {
  97         my $affiliate_id=C4::Context->preference('OCLCAffiliateID');
  98         my $limit = C4::Context->preference('XISBNDailyLimit') || 499;
  99         my $reached_limit = _service_throttle('xisbn',$limit);
 100         my $url = "http://xisbn.worldcat.org/webservices/xid/isbn/".$isbn."?method=getEditions&format=xml&fl=form,year,lang,ed";
 101         $url.="&ai=".$affiliate_id if $affiliate_id;
 102         unless ($reached_limit) {
 103             $xisbn_response = _get_url($url,'xisbn');
 104         }
 105     }
 106
 107     # PINES ISBN (Experimental)
 108     #if ( C4::Context->preference('PINESISBN') ) {
 109     #    my $url = "http://www.librarything.com/api/thingISBN/".$isbn;
 110     #    $gapines_response = _get_url($url,'thingisbn');
 111     #}
 112     $response->{isbn} = [ @{ $xisbn_response->{isbn} or [] }, @{ $thing_response->{isbn} or [] }, @{ $gapines_response->{isbn} or [] } ];
 113     my @xisbns;
 114     my $unique_xisbns; # a hashref
 115
 116     # loop through each ISBN and scope to the local collection
 117     for my $response_data( @{ $response->{ isbn } } ) {
 118         next if $response_data->{'content'} eq $isbn;
 119         next if $isbn eq $response_data;
 120         next if $unique_xisbns->{ $response_data->{content} };
 121         $unique_xisbns->{ $response_data->{content} }++;
 122         my $xbiblio= get_biblio_from_xisbn($response_data->{content});
 123         push @xisbns, $xbiblio if $xbiblio; #response_data->{xbiblio}; #->{biblionumber}; # if $xbiblionumber;
 124     }
 125     return \@xisbns;
 126 }
 127
 128 sub _get_url {
 129     my ($url,$service_type) = @_;
 130     my $ua = LWP::UserAgent->new(
 131         timeout => 2
 132         );
 133
 134     my $response = $ua->get($url);
 135     if ($response->is_success) {
 136         warn "WARNING could not retrieve $service_type $url" unless $response;
 137         if ($response) {
 138             my $xmlsimple = XML::Simple->new();
 139             my $content = $xmlsimple->XMLin(
 140             $response->content,
 141             ForceArray => [ qw(isbn) ],
 142             ForceContent => 1,
 143             );
 144             return $content;
 145         }
 146     } else {
 147         warn "WARNING: URL Request Failed " . $response->status_line . "\n";
 148     }
 149
 150 }
 151
 152
 153 # Throttle services to the specified amount
 154 sub _service_throttle {
 155     my ($service_type,$daily_limit) = @_;
 156     my $dbh = C4::Context->dbh;
 157     my $sth = $dbh->prepare("SELECT service_count FROM services_throttle WHERE service_type=?");
 158     $sth->execute($service_type);
 159     my $count = 1;
 160
 161     while (my $counter = $sth->fetchrow_hashref()) {
 162         $count = $counter->{service_count} if $counter->{service_count};
 163     }
 164
 165     # we're over the limit
 166     return 1 if $count >= $daily_limit;
 167
 168     # not over the limit
 169     $count++;
 170     $sth = $dbh->do("UPDATE services_throttle SET service_count=$count WHERE service_type='xisbn'");
 171     return undef;
 172 }
 173
 174 1;
 175 __END__
 176
 177 =head1 NOTES
 178
 179 =head1 AUTHOR
 180
 181 Joshua Ferraro <jmf@liblime.com>
 182
 183 =cut
 184