bug 2817: Added support to pull Amazon information based on UPC, EAN, and 13-digit...
[koha.git] / C4 / Amazon.pm
1 package C4::Amazon;
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 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 LWP::UserAgent;
23 use HTTP::Request::Common;
24
25 use strict;
26 use warnings;
27
28 use vars qw($VERSION @ISA @EXPORT);
29
30 BEGIN {
31     require Exporter;
32     $VERSION = 0.03;
33     @ISA = qw(Exporter);
34     @EXPORT = qw(
35         &get_amazon_details
36         &check_search_inside
37     );
38 }
39
40 =head1 NAME
41
42 C4::Amazon - Functions for retrieving Amazon.com content in Koha
43
44 =head1 FUNCTIONS
45
46 This module provides facilities for retrieving Amazon.com content in Koha
47
48 =head2 get_amazon_details
49
50 =over 4
51
52 my $amazon_details = &get_amazon_details( $xisbn, $record, $marcflavour );
53 Get editorial reviews, customer reviews, and similar products using Amazon Web Services.
54
55 =cut
56
57 sub get_amazon_details {
58     my ( $isbn, $record, $marcflavour ) = @_;
59
60     #normalize the ISBN
61     $isbn = _normalize_match_point ($isbn);
62
63     my $upc = _get_amazon_upc($record,$marcflavour);
64     my $ean = _get_amazon_ean($record,$marcflavour);
65
66     # warn "ISBN: $isbn | UPC: $upc | EAN: $ean";
67
68     my ( $id_type, $item_id);
69     if (length($isbn) eq 13) { # if the isbn is 13-digit, search Amazon using EAN
70         $id_type = 'EAN';
71         $item_id = $isbn;
72     }
73     elsif ($isbn) {
74         $id_type = 'ASIN';
75         $item_id = $isbn;
76     }
77     elsif ($upc) {
78         $id_type = 'UPC';
79         $item_id = $upc;
80     }
81     elsif ($ean) {
82         $id_type = 'EAN';
83         $item_id = $upc;
84     }
85     else { # if no ISBN, UPC, or EAN exists, do not even attempt to query Amazon
86         return undef;
87     }
88
89     my $format = substr $record->leader(), 6, 1; # grab the item format to determine Amazon search index
90     my $formats;
91     $formats->{'a'} = 'Books';
92     $formats->{'g'} = 'Video';
93     $formats->{'j'} = 'Music';
94
95     my $search_index = $formats->{$format};
96
97     # Determine which content to grab in the request
98
99     # Determine correct locale
100     my $locale_hashref = {
101         CA => '.ca',
102         DE => '.de',
103         FR => '.fr',
104         JP => '.jp',
105         UK => '.co.uk',
106         US => '.com',
107     };
108
109     my $amazon_locale_syspref = C4::Context->preference('AmazonLocale');
110     my $tld = $locale_hashref->{$amazon_locale_syspref} || '.com'; # default top level domain is .com
111
112     # grab the AWSAccessKeyId: mine is '0V5RRRRJZ3HR2RQFNHR2'
113     my $aws_access_key_id = C4::Context->preference('AWSAccessKeyID');
114
115     #grab the associates tag: mine is 'kadabox-20'
116     my $af_tag=C4::Context->preference('AmazonAssocTag');
117     my $response_group = "Similarities,EditorialReview,Reviews,ItemAttributes,Images";
118     my $url = "http://ecs.amazonaws$tld/onca/xml?Service=AWSECommerceService&AWSAccessKeyId=$aws_access_key_id&Operation=ItemLookup&AssociateTag=$af_tag&Version=2007-01-15&ItemId=$item_id&IdType=$id_type&ResponseGroup=$response_group";
119     if ($id_type ne 'ASIN') {
120         $url .= "&SearchIndex=$search_index";
121     }
122     # warn $url;
123     my $content = get($url);
124     warn "could not retrieve $url" unless $content;
125     my $xmlsimple = XML::Simple->new();
126     my $response = $xmlsimple->XMLin(
127         $content,
128         forcearray => [ qw(SimilarProduct EditorialReview Review) ],
129     ) unless !$content;
130     return $response;
131 }
132
133 sub check_search_inside {
134         my $isbn = shift;
135         my $ua = LWP::UserAgent->new(
136         agent => "Mozilla/4.76 [en] (Win98; U)",
137         keep_alive => 1,
138         env_proxy => 1,
139         );
140         my $available = 1;
141         my $uri = "http://www.amazon.com/gp/reader/$isbn/ref=sib_dp_pt/002-7879865-0184864#reader-link";
142         my $req = HTTP::Request->new(GET => $uri);
143         $req->header (
144                 'Accept' => 'image/gif, image/x-xbitmap, image/jpeg, image/pjpeg, image/png, */*',
145                 'Accept-Charset' => 'iso-8859-1,*,utf-8',
146                 'Accept-Language' => 'en-US' );
147         my $res = $ua->request($req);
148         my $content = $res->content();
149         if ($content =~ m/This book is temporarily unavailable/) {
150             undef $available;
151         }
152         return $available;
153 }
154
155 sub _get_amazon_upc {
156         my ($record,$marcflavour) = @_;
157         my (@fields,$upc);
158
159         if ($marcflavour eq 'MARC21') {
160                 @fields = $record->field('024');
161                 foreach my $field (@fields) {
162                         my $indicator = $field->indicator(1);
163                         my $upc = _normalize_match_point($field->subfield('a'));
164                         if ($indicator == 1 and $upc ne '') {
165                                 return $upc;
166                         }
167                 }
168         }
169         else { # assume unimarc if not marc21
170                 @fields = $record->field('072');
171                 foreach my $field (@fields) {
172                         my $upc = _normalize_match_point($field->subfield('a'));
173                         if ($upc ne '') {
174                                 return $upc;
175                         }
176                 }
177         }
178 }
179
180 sub _get_amazon_ean {
181         my ($record,$marcflavour) = @_;
182         my (@fields,$ean);
183
184         if ($marcflavour eq 'MARC21') {
185                 @fields = $record->field('024');
186                 foreach my $field (@fields) {
187                         my $indicator = $field->indicator(1);
188                         my $upc = _normalize_match_point($field->subfield('a'));
189                         if ($indicator == 3 and $upc ne '') {
190                                 return $upc;
191                         }
192                 }
193         }
194         else { # assume unimarc if not marc21
195                 @fields = $record->field('073');
196                 foreach my $field (@fields) {
197                         my $upc = _normalize_match_point($field->subfield('a'));
198                         if ($upc ne '') {
199                                 return $upc;
200                         }
201                 }
202         }
203 }
204
205 sub _normalize_match_point {
206         my $match_point = shift;
207         (my $normalized_match_point) = $match_point =~ /([\d-]*[X]*)/;
208         $normalized_match_point =~ s/-//g;
209
210         return $normalized_match_point;
211 }
212
213 1;
214 __END__
215
216 =head1 NOTES
217
218 =head1 AUTHOR
219
220 Joshua Ferraro <jmf@liblime.com>
221
222 =cut