Bug 11175: (QA follow-up) Move get_component_part_query
[koha-ffzg.git] / catalogue / detail.pl
1 #!/usr/bin/perl
2
3 # This file is part of Koha.
4 #
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
9 #
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
17
18
19 use Modern::Perl;
20
21 use CGI qw ( -utf8 );
22 use HTML::Entities;
23 use C4::Auth qw( get_template_and_user );
24 use C4::Context;
25 use C4::Koha qw(
26     GetAuthorisedValues
27     getitemtypeimagelocation
28     GetNormalizedEAN
29     GetNormalizedISBN
30     GetNormalizedOCLCNumber
31     GetNormalizedUPC
32 );
33 use C4::Serials qw( CountSubscriptionFromBiblionumber SearchSubscriptions GetLatestSerials );
34 use C4::Output qw( output_html_with_http_headers );
35 use C4::Biblio qw( GetBiblioData GetFrameworkCode GetMarcBiblio );
36 use C4::Items qw( GetAnalyticsCount GetHostItemsInfo GetItemsInfo );
37 use C4::Circulation qw( GetTransfers );
38 use C4::Reserves;
39 use C4::Serials qw( CountSubscriptionFromBiblionumber SearchSubscriptions GetLatestSerials );
40 use C4::XISBN qw( get_xisbns );
41 use C4::External::Amazon qw( get_amazon_tld );
42 use C4::Search qw( z3950_search_args enabled_staff_search_views );
43 use C4::Tags qw( get_tags );
44 use C4::XSLT qw( XSLTParse4Display );
45 use Koha::DateUtils qw( format_sqldatetime );
46 use C4::HTML5Media;
47 use C4::CourseReserves qw( GetItemCourseReservesInfo );
48 use Koha::AuthorisedValues;
49 use Koha::Biblios;
50 use Koha::CoverImages;
51 use Koha::Illrequests;
52 use Koha::Items;
53 use Koha::ItemTypes;
54 use Koha::Patrons;
55 use Koha::Virtualshelves;
56 use Koha::Plugins;
57 use Koha::SearchEngine::Search;
58 use Koha::SearchEngine::QueryBuilder;
59
60 my $query = CGI->new();
61
62 my $analyze = $query->param('analyze');
63
64 my ( $template, $borrowernumber, $cookie, $flags ) = get_template_and_user(
65     {
66     template_name   =>  'catalogue/detail.tt',
67         query           => $query,
68         type            => "intranet",
69         flagsrequired   => { catalogue => 1 },
70     }
71 );
72
73 # Determine if we should be offering any enhancement plugin buttons
74 if ( C4::Context->config('enable_plugins') ) {
75     # Only pass plugins that can offer a toolbar button
76     my @plugins = Koha::Plugins->new()->GetPlugins({
77         method => 'intranet_catalog_biblio_enhancements_toolbar_button'
78     });
79     $template->param(
80         plugins => \@plugins,
81     );
82 }
83
84 my $biblionumber = $query->param('biblionumber');
85 $biblionumber = HTML::Entities::encode($biblionumber);
86 my $record       = GetMarcBiblio({ biblionumber => $biblionumber });
87 my $biblio = Koha::Biblios->find( $biblionumber );
88 $template->param( 'biblio', $biblio );
89
90 if ( not defined $record ) {
91     # biblionumber invalid -> report and exit
92     $template->param( unknownbiblionumber => 1,
93                       biblionumber => $biblionumber );
94     output_html_with_http_headers $query, $cookie, $template->output;
95     exit;
96 }
97
98 eval { $biblio->metadata->record };
99 $template->param( decoding_error => $@ );
100
101 if($query->cookie("holdfor")){
102     my $holdfor_patron = Koha::Patrons->find( $query->cookie("holdfor") );
103     if ( $holdfor_patron ) {
104         $template->param(
105             # FIXME Should pass the patron object
106             holdfor => $query->cookie("holdfor"),
107             holdfor_surname => $holdfor_patron->surname,
108             holdfor_firstname => $holdfor_patron->firstname,
109             holdfor_cardnumber => $holdfor_patron->cardnumber,
110         );
111     }
112 }
113
114 if($query->cookie("searchToOrder")){
115     my ( $basketno, $vendorid ) = split( /\//, $query->cookie("searchToOrder") );
116     $template->param(
117         searchtoorder_basketno => $basketno,
118         searchtoorder_vendorid => $vendorid
119     );
120 }
121
122 my $fw           = GetFrameworkCode($biblionumber);
123 my $showallitems = $query->param('showallitems');
124 my $marcflavour  = C4::Context->preference("marcflavour");
125
126 {
127     # XSLT processing of some stuff
128
129     $template->param(
130         XSLTDetailsDisplay => '1',
131         XSLTBloc => XSLTParse4Display(
132             {
133                 biblionumber   => $biblionumber,
134                 record         => $record,
135                 xsl_syspref    => "XSLTDetailsDisplay",
136                 fix_amps       => 1,
137             }
138         ),
139     );
140 }
141
142 $template->param( 'SpineLabelShowPrintOnBibDetails' => C4::Context->preference("SpineLabelShowPrintOnBibDetails") );
143
144 # Catch the exception as Koha::Biblio::Metadata->record can explode if the MARCXML is invalid
145 # Do not propagate it as we already deal with it previously in this script
146 my $coins = eval { $biblio->get_coins };
147 $template->param( ocoins => $coins );
148
149 # some useful variables for enhanced content;
150 # in each case, we're grabbing the first value we find in
151 # the record and normalizing it
152 my $upc = GetNormalizedUPC($record,$marcflavour);
153 my $ean = GetNormalizedEAN($record,$marcflavour);
154 my $oclc = GetNormalizedOCLCNumber($record,$marcflavour);
155 my $isbn = GetNormalizedISBN(undef,$record,$marcflavour);
156
157 $template->param(
158     normalized_upc => $upc,
159     normalized_ean => $ean,
160     normalized_oclc => $oclc,
161     normalized_isbn => $isbn,
162 );
163
164 my $marcnotesarray   = $biblio->get_marc_notes({ marcflavour => $marcflavour });
165
166 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search->unblessed } };
167
168 my $dbh = C4::Context->dbh;
169
170 my @all_items = GetItemsInfo( $biblionumber );
171 my @items;
172 my $patron = Koha::Patrons->find( $borrowernumber );
173 for my $itm (@all_items) {
174     push @items, $itm unless ( $itm->{itemlost} && $patron->category->hidelostitems && !$showallitems);
175 }
176
177 # flag indicating existence of at least one item linked via a host record
178 my $hostrecords;
179 # adding items linked via host biblios
180 my @hostitems = GetHostItemsInfo($record);
181 if (@hostitems){
182     $hostrecords =1;
183     push (@items,@hostitems);
184 }
185
186 my $dat = &GetBiblioData($biblionumber);
187
188 #coping with subscriptions
189 my $subscriptionsnumber = CountSubscriptionFromBiblionumber($biblionumber);
190 my @subscriptions       = SearchSubscriptions({ biblionumber => $biblionumber, orderby => 'title' });
191 my @subs;
192
193 foreach my $subscription (@subscriptions) {
194     my %cell;
195     my $serials_to_display;
196     $cell{subscriptionid}    = $subscription->{subscriptionid};
197     $cell{subscriptionnotes} = $subscription->{internalnotes};
198     $cell{missinglist}       = $subscription->{missinglist};
199     $cell{librariannote}     = $subscription->{librariannote};
200     $cell{branchcode}        = $subscription->{branchcode};
201     $cell{hasalert}          = $subscription->{hasalert};
202     $cell{callnumber}        = $subscription->{callnumber};
203     $cell{location}          = $subscription->{location};
204     $cell{closed}            = $subscription->{closed};
205     #get the three latest serials.
206     $serials_to_display = $subscription->{staffdisplaycount};
207     $serials_to_display = C4::Context->preference('StaffSerialIssueDisplayCount') unless $serials_to_display;
208     $cell{staffdisplaycount} = $serials_to_display;
209     $cell{latestserials} =
210       GetLatestSerials( $subscription->{subscriptionid}, $serials_to_display );
211     push @subs, \%cell;
212 }
213
214 # Get acquisition details
215 if ( C4::Context->preference('AcquisitionDetails') ) {
216     my $orders = Koha::Acquisition::Orders->search(
217         { biblionumber => $biblionumber },
218         {
219             join => 'basketno',
220             order_by => 'basketno.booksellerid'
221         }
222     );    # GetHistory sorted by aqbooksellerid, but does it make sense?
223
224     $template->param(
225         orders => $orders,
226     );
227 }
228
229 if ( C4::Context->preference('suggestion') ) {
230     my $suggestions = Koha::Suggestions->search(
231         {
232             biblionumber => $biblionumber,
233             archived     => 0,
234         },
235         {
236             order_by => { -desc => 'suggesteddate' }
237         }
238     );
239     my $nb_archived_suggestions = Koha::Suggestions->search({ biblionumber => $biblionumber, archived => 1 })->count;
240     $template->param( suggestions => $suggestions, nb_archived_suggestions => $nb_archived_suggestions );
241 }
242
243 if ( defined $dat->{'itemtype'} ) {
244     $dat->{imageurl} = getitemtypeimagelocation( 'intranet', $itemtypes->{ $dat->{itemtype} }{imageurl} );
245 }
246
247 $dat->{'count'} = scalar @all_items + @hostitems;
248 $dat->{'showncount'} = scalar @items + @hostitems;
249 $dat->{'hiddencount'} = scalar @all_items + @hostitems - scalar @items;
250
251 my $shelflocations =
252   { map { $_->{authorised_value} => $_->{lib} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => $fw, kohafield => 'items.location' } ) };
253 my $collections =
254   { map { $_->{authorised_value} => $_->{lib} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => $fw, kohafield => 'items.ccode' } ) };
255 my $copynumbers =
256   { map { $_->{authorised_value} => $_->{lib} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => $fw, kohafield => 'items.copynumber' } ) };
257 my (@itemloop, @otheritemloop, %itemfields);
258
259 my $mss = Koha::MarcSubfieldStructures->search({ frameworkcode => $fw, kohafield => 'items.itemlost', authorised_value => [ -and => {'!=' => undef }, {'!=' => ''}] });
260 if ( $mss->count ) {
261     $template->param( itemlostloop => GetAuthorisedValues( $mss->next->authorised_value ) );
262 }
263 $mss = Koha::MarcSubfieldStructures->search({ frameworkcode => $fw, kohafield => 'items.damaged', authorised_value => [ -and => {'!=' => undef }, {'!=' => ''}] });
264 if ( $mss->count ) {
265     $template->param( itemdamagedloop => GetAuthorisedValues( $mss->next->authorised_value ) );
266 }
267 $mss = Koha::MarcSubfieldStructures->search({ frameworkcode => $fw, kohafield => 'items.withdrawn', authorised_value => { not => undef } });
268 if ( $mss->count ) {
269     $template->param( itemwithdrawnloop => GetAuthorisedValues( $mss->next->authorised_value) );
270 }
271
272 $mss = Koha::MarcSubfieldStructures->search({ frameworkcode => $fw, kohafield => 'items.materials', authorised_value => [ -and => {'!=' => undef }, {'!=' => ''}] });
273 my %materials_map;
274 if ($mss->count) {
275     my $materials_authvals = GetAuthorisedValues($mss->next->authorised_value);
276     if ($materials_authvals) {
277         foreach my $value (@$materials_authvals) {
278             $materials_map{$value->{authorised_value}} = $value->{lib};
279         }
280     }
281 }
282
283 my $analytics_flag;
284 my $materials_flag; # set this if the items have anything in the materials field
285 my $currentbranch = C4::Context->userenv ? C4::Context->userenv->{branch} : undef;
286 if ($currentbranch and C4::Context->preference('SeparateHoldings')) {
287     $template->param(SeparateHoldings => 1);
288 }
289 my $separatebranch = C4::Context->preference('SeparateHoldingsBranch') || 'homebranch';
290 my ( $itemloop_has_images, $otheritemloop_has_images );
291 foreach my $item (@items) {
292     my $itembranchcode = $item->{$separatebranch};
293
294     $item->{imageurl} = defined $item->{itype} ? getitemtypeimagelocation('intranet', $itemtypes->{ $item->{itype} }{imageurl})
295                                                : '';
296
297     $item->{datedue} = format_sqldatetime($item->{datedue});
298
299     #get shelf location and collection code description if they are authorised value.
300     # same thing for copy number
301     my $shelfcode = $item->{'location'};
302     $item->{'location'} = $shelflocations->{$shelfcode} if ( defined( $shelfcode ) && defined($shelflocations) && exists( $shelflocations->{$shelfcode} ) );
303     my $ccode = $item->{'ccode'};
304     $item->{'ccode'} = $collections->{$ccode} if ( defined( $ccode ) && defined($collections) && exists( $collections->{$ccode} ) );
305     my $copynumber = $item->{'copynumber'};
306     $item->{'copynumber'} = $copynumbers->{$copynumber} if ( defined($copynumber) && defined($copynumbers) && exists( $copynumbers->{$copynumber} ) );
307     foreach (qw(ccode enumchron copynumber stocknumber itemnotes itemnotes_nonpublic uri publisheddate)) { # Warning when removing GetItemsInfo - publisheddate (at least) is not part of the items table
308         $itemfields{$_} = 1 if ( $item->{$_} );
309     }
310
311     # checking for holds
312     my $item_object = Koha::Items->find( $item->{itemnumber} );
313     my $holds = $item_object->current_holds;
314     if ( my $first_hold = $holds->next ) {
315         $item->{first_hold} = $first_hold;
316     }
317
318     if ( my $checkout = $item_object->checkout ) {
319         $item->{CheckedOutFor} = $checkout->patron;
320     }
321
322     # Check the transit status
323     my ( $transfertwhen, $transfertfrom, $transfertto ) = GetTransfers($item->{itemnumber});
324     if ( defined( $transfertwhen ) && ( $transfertwhen ne '' ) ) {
325         $item->{transfertwhen} = $transfertwhen;
326         $item->{transfertfrom} = $transfertfrom;
327         $item->{transfertto}   = $transfertto;
328         $item->{nocancel} = 1;
329     }
330
331     foreach my $f (qw( itemnotes )) {
332         if ($item->{$f}) {
333             $item->{$f} =~ s|\n|<br />|g;
334             $itemfields{$f} = 1;
335         }
336     }
337
338     #item has a host number if its biblio number does not match the current bib
339
340     if ($item->{biblionumber} ne $biblionumber){
341         $item->{hostbiblionumber} = $item->{biblionumber};
342         $item->{hosttitle} = GetBiblioData($item->{biblionumber})->{title};
343     }
344         
345
346     if ( $analyze ) {
347         # count if item is used in analytical bibliorecords
348         # The 'countanalytics' flag is only used in the templates if analyze is set
349         my $countanalytics = C4::Context->preference('EasyAnalyticalRecords') ? GetAnalyticsCount($item->{itemnumber}) : 0;
350         if ($countanalytics > 0){
351             $analytics_flag=1;
352             $item->{countanalytics} = $countanalytics;
353         }
354     }
355
356     if (defined($item->{'materials'}) && $item->{'materials'} =~ /\S/){
357         $materials_flag = 1;
358         if (defined $materials_map{ $item->{materials} }) {
359             $item->{materials} = $materials_map{ $item->{materials} };
360         }
361     }
362
363     if ( C4::Context->preference('UseCourseReserves') ) {
364         $item->{'course_reserves'} = GetItemCourseReservesInfo( itemnumber => $item->{'itemnumber'} );
365     }
366
367     if ( C4::Context->preference('IndependentBranches') ) {
368         my $userenv = C4::Context->userenv();
369         if ( not C4::Context->IsSuperLibrarian()
370             and $userenv->{branch} ne $item->{homebranch} ) {
371             $item->{cannot_be_edited} = 1;
372         }
373     }
374
375     if ( C4::Context->preference("LocalCoverImages") == 1 ) {
376         $item->{cover_images} = $item_object->cover_images;
377     }
378
379     if ($currentbranch and C4::Context->preference('SeparateHoldings')) {
380         if ($itembranchcode and $itembranchcode eq $currentbranch) {
381             push @itemloop, $item;
382             $itemloop_has_images++ if $item_object->cover_images->count;
383         } else {
384             push @otheritemloop, $item;
385             $otheritemloop_has_images++ if $item_object->cover_images->count;
386         }
387     } else {
388         push @itemloop, $item;
389         $itemloop_has_images++ if $item_object->cover_images->count;
390     }
391 }
392
393 $template->param(
394     itemloop_has_images      => $itemloop_has_images,
395     otheritemloop_has_images => $otheritemloop_has_images,
396 );
397
398 # Display only one tab if one items list is empty
399 if (scalar(@itemloop) == 0 || scalar(@otheritemloop) == 0) {
400     $template->param(SeparateHoldings => 0);
401     if (scalar(@itemloop) == 0) {
402         @itemloop = @otheritemloop;
403     }
404 }
405
406 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
407     {
408         borrowernumber => $borrowernumber,
409         add_allowed    => 1,
410         category       => 1,
411     }
412 );
413 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
414     {
415         borrowernumber => $borrowernumber,
416         add_allowed    => 1,
417         category       => 2,
418     }
419 );
420
421
422 $template->param(
423     add_to_some_private_shelves => $some_private_shelves,
424     add_to_some_public_shelves  => $some_public_shelves,
425 );
426
427 $template->param(
428     MARCNOTES   => $marcnotesarray,
429     itemdata_ccode      => $itemfields{ccode},
430     itemdata_enumchron  => $itemfields{enumchron},
431     itemdata_uri        => $itemfields{uri},
432     itemdata_copynumber => $itemfields{copynumber},
433     itemdata_stocknumber => $itemfields{stocknumber},
434     itemdata_publisheddate => $itemfields{publisheddate},
435     volinfo                => $itemfields{enumchron},
436         itemdata_itemnotes  => $itemfields{itemnotes},
437         itemdata_nonpublicnotes => $itemfields{itemnotes_nonpublic},
438     z3950_search_params    => C4::Search::z3950_search_args($dat),
439         hostrecords         => $hostrecords,
440     analytics_flag    => $analytics_flag,
441     C4::Search::enabled_staff_search_views,
442         materials       => $materials_flag,
443 );
444
445 if (C4::Context->preference("AlternateHoldingsField") && scalar @items == 0) {
446     my $fieldspec = C4::Context->preference("AlternateHoldingsField");
447     my $subfields = substr $fieldspec, 3;
448     my $holdingsep = C4::Context->preference("AlternateHoldingsSeparator") || ' ';
449     my @alternateholdingsinfo = ();
450     my @holdingsfields = $record->field(substr $fieldspec, 0, 3);
451
452     for my $field (@holdingsfields) {
453         my %holding = ( holding => '' );
454         my $havesubfield = 0;
455         for my $subfield ($field->subfields()) {
456             if ((index $subfields, $$subfield[0]) >= 0) {
457                 $holding{'holding'} .= $holdingsep if (length $holding{'holding'} > 0);
458                 $holding{'holding'} .= $$subfield[1];
459                 $havesubfield++;
460             }
461         }
462         if ($havesubfield) {
463             push(@alternateholdingsinfo, \%holding);
464         }
465     }
466
467     $template->param(
468         ALTERNATEHOLDINGS   => \@alternateholdingsinfo,
469         );
470 }
471
472 my @results = ( $dat, );
473 foreach ( keys %{$dat} ) {
474     $template->param( "$_" => defined $dat->{$_} ? $dat->{$_} : '' );
475 }
476
477 # does not work: my %views_enabled = map { $_ => 1 } $template->query(loop => 'EnableViews');
478 # method query not found?!?!
479 $template->param( AmazonTld => get_amazon_tld() ) if ( C4::Context->preference("AmazonCoverImages"));
480 $template->param(
481     itemloop        => \@itemloop,
482     otheritemloop   => \@otheritemloop,
483     biblionumber        => $biblionumber,
484     ($analyze? 'analyze':'detailview') =>1,
485     subscriptions       => \@subs,
486     subscriptionsnumber => $subscriptionsnumber,
487     subscriptiontitle   => $dat->{title},
488     searchid            => scalar $query->param('searchid'),
489 );
490
491 # Lists
492
493 if (C4::Context->preference("virtualshelves") ) {
494     my $shelves = Koha::Virtualshelves->search(
495         {
496             biblionumber => $biblionumber,
497             category => 2,
498         },
499         {
500             join => 'virtualshelfcontents',
501         }
502     );
503     $template->param( 'shelves' => $shelves );
504 }
505
506 # XISBN Stuff
507 if (C4::Context->preference("FRBRizeEditions")==1) {
508     eval {
509         $template->param(
510             XISBNS => scalar get_xisbns($isbn, $biblionumber)
511         );
512     };
513     if ($@) { warn "XISBN Failed $@"; }
514 }
515
516 if ( C4::Context->preference("LocalCoverImages") == 1 ) {
517     my $images = $biblio->cover_images;
518     $template->param( localimages => $biblio->cover_images );
519 }
520
521 # HTML5 Media
522 if ( (C4::Context->preference("HTML5MediaEnabled") eq 'both') or (C4::Context->preference("HTML5MediaEnabled") eq 'staff') ) {
523     $template->param( C4::HTML5Media->gethtml5media($record));
524 }
525
526 # Displaying tags
527 my $tag_quantity;
528 if (C4::Context->preference('TagsEnabled') and $tag_quantity = C4::Context->preference('TagsShowOnDetail')) {
529     $template->param(
530         TagsEnabled => 1,
531         TagsShowOnDetail => $tag_quantity
532     );
533     $template->param(TagLoop => get_tags({biblionumber=>$biblionumber, approved=>1,
534                                 'sort'=>'-weight', limit=>$tag_quantity}));
535 }
536
537 #we only need to pass the number of holds to the template
538 my $holds = $biblio->holds;
539 $template->param( holdcount => $holds->count );
540
541 # Check if there are any ILL requests connected to the biblio
542 my $illrequests =
543     C4::Context->preference('ILLModule')
544   ? Koha::Illrequests->search( { biblio_id => $biblionumber } )
545   : [];
546 $template->param( illrequests => $illrequests );
547
548 my $StaffDetailItemSelection = C4::Context->preference('StaffDetailItemSelection');
549 if ($StaffDetailItemSelection) {
550     # Only enable item selection if user can execute at least one action
551     if (
552         $flags->{superlibrarian}
553         || (
554             ref $flags->{tools} eq 'HASH' && (
555                 $flags->{tools}->{items_batchmod}       # Modify selected items
556                 || $flags->{tools}->{items_batchdel}    # Delete selected items
557             )
558         )
559         || ( ref $flags->{tools} eq '' && $flags->{tools} )
560       )
561     {
562         $template->param(
563             StaffDetailItemSelection => $StaffDetailItemSelection );
564     }
565 }
566
567 # get biblionumbers stored in the cart
568 my @cart_list;
569
570 if($query->cookie("intranet_bib_list")){
571     my $cart_list = $query->cookie("intranet_bib_list");
572     @cart_list = split(/\//, $cart_list);
573     if ( grep {$_ eq $biblionumber} @cart_list) {
574         $template->param( incart => 1 );
575     }
576 }
577
578 if ( C4::Context->preference('UseCourseReserves') ) {
579     my $course_reserves = GetItemCourseReservesInfo( biblionumber => $biblionumber );
580     $template->param( course_reserves => $course_reserves );
581 }
582
583 $template->param(biblio => $biblio);
584
585 output_html_with_http_headers $query, $cookie, $template->output;