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