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