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