C4/External/Syndetics.pm

   1 package C4::External::Syndetics;
   2 # Copyright (C) 2006 LibLime
   3 # <jmf at liblime dot 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
  17 # with Koha; if not, write to the Free Software Foundation, Inc.,
  18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19
  20 use XML::Simple;
  21 use XML::LibXML;
  22 use LWP::Simple;
  23 use LWP::UserAgent;
  24 use HTTP::Request::Common;
  25
  26 use strict;
  27 use warnings;
  28
  29 use vars qw($VERSION @ISA @EXPORT);
  30
  31 BEGIN {
  32     require Exporter;
  33     $VERSION = 0.03;
  34     @ISA = qw(Exporter);
  35     @EXPORT = qw(
  36         &get_syndetics_index
  37         &get_syndetics_summary
  38         &get_syndetics_toc
  39         &get_syndetics_editions
  40         &get_syndetics_excerpt
  41         &get_syndetics_reviews
  42         &get_syndetics_anotes
  43     );
  44 }
  45
  46 # package-level variable
  47 my $parser = XML::LibXML->new();
  48
  49 =head1 NAME
  50
  51 C4::External::Syndetics - Functions for retrieving Syndetics content in Koha
  52
  53 =head1 FUNCTIONS
  54
  55 This module provides facilities for retrieving Syndetics.com content in Koha
  56
  57 =head2 get_syndetics_summary
  58
  59 =over 4
  60
  61 my $syndetics_summary= &get_syndetics_summary( $isbn );
  62
  63 =back
  64
  65 Get Summary data from Syndetics
  66
  67 =cut
  68
  69 sub get_syndetics_index {
  70     my ( $isbn,$upc,$oclc ) = @_;
  71
  72     my $response = _fetch_syndetics_content('INDEX.XML', $isbn, $upc, $oclc);
  73
  74     my $content = $response->content;
  75     my $xmlsimple = XML::Simple->new();
  76     $response = $xmlsimple->XMLin(
  77         $content,
  78     ) unless !$content;
  79
  80     my $syndetics_elements;
  81     for my $available_type ('SUMMARY','TOC','FICTION','AWARDS1','SERIES1','SPSUMMARY','SPREVIEW', 'AVPROFILE', 'AVSUMMARY','DBCHAPTER','LJREVIEW','PWREVIEW','SLJREVIEW','CHREVIEW','BLREVIEW','HBREVIEW','KIREVIEW','CRITICASREVIEW','ANOTES') {
  82         if (exists $response->{$available_type} && $response->{$available_type} =~ /$available_type/) {
  83             $syndetics_elements->{$available_type} = $available_type;
  84             #warn "RESPONSE: $available_type : $response->{$available_type}";
  85         }
  86     }
  87     return $syndetics_elements if $syndetics_elements;
  88 }
  89
  90 sub get_syndetics_summary {
  91     my ( $isbn, $upc, $oclc, $syndetics_elements ) = @_;
  92
  93     my $summary_type = exists($syndetics_elements->{'AVSUMMARY'}) ? 'AVSUMMARY.XML' : 'SUMMARY.XML';
  94     my $response = _fetch_syndetics_content($summary_type, $isbn, $upc, $oclc);
  95     unless ($response->content_type =~ /xml/) {
  96         return;
  97     }
  98
  99     my $content = $response->content;
 100
 101     my $summary;
 102     eval {
 103         my $doc = $parser->parse_string($content);
 104         $summary = $doc->findvalue('//Fld520');
 105     };
 106     if ($@) {
 107         warn "Error parsing Syndetics $summary_type";
 108     }
 109     return $summary if $summary;
 110 }
 111
 112 sub get_syndetics_toc {
 113     my ( $isbn,$upc,$oclc ) = @_;
 114
 115     my $response = _fetch_syndetics_content('TOC.XML', $isbn, $upc, $oclc);
 116     unless ($response->content_type =~ /xml/) {
 117         return;
 118     }
 119
 120     my $content = $response->content;
 121     my $xmlsimple = XML::Simple->new();
 122     $response = $xmlsimple->XMLin(
 123         $content,
 124         forcearray => [ qw(Fld970) ],
 125     ) unless !$content;
 126     # manipulate response USMARC VarFlds VarDFlds Notes Fld520 a
 127     my $toc;
 128     $toc = \@{$response->{VarFlds}->{VarDFlds}->{SSIFlds}->{Fld970}} if $response;
 129     return $toc if $toc;
 130 }
 131
 132 sub get_syndetics_excerpt {
 133     my ( $isbn,$upc,$oclc ) = @_;
 134
 135     my $response = _fetch_syndetics_content('DBCHAPTER.XML', $isbn, $upc, $oclc);
 136     unless ($response->content_type =~ /xml/) {
 137         return;
 138     }
 139
 140     my $content = $response->content;
 141     my $xmlsimple = XML::Simple->new();
 142     $response = $xmlsimple->XMLin(
 143         $content,
 144         forcearray => [ qw(Fld520) ],
 145     ) unless !$content;
 146     # manipulate response USMARC VarFlds VarDFlds Notes Fld520 a
 147     my $excerpt;
 148     $excerpt = \@{$response->{VarFlds}->{VarDFlds}->{Notes}->{Fld520}} if $response;
 149     return XMLout($excerpt, NoEscape => 1) if $excerpt;
 150 }
 151
 152 sub get_syndetics_reviews {
 153     my ( $isbn,$upc,$oclc,$syndetics_elements ) = @_;
 154
 155     my @reviews;
 156     my $review_sources = [
 157     {title => 'Library Journal Review', file => 'LJREVIEW.XML', element => 'LJREVIEW'},
 158     {title => 'Publishers Weekly Review', file => 'PWREVIEW.XML', element => 'PWREVIEW'},
 159     {title => 'School Library Journal Review', file => 'SLJREVIEW.XML', element => 'SLJREVIEW'},
 160     {title => 'CHOICE Review', file => 'CHREVIEW.XML', element => 'CHREVIEW'},
 161     {title => 'Booklist Review', file => 'BLREVIEW.XML', element => 'BLREVIEW'},
 162     {title => 'Horn Book Review', file => 'HBREVIEW.XML', element => 'HBREVIEW'},
 163     {title => 'Kirkus Book Review', file => 'KIREVIEW.XML', element => 'KIREVIEW'},
 164     {title => 'Criticas Review', file => 'CRITICASREVIEW.XML', element => 'CRITICASREVIEW'},
 165     {title => 'Spanish Review', file => 'SPREVIEW.XML', element => 'SPREVIEW'},
 166     ];
 167
 168     for my $source (@$review_sources) {
 169         if ($syndetics_elements->{$source->{element}} and $source->{element} =~ $syndetics_elements->{$source->{element}}) {
 170
 171         } else {
 172             #warn "Skipping $source->{element} doesn't match $syndetics_elements->{$source->{element}} \n";
 173             next;
 174         }
 175         my $response = _fetch_syndetics_content($source->{file}, $isbn, $upc, $oclc);
 176         unless ($response->content_type =~ /xml/) {
 177             next;
 178         }
 179
 180         my $content = $response->content;
 181
 182         eval {
 183             my $doc = $parser->parse_string($content);
 184
 185             # note that using findvalue strips any HTML elements embedded
 186             # in that review.  That helps us handle slight differences
 187             # in the output provided by Syndetics 'old' and 'new' versions
 188             # of their service and cleans any questionable HTML that
 189             # may be present in the reviews, but does mean that any
 190             # <B> and <I> tags used to format the review are also gone.
 191             my $result = $doc->findvalue('//Fld520');
 192             push @reviews, {title => $source->{title}, reviews => [ { content => $result } ]} if $result;
 193         };
 194         if ($@) {
 195             warn "Error parsing Syndetics $source->{title} review";
 196         }
 197     }
 198     return \@reviews;
 199 }
 200
 201 sub get_syndetics_editions {
 202     my ( $isbn,$upc,$oclc ) = @_;
 203
 204     my $response = _fetch_syndetics_content('FICTION.XML', $isbn, $upc, $oclc);
 205     unless ($response->content_type =~ /xml/) {
 206         return;
 207     }
 208
 209     my $content = $response->content;
 210
 211     my $xmlsimple = XML::Simple->new();
 212     $response = $xmlsimple->XMLin(
 213         $content,
 214         forcearray => [ qw(Fld020) ],
 215     ) unless !$content;
 216     # manipulate response USMARC VarFlds VarDFlds Notes Fld520 a
 217     my $similar_items;
 218     $similar_items = \@{$response->{VarFlds}->{VarDFlds}->{NumbCode}->{Fld020}} if $response;
 219     return $similar_items if $similar_items;
 220 }
 221
 222 sub get_syndetics_anotes {
 223     my ( $isbn,$upc,$oclc) = @_;
 224
 225     my $response = _fetch_syndetics_content('ANOTES.XML', $isbn, $upc, $oclc);
 226     unless ($response->content_type =~ /xml/) {
 227         return;
 228     }
 229
 230     my $content = $response->content;
 231
 232     my $xmlsimple = XML::Simple->new();
 233     $response = $xmlsimple->XMLin(
 234         $content,
 235         forcearray => [ qw(Fld980) ],
 236         ForceContent => 1,
 237     ) unless !$content;
 238     my @anotes;
 239     for my $fld980 (@{$response->{VarFlds}->{VarDFlds}->{SSIFlds}->{Fld980}}) {
 240         # this is absurd, but sometimes this data serializes differently
 241         if(ref($fld980->{a}->{content}) eq 'ARRAY') {
 242             for my $content (@{$fld980->{a}->{content}}) {
 243                 push @anotes, {content => $content};
 244
 245             }
 246         }
 247         else {
 248             push @anotes, {content => $fld980->{a}->{content}};
 249         }
 250     }
 251     return \@anotes;
 252 }
 253
 254 sub _fetch_syndetics_content {
 255     my ( $element, $isbn, $upc, $oclc ) = @_;
 256
 257     $isbn = '' unless defined $isbn;
 258     $upc  = '' unless defined $upc;
 259     $oclc = '' unless defined $oclc;
 260
 261     my $syndetics_client_code = C4::Context->preference('SyndeticsClientCode');
 262
 263     my $url = "http://www.syndetics.com/index.aspx?isbn=$isbn/$element&client=$syndetics_client_code&type=xw10&upc=$upc&oclc=$oclc";
 264     my $ua = LWP::UserAgent->new;
 265     $ua->timeout(10);
 266     $ua->env_proxy;
 267     my $response = $ua->get($url);
 268
 269     warn "could not retrieve $url" unless $response->content;
 270     return $response;
 271
 272 }
 273 1;
 274 __END__
 275
 276 =head1 NOTES
 277
 278 =head1 AUTHOR
 279
 280 Joshua Ferraro <jmf@liblime.com>
 281
 282 =cut