bug 2248 [1/2]: improve item status display in OPAC detail
[koha.git] / opac / opac-detail.pl
1 #!/usr/bin/perl
2
3 # Copyright 2000-2002 Katipo Communications
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
21 use strict;
22 require Exporter;
23 use CGI;
24 use C4::Auth;
25 use C4::Branch;
26 use C4::Koha;
27 use C4::Serials;    #uses getsubscriptionfrom biblionumber
28 use C4::Output;
29 use C4::Biblio;
30 use C4::Items;
31 use C4::Circulation;
32 use C4::Tags qw(get_tags);
33 use C4::Dates qw/format_date/;
34 use C4::XISBN qw(get_xisbns get_biblionumber_from_isbn get_biblio_from_xisbn);
35 use C4::Amazon;
36 use C4::Review;
37 use C4::Serials;
38 use C4::Members;
39 use C4::XSLT;
40
41 BEGIN {
42         if (C4::Context->preference('BakerTaylorEnabled')) {
43                 require C4::External::BakerTaylor;
44                 import C4::External::BakerTaylor qw(&image_url &link_url);
45         }
46 }
47
48 my $query = new CGI;
49 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
50     {
51         template_name   => "opac-detail.tmpl",
52         query           => $query,
53         type            => "opac",
54         authnotrequired => 1,
55         flagsrequired   => { borrow => 1 },
56     }
57 );
58
59 my $biblionumber = $query->param('biblionumber') || $query->param('bib');
60 $template->param( biblionumber => $biblionumber );
61 # XSLT processing of some stuff
62 if (C4::Context->preference("XSLTResultsDisplay") ) {
63     my $newxmlrecord = XSLTParse4Display($biblionumber,C4::Context->config('opachtdocs')."/prog/en/xslt/MARC21slim2OPACDetail.xsl");
64     $template->param('XSLTBloc' => $newxmlrecord);
65 }
66
67 # change back when ive fixed request.pl
68 my @all_items = &GetItemsInfo( $biblionumber, 'opac' );
69 my @items;
70 @items = @all_items unless C4::Context->preference('hidelostitems');
71
72 if (C4::Context->preference('hidelostitems')) {
73     # Hide host items
74     for my $itm (@all_items) {
75         push @items, $itm unless $itm->{itemlost};
76     }
77 }
78 my $dat = &GetBiblioData($biblionumber);
79
80 if (!$dat) {
81     print $query->redirect("/cgi-bin/koha/errors/404.pl");
82     exit;
83 }
84 my $imgdir = getitemtypeimagesrc();
85 my $itemtypes = GetItemTypes();
86 # imageurl:
87 my $itemtype = $dat->{'itemtype'};
88 if ( $itemtype ) {
89     $dat->{'imageurl'}    = $imgdir."/".$itemtypes->{$itemtype}->{'imageurl'};
90     $dat->{'description'} = $itemtypes->{$itemtype}->{'description'};
91 }
92 my $shelflocations =GetKohaAuthorisedValues('items.location',$dat->{'frameworkcode'});
93 my $collections =  GetKohaAuthorisedValues('items.ccode',$dat->{'frameworkcode'} );
94
95 #coping with subscriptions
96 my $subscriptionsnumber = CountSubscriptionFromBiblionumber($biblionumber);
97 my @subscriptions       = GetSubscriptions( $dat->{title}, $dat->{issn}, $biblionumber );
98 my @subs;
99 $dat->{'serial'}=1 if $subscriptionsnumber;
100 foreach my $subscription (@subscriptions) {
101     my %cell;
102     $cell{subscriptionid}    = $subscription->{subscriptionid};
103     $cell{subscriptionnotes} = $subscription->{notes};
104     $cell{branchcode}        = $subscription->{branchcode};
105     $cell{hasalert}          = $subscription->{hasalert};
106     #get the three latest serials.
107     $cell{latestserials} =
108       GetLatestSerials( $subscription->{subscriptionid}, 3 );
109     push @subs, \%cell;
110 }
111
112 $dat->{'count'} = scalar(@items);
113
114 #adding RequestOnOpac filter to allow or not the display of plce reserve button
115 # FIXME - use me or delete me.
116 my $RequestOnOpac;
117 if (C4::Context->preference("RequestOnOpac")) {
118     $RequestOnOpac = 1;
119 }
120
121 my $biblio_authorised_value_images = C4::Items::get_authorised_value_images( C4::Biblio::get_biblio_authorised_values( $biblionumber ) );
122
123 my $norequests = 1;
124 my $branches = GetBranches();
125 my %itemfields;
126 for my $itm (@items) {
127      $norequests = 0 && $norequests
128        if ( (not $itm->{'wthdrawn'} )
129          || (not $itm->{'itemlost'} )
130          || (not $itm->{'itemnotforloan'} )
131          || ($itm->{'itemnumber'} ) );
132         $itm->{ $itm->{'publictype'} } = 1;
133     $itm->{datedue} = format_date($itm->{datedue});
134     $itm->{datelastseen} = format_date($itm->{datelastseen});
135
136     #get collection code description, too
137         my $ccode= $itm->{'ccode'};
138         $itm->{'ccode'} = $collections->{$ccode} if(defined($collections) && exists($collections->{$ccode}));
139     $itm->{'location_description'} = $shelflocations->{$itm->{'location'} };
140     $itm->{'imageurl'}    = $imgdir."/".$itemtypes->{ $itm->{itype} }->{'imageurl'};     
141     $itm->{'description'} = $itemtypes->{$itemtype}->{'description'};
142         $itemfields{ccode} = 1 if($itm->{ccode});
143         $itemfields{enumchron} = 1 if($itm->{enumchron});
144         $itemfields{copynumber} = 1 if($itm->{copynumber});
145
146      # walk through the item-level authorised values and populate some images
147      my $item_authorised_value_images = C4::Items::get_authorised_value_images( C4::Items::get_item_authorised_values( $itm->{'itemnumber'} ) );
148      # warn( Data::Dumper->Dump( [ $item_authorised_value_images ], [ 'item_authorised_value_images' ] ) );
149
150      if ( $itm->{'itemlost'} ) {
151          my $lostimageinfo = List::Util::first { $_->{'category'} eq 'LOST' } @$item_authorised_value_images;
152          $itm->{'lostimageurl'}   = $lostimageinfo->{ 'imageurl' };
153          $itm->{'lostimagelabel'} = $lostimageinfo->{ 'label' };
154      }
155
156     
157      my ( $transfertwhen, $transfertfrom, $transfertto ) = GetTransfers($itm->{itemnumber});
158      if ( $transfertwhen ne '' ) {
159         $itm->{transfertwhen} = format_date($transfertwhen);
160         $itm->{transfertfrom} = $branches->{$transfertfrom}{branchname};
161         $itm->{transfertto}   = $branches->{$transfertto}{branchname};
162      }
163 }
164
165 ## get notes and subjects from MARC record
166 my $dbh              = C4::Context->dbh;
167 my $marcflavour      = C4::Context->preference("marcflavour");
168 my $record           = GetMarcBiblio($biblionumber);
169 my $marcnotesarray   = GetMarcNotes   ($record,$marcflavour);
170 my $marcauthorsarray = GetMarcAuthors ($record,$marcflavour);
171 my $marcsubjctsarray = GetMarcSubjects($record,$marcflavour);
172 my $marcseriesarray  = GetMarcSeries  ($record,$marcflavour);
173 my $marcurlsarray    = GetMarcUrls    ($record,$marcflavour);
174 my $subtitle         = C4::Biblio::get_koha_field_from_marc('bibliosubtitle', 'subtitle', $record, '');
175
176     $template->param(
177                      MARCNOTES               => $marcnotesarray,
178                      MARCSUBJCTS             => $marcsubjctsarray,
179                      MARCAUTHORS             => $marcauthorsarray,
180                      MARCSERIES              => $marcseriesarray,
181                      MARCURLS                => $marcurlsarray,
182                      norequests              => $norequests,
183                      RequestOnOpac           => $RequestOnOpac,
184                      itemdata_ccode          => $itemfields{ccode},
185                      itemdata_enumchron      => $itemfields{enumchron},
186                      itemdata_copynumber     => $itemfields{copynumber},
187                      authorised_value_images => $biblio_authorised_value_images,
188                      subtitle                => $subtitle,
189     );
190
191 foreach ( keys %{$dat} ) {
192     $template->param( "$_" => $dat->{$_} . "" );
193 }
194
195 # COinS format FIXME: for books Only
196 my $coins_format;
197 my $fmt = substr $record->leader(), 6,2;
198 my $fmts;
199 $fmts->{'am'} = 'book';
200 $coins_format = $fmts->{$fmt};
201 $template->param(
202         ocoins_format => $coins_format,
203 );
204
205 my $reviews = getreviews( $biblionumber, 1 );
206 my $loggedincommenter;
207 foreach ( @$reviews ) {
208     my $borrowerData   = GetMember($_->{borrowernumber},'borrowernumber');
209     # setting some borrower info into this hash
210     $_->{title}     = $borrowerData->{'title'};
211     $_->{surname}   = $borrowerData->{'surname'};
212     $_->{firstname} = $borrowerData->{'firstname'};
213     $_->{userid}    = $borrowerData->{'userid'};
214     $_->{datereviewed} = format_date($_->{datereviewed});
215     if ($borrowerData->{'borrowernumber'} eq $borrowernumber) {
216                 $_->{your_comment} = 1;
217                 $loggedincommenter = 1;
218         }
219 }
220
221
222 if(C4::Context->preference("ISBD")) {
223         $template->param(ISBD => 1);
224 }
225
226 $template->param(
227     ITEM_RESULTS        => \@items,
228     subscriptionsnumber => $subscriptionsnumber,
229     biblionumber        => $biblionumber,
230     subscriptions       => \@subs,
231     subscriptionsnumber => $subscriptionsnumber,
232     reviews             => $reviews,
233     loggedincommenter   => $loggedincommenter
234 );
235
236 sub isbn_cleanup ($) {
237         my $isbn=shift;
238         if (
239                 $isbn =~ /\b(\d{13})\b/ or
240                 $isbn =~ /\b(\d{10})\b/ or 
241                 $isbn =~ /\b(\d{9}X)\b/i
242         ) {
243                 return $1;
244         }
245         return undef;
246 }
247
248 # XISBN Stuff
249 my $xisbn=$dat->{'isbn'};
250 $xisbn =~ /(\d*[X]*)/;
251 $template->param(amazonisbn => $1);             # FIXME: so it is OK if the ISBN = 'XXXXX' ?
252 my ($clean,$clean2);
253 # these might be overkill, but they are better than the regexp above.
254 if ($clean = isbn_cleanup($xisbn)){
255         $template->param(clean_isbn => $clean);
256 }
257
258 if (C4::Context->preference("OPACFRBRizeEditions")==1) {
259     eval {
260         $template->param(
261             xisbn => $xisbn,
262             XISBNS => get_xisbns($xisbn)
263         );
264     };
265     if ($@) { warn "XISBN Failed $@"; }
266 }
267 # Amazon.com Stuff
268 if ( C4::Context->preference("OPACAmazonContent") == 1 ) {
269     my $similar_products_exist;
270     my $amazon_details = &get_amazon_details( $xisbn );
271     my $item_attributes = \%{$amazon_details->{Items}->{Item}->{ItemAttributes}};
272     my $customer_reviews = \@{$amazon_details->{Items}->{Item}->{CustomerReviews}->{Review}};
273     for my $one_review (@$customer_reviews) {
274         $one_review->{Date} = format_date($one_review->{Date});
275     }
276     my @similar_products;
277     for my $similar_product (@{$amazon_details->{Items}->{Item}->{SimilarProducts}->{SimilarProduct}}) {
278         # do we have any of these isbns in our collection?
279         my $similar_biblionumbers = get_biblionumber_from_isbn($similar_product->{ASIN});
280         # verify that there is at least one similar item
281         $similar_products_exist++ if ${@$similar_biblionumbers}[0];
282         push @similar_products, +{ similar_biblionumbers => $similar_biblionumbers, title => $similar_product->{Title}, ASIN => $similar_product->{ASIN}  };
283     }
284     my $editorial_reviews = \@{$amazon_details->{Items}->{Item}->{EditorialReviews}->{EditorialReview}};
285     my $average_rating = $amazon_details->{Items}->{Item}->{CustomerReviews}->{AverageRating};
286     $template->param( OPACAmazonSimilarItems => $similar_products_exist );
287     $template->param( amazon_average_rating => $average_rating * 20);
288     $template->param( AMAZON_CUSTOMER_REVIEWS    => $customer_reviews );
289     $template->param( AMAZON_SIMILAR_PRODUCTS => \@similar_products );
290     $template->param( AMAZON_EDITORIAL_REVIEWS    => $editorial_reviews );
291 }
292 # Shelf Browser Stuff
293 if (C4::Context->preference("OPACShelfBrowser")) {
294 # pick the first itemnumber unless one was selected by the user
295 my $starting_itemnumber = $query->param('shelfbrowse_itemnumber'); # || $items[0]->{itemnumber};
296 $template->param( OpenOPACShelfBrowser => 1) if $starting_itemnumber;
297 # find the right cn_sort value for this item
298 my ($starting_cn_sort, $starting_homebranch, $starting_location);
299 my $sth_get_cn_sort = $dbh->prepare("SELECT cn_sort,homebranch,location from items where itemnumber=?");
300 $sth_get_cn_sort->execute($starting_itemnumber);
301 while (my $result = $sth_get_cn_sort->fetchrow_hashref()) {
302     $starting_cn_sort = $result->{'cn_sort'};
303     $starting_homebranch->{code} = $result->{'homebranch'};
304     $starting_homebranch->{description} = $branches->{$result->{'homebranch'}}{branchname};
305     $starting_location->{code} = $result->{'location'};
306     $starting_location->{description} = GetAuthorisedValueDesc('','',   $result->{'location'} ,'','','LOC');
307
308 }
309
310 ## List of Previous Items
311 # order by cn_sort, which should include everything we need for ordering purposes (though not
312 # for limits, those need to be handled separately
313 my $sth_shelfbrowse_previous = $dbh->prepare("SELECT * FROM items WHERE CONCAT(cn_sort,itemnumber) <= ? AND homebranch=? AND location=? ORDER BY CONCAT(cn_sort,itemnumber) DESC LIMIT 3");
314 $sth_shelfbrowse_previous->execute($starting_cn_sort.$starting_itemnumber, $starting_homebranch->{code}, $starting_location->{code});
315 my @previous_items;
316 while (my $this_item = $sth_shelfbrowse_previous->fetchrow_hashref()) {
317     my $sth_get_biblio = $dbh->prepare("SELECT biblio.*,biblioitems.isbn AS isbn FROM biblio LEFT JOIN biblioitems ON biblio.biblionumber=biblioitems.biblionumber WHERE biblio.biblionumber=?");
318     $sth_get_biblio->execute($this_item->{biblionumber});
319     while (my $this_biblio = $sth_get_biblio->fetchrow_hashref()) {
320         $this_item->{'title'} = $this_biblio->{'title'};
321                 if ($clean2 = isbn_cleanup($this_biblio->{'isbn'})) {
322                 $this_item->{'isbn'} = $clean2;
323                 } else { 
324                         $this_item->{'isbn'} = $this_biblio->{'isbn'};
325                 }
326     }
327     unshift @previous_items, $this_item;
328 }
329 my $throwaway = pop @previous_items;
330 ## List of Next Items
331 my $sth_shelfbrowse_next = $dbh->prepare("SELECT * FROM items WHERE CONCAT(cn_sort,itemnumber) >= ? AND homebranch=? AND location=? ORDER BY CONCAT(cn_sort,itemnumber) ASC LIMIT 3");
332 $sth_shelfbrowse_next->execute($starting_cn_sort.$starting_itemnumber, $starting_homebranch->{code}, $starting_location->{code});
333 my @next_items;
334 while (my $this_item = $sth_shelfbrowse_next->fetchrow_hashref()) {
335     my $sth_get_biblio = $dbh->prepare("SELECT biblio.*,biblioitems.isbn AS isbn FROM biblio LEFT JOIN biblioitems ON biblio.biblionumber=biblioitems.biblionumber WHERE biblio.biblionumber=?");
336     $sth_get_biblio->execute($this_item->{biblionumber});
337     while (my $this_biblio = $sth_get_biblio->fetchrow_hashref()) {
338         $this_item->{'title'} = $this_biblio->{'title'};
339                 if ($clean2 = isbn_cleanup($this_biblio->{'isbn'})) {
340                 $this_item->{'isbn'} = $clean2;
341                 } else { 
342                         $this_item->{'isbn'} = $this_biblio->{'isbn'};
343                 }
344     }
345     push @next_items, $this_item;
346 }
347
348 # alas, these won't auto-vivify, see http://www.perlmonks.org/?node_id=508481
349 my $shelfbrowser_next_itemnumber = $next_items[-1]->{itemnumber} if @next_items;
350 my $shelfbrowser_next_biblionumber = $next_items[-1]->{biblionumber} if @next_items;
351
352 $template->param(
353     starting_homebranch => $starting_homebranch->{description},
354     starting_location => $starting_location->{description},
355     shelfbrowser_prev_itemnumber => $previous_items[0]->{itemnumber},
356     shelfbrowser_next_itemnumber => $shelfbrowser_next_itemnumber,
357     shelfbrowser_prev_biblionumber => $previous_items[0]->{biblionumber},
358     shelfbrowser_next_biblionumber => $shelfbrowser_next_biblionumber,
359     PREVIOUS_SHELF_BROWSE => \@previous_items,
360     NEXT_SHELF_BROWSE => \@next_items,
361 );
362 }
363
364 if (C4::Context->preference("BakerTaylorEnabled")) {
365         $template->param(
366                 BakerTaylorEnabled  => 1,
367                 BakerTaylorImageURL => &image_url(),
368                 BakerTaylorLinkURL  => &link_url(),
369                 BakerTaylorBookstoreURL => C4::Context->preference('BakerTaylorBookstoreURL'),
370         );
371         my ($bt_user, $bt_pass);
372         if ($clean and
373                 $bt_user = C4::Context->preference('BakerTaylorUsername') and
374                 $bt_pass = C4::Context->preference('BakerTaylorPassword')    )
375         {
376                 $template->param(
377                 BakerTaylorContentURL   =>
378                 sprintf("http://contentcafe2.btol.com/ContentCafeClient/ContentCafe.aspx?UserID=%s&Password=%s&ItemKey=%s&Options=Y",
379                                 $bt_user,$bt_pass,$clean)
380                 );
381         }
382 }
383
384 my $tag_quantity;
385 if (C4::Context->preference('TagsEnabled') and $tag_quantity = C4::Context->preference('TagsShowOnDetail')) {
386         $template->param(
387                 TagsEnabled => 1,
388                 TagsShowOnDetail => $tag_quantity,
389                 TagsInputOnDetail => C4::Context->preference('TagsInputOnDetail')
390         );
391         $template->param(TagLoop => get_tags({biblionumber=>$biblionumber, approved=>1,
392                                                                 'sort'=>'-weight', limit=>$tag_quantity}));
393 }
394
395 output_html_with_http_headers $query, $cookie, $template->output;