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_data = 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_data->{content});
  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                 use Data::Dumper;
  61                 warn Dumper($xbiblio->{items});
  62         }
  63         return ($xbiblio);
  64
  65 }
  66 =head1 get_xisbns($isbn);
  67
  68 =head2 $isbn is an ISBN string
  69
  70 =cut
  71
  72 sub get_xisbns {
  73     my ( $isbn ) = @_;
  74
  75     my ($response,$thing_response,$xisbn_response,$gapines_response);
  76     # THINGISBN
  77     if ( C4::Context->preference('ThingISBN') ) {
  78         my $url = "http://www.librarything.com/api/thingISBN/".$isbn;
  79         $thing_response = _get_url($url,'thingisbn');
  80     }
  81
  82     # XISBN
  83     if ( C4::Context->preference('XISBN') ) {
  84         my $affiliate_id=C4::Context->preference('OCLCAffiliateID');
  85                 my $limit = C4::Context->preference('XISBNDailyLimit') || 499;
  86         my $reached_limit = _service_throttle('xisbn',$limit);
  87         my $url = "http://xisbn.worldcat.org/webservices/xid/isbn/".$isbn."?method=getEditions&format=xml&fl=form,year,lang,ed";
  88                 $url.="&ai=".$affiliate_id if $affiliate_id;
  89                 unless ($reached_limit) {
  90                 $xisbn_response = _get_url($url,'xisbn');
  91                 }
  92     }
  93
  94     # PINES ISBN
  95     if ( C4::Context->preference('PINESISBN') ) {
  96         my $url = "http://www.librarything.com/api/thingISBN/".$isbn;
  97         $gapines_response = _get_url($url,'thingisbn');
  98     }
  99         $response->{isbn} = [ @{ $xisbn_response->{isbn} or [] }, @{ $thing_response->{isbn} or [] }, @{ $gapines_response->{isbn} or [] } ];
 100         my @xisbns;
 101         my $unique_xisbns; # a hashref
 102         # loop through each ISBN and scope to the local collection
 103         for my $response_data( @{ $response->{ isbn } } ) {
 104                 next if $unique_xisbns->{ $response_data->{content} };
 105                 $unique_xisbns->{ $response_data->{content} }++;
 106                 my $xbiblio= get_biblio_from_xisbn($response_data);
 107                 push @xisbns, $xbiblio if $xbiblio; #response_data->{xbiblio}; #->{biblionumber}; # if $xbiblionumber;
 108
 109         }
 110         return \@xisbns;
 111
 112 }
 113
 114 sub _get_url {
 115     my ($url,$service_type) = @_;
 116         my $ua = LWP::UserAgent->new(
 117                 timeout => 2
 118                 );
 119
 120         my $response = $ua->get($url);
 121         if ($response->is_success) {
 122         warn "WARNING could not retrieve $service_type $url" unless $response;
 123         if ($response) {
 124                 my $xmlsimple = XML::Simple->new();
 125                 my $content = $xmlsimple->XMLin(
 126             $response->content,
 127             ForceArray => [ qw(isbn) ],
 128             ForceContent => 1,
 129             );
 130                         return $content;
 131         }
 132         } else {
 133         warn "WARNING: URL Request Failed " . $response->status_line . "\n";
 134     }
 135
 136 }
 137
 138
 139 # Throttle services to the specified amount
 140 sub _service_throttle {
 141     my ($service_type,$daily_limit) = @_;
 142         my $dbh = C4::Context->dbh;
 143     my $sth = $dbh->prepare("SELECT service_count FROM services_throttle WHERE service_type=?");
 144     $sth->execute($service_type);
 145     my $count = 1;
 146
 147     while (my $counter = $sth->fetchrow_hashref()) {
 148         $count = $counter->{service_count} if $counter->{service_count};
 149     }
 150
 151     # we're over the limit
 152     return 1 if $count >= $daily_limit;
 153
 154     # not over the limit
 155     $count++;
 156     $sth = $dbh->do("UPDATE services_throttle SET service_count=$count WHERE service_type='xisbn'");
 157     return undef;
 158 }
 159
 160 =head1 NOTES
 161
 162 =head1 AUTHOR
 163
 164 Joshua Ferraro <jmf@liblime.com>
 165 =cut