Bug 32482: (follow-up) Add markup comments
[koha.git] / catalogue / MARCdetail.pl
1 #!/usr/bin/perl
2
3 # Copyright 2000-2002 Katipo Communications
4 # Copyright 2010 BibLibre
5 #
6 # This file is part of Koha.
7 #
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
12 #
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
20
21 =head1 NAME
22
23 MARCdetail.pl : script to show a biblio in MARC format
24
25 =head1 SYNOPSIS
26
27 =cut
28
29 =head1 DESCRIPTION
30
31 This script needs a biblionumber as parameter
32
33 It shows the biblio in a (nice) MARC format depending on MARC
34 parameters tables.
35
36 The template is in <templates_dir>/catalogue/MARCdetail.tt.
37 this template must be divided into 11 "tabs".
38
39 The first 10 tabs present the biblio, the 11th one presents
40 the items attached to the biblio
41
42 =head1 FUNCTIONS
43
44 =cut
45
46 use Modern::Perl;
47 use CGI qw ( -utf8 );
48 use HTML::Entities;
49
50 use C4::Auth qw( get_template_and_user );
51 use C4::Context;
52 use C4::Output qw( output_html_with_http_headers );
53 use C4::Koha;
54 use C4::Biblio qw(
55     GetAuthorisedValueDesc
56     GetBiblioData
57     GetFrameworkCode
58     GetMarcFromKohaField
59     GetMarcStructure
60 );
61 use C4::Serials qw( CountSubscriptionFromBiblionumber GetSubscription GetSubscriptionsFromBiblionumber );
62 use C4::Search qw( z3950_search_args enabled_staff_search_views );
63
64 use Koha::Biblios;
65 use Koha::BiblioFrameworks;
66 use Koha::Patrons;
67 use Koha::DateUtils qw( output_pref );
68 use Koha::Virtualshelves;
69
70 use List::MoreUtils qw( uniq );
71
72 my $query        = CGI->new;
73 my $dbh          = C4::Context->dbh;
74 my $biblionumber = $query->param('biblionumber');
75 $biblionumber = HTML::Entities::encode($biblionumber);
76 my $frameworkcode = $query->param('frameworkcode') // GetFrameworkCode( $biblionumber );
77 my $popup        =
78   $query->param('popup')
79   ;    # if set to 1, then don't insert links, it's just to show the biblio
80 my $subscriptionid = $query->param('subscriptionid');
81
82 # open template
83 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
84     {
85         template_name   => "catalogue/MARCdetail.tt",
86         query           => $query,
87         type            => "intranet",
88         flagsrequired   => { catalogue => 1 },
89     }
90 );
91
92 my $biblio_object = Koha::Biblios->find( $biblionumber ); # FIXME Should replace $biblio
93 my $record = $biblio_object->metadata->record({ embed_items => 1 });
94
95 if ( not defined $record ) {
96     # biblionumber invalid -> report and exit
97     $template->param( unknownbiblionumber => 1,
98                 biblionumber => $biblionumber
99     );
100     output_html_with_http_headers $query, $cookie, $template->output;
101     exit;
102 }
103
104 my $tagslib = &GetMarcStructure(1,$frameworkcode);
105 my $biblio = GetBiblioData($biblionumber);
106
107 if($query->cookie("holdfor")){ 
108     my $holdfor_patron = Koha::Patrons->find( $query->cookie("holdfor") );
109     $template->param(
110         holdfor        => $query->cookie("holdfor"),
111         holdfor_patron => $holdfor_patron,
112     );
113 }
114
115 if( $query->cookie("searchToOrder") ){
116     my ( $basketno, $vendorid ) = split( /\//, $query->cookie("searchToOrder") );
117     $template->param(
118         searchtoorder_basketno => $basketno,
119         searchtoorder_vendorid => $vendorid
120     );
121 }
122
123 $template->param( ocoins => $biblio_object->get_coins );
124
125 #count of item linked
126 my $itemcount = $biblio_object->items->count;
127 $template->param( count => $itemcount,
128                                         bibliotitle => $biblio->{title}, );
129
130 my $frameworks = Koha::BiblioFrameworks->search( {}, { order_by => ['frameworktext'] } );
131 $template->param(
132     frameworks    => $frameworks,
133     frameworkcode => $frameworkcode,
134 );
135 # fill arrays
136 my @loop_data = ();
137
138 # loop through each tab 0 through 9
139 for ( my $tabloop = 0 ; $tabloop <= 10 ; $tabloop++ ) {
140
141     # loop through each tag
142     my @fields    = $record->fields();
143     my @loop_data = ();
144     my @subfields_data;
145
146     # deal with leader
147     unless ( $tagslib->{'000'}->{'@'}->{tab} ne $tabloop )
148     {    #  or ($tagslib->{'000'}->{'@'}->{hidden} =~ /-7|-4|-3|-2|2|3|5|8/ )) {
149         my %subfield_data;
150         $subfield_data{marc_lib}      = $tagslib->{'000'}->{'@'}->{lib};
151         $subfield_data{marc_value}    = $record->leader();
152         $subfield_data{marc_subfield} = '@';
153         $subfield_data{marc_tag}      = '000';
154         push( @subfields_data, \%subfield_data );
155         my %tag_data;
156         $tag_data{tag} = '000';
157         $tag_data{tag_desc} = $tagslib->{'000'}->{lib};
158         my @tmp = @subfields_data;
159         $tag_data{subfield} = \@tmp;
160         push( @loop_data, \%tag_data );
161         undef @subfields_data;
162     }
163     @fields = $record->fields();
164     for ( my $x_i = 0 ; $x_i <= $#fields ; $x_i++ ) {
165
166         # if tag <10, there's no subfield, use the "@" trick
167         if ( $fields[$x_i]->tag() < 10 ) {
168             next
169               if (
170                 $tagslib->{ $fields[$x_i]->tag() }->{'@'}->{tab} ne $tabloop );
171             next if ( $tagslib->{ $fields[$x_i]->tag() }->{'@'}->{hidden} =~ /-7|-4|-3|-2|2|3|5|8/);
172             my %subfield_data;
173             $subfield_data{marc_lib} =
174               $tagslib->{ $fields[$x_i]->tag() }->{'@'}->{lib};
175             $subfield_data{marc_value}    = $fields[$x_i]->data();
176             $subfield_data{marc_subfield} = '@';
177             $subfield_data{marc_tag}      = $fields[$x_i]->tag();
178             push( @subfields_data, \%subfield_data );
179         }
180         else {
181             my @subf = $fields[$x_i]->subfields;
182
183             # loop through each subfield
184             for my $i ( 0 .. $#subf ) {
185                 $subf[$i][0] = "@" unless defined $subf[$i][0];
186                 next if ( $tagslib->{ $fields[$x_i]->tag() }->{ $subf[$i][0] }->{tab} // q{} ) ne $tabloop; # Note: defaulting to '0' changes behavior!
187                 next
188                   if ( $tagslib->{ $fields[$x_i]->tag() }->{ $subf[$i][0] }
189                     ->{hidden} =~ /-7|-4|-3|-2|2|3|5|8/);
190                 my %subfield_data;
191                 $subfield_data{short_desc} = $tagslib->{ $fields[$x_i]->tag() }->{ $subf[$i][0] }->{lib};
192                 $subfield_data{long_desc} =
193                   $tagslib->{ $fields[$x_i]->tag() }->{ $subf[$i][0] }->{lib};
194                 $subfield_data{link} =
195                   $tagslib->{ $fields[$x_i]->tag() }->{ $subf[$i][0] }->{link};
196
197 #                 warn "tag : ".$tagslib->{$fields[$x_i]->tag()}." subfield :".$tagslib->{$fields[$x_i]->tag()}->{$subf[$i][0]}."lien koha? : "$subfield_data{link};
198                 if ( $tagslib->{ $fields[$x_i]->tag() }->{ $subf[$i][0] }
199                     ->{isurl} )
200                 {
201                     $subfield_data{marc_value} = $subf[$i][1];
202                                         $subfield_data{is_url} = 1;
203                 }
204                 elsif ( $tagslib->{ $fields[$x_i]->tag() }->{ $subf[$i][0] }
205                     ->{kohafield} eq "biblioitems.isbn" )
206                 {
207
208 #                    warn " tag : ".$tagslib->{$fields[$x_i]->tag()}." subfield :".$tagslib->{$fields[$x_i]->tag()}->{$subf[$i][0]}. "ISBN : ".$subf[$i][1]."PosttraitementISBN :".DisplayISBN($subf[$i][1]);
209                     $subfield_data{marc_value} = $subf[$i][1];
210                 }
211                 else {
212                     if ( $tagslib->{ $fields[$x_i]->tag() }->{ $subf[$i][0] }
213                         ->{authtypecode} )
214                     {
215                         $subfield_data{authority} = $fields[$x_i]->subfield(9);
216                     }
217                     $subfield_data{marc_value} =
218                       GetAuthorisedValueDesc( $fields[$x_i]->tag(),
219                         $subf[$i][0], $subf[$i][1], '', $tagslib) || $subf[$i][1];
220
221                 }
222                 $subfield_data{marc_subfield} = $subf[$i][0];
223                 $subfield_data{marc_tag}      = $fields[$x_i]->tag();
224                 push( @subfields_data, \%subfield_data );
225             }
226         }
227         if ( $#subfields_data == 0 ) {
228             $subfields_data[0]->{marc_lib}      = '';
229 #            $subfields_data[0]->{marc_subfield} = '';
230         }
231         if ( $#subfields_data >= 0) {
232             my %tag_data;
233             if ( $fields[$x_i]->tag() eq $fields[ $x_i - 1 ]->tag() && (C4::Context->preference('LabelMARCView') eq 'economical')) {
234                 $tag_data{tag} = "";
235             }
236             else {
237                 if ( C4::Context->preference('hide_marc') ) {
238                     $tag_data{tag} = $tagslib->{ $fields[$x_i]->tag() }->{lib};
239                 }
240                 else {
241                     $tag_data{tag} = $fields[$x_i]->tag();
242             $tag_data{tag_ind} = C4::Koha::display_marc_indicators($fields[$x_i]);
243             $tag_data{tag_desc} = $tagslib->{ $fields[$x_i]->tag() }->{lib};
244                 }
245             }
246             my @tmp = @subfields_data;
247             $tag_data{subfield} = \@tmp;
248             push( @loop_data, \%tag_data );
249             undef @subfields_data;
250         }
251     }
252     $template->param( "tab" . $tabloop . "XX" => \@loop_data );
253 }
254
255 # now, build item tab !
256 # the main difference is that datas are in lines and not in columns : thus, we build the <th> first, then the values...
257 # loop through each tag
258 # warning : we may have differents number of columns in each row. Thus, we first build a hash, complete it if necessary
259 # then construct template.
260 my @fields = $record->fields();
261 my %witness
262   ; #---- stores the list of subfields used at least once, with the "meaning" of the code
263 my @item_subfield_codes;
264 my @item_loop;
265
266 foreach my $field (@fields) {
267     next if ( $field->tag() < 10 );
268     my @subf = $field->subfields;
269     my $item;
270
271     # loop through each subfield
272     for my $i ( 0 .. $#subf ) {
273         next if ( $tagslib->{ $field->tag() }->{ $subf[$i][0] }->{tab} ne 10 );
274         next if ( $tagslib->{ $field->tag() }->{ $subf[$i][0] }->{hidden} =~ /-7|-4|-3|-2|2|3|5|8/);
275
276         push @item_subfield_codes, $subf[$i][0];
277         $witness{ $subf[$i][0] } =
278         $tagslib->{ $field->tag() }->{ $subf[$i][0] }->{lib};
279
280         # Allow repeatables (BZ 13574)
281         if( $item->{$subf[$i][0]}) {
282             $item->{$subf[$i][0]} .= ' | ';
283         } else {
284             $item->{$subf[$i][0]} = q{};
285         }
286         if( $tagslib->{$field->tag()}->{$subf[$i][0]}->{isurl} ) {
287             $item->{$subf[$i][0]} .= "<a href=\"$subf[$i][1]\">$subf[$i][1]</a>";
288         } else {
289             $item->{ $subf[$i][0] } .= GetAuthorisedValueDesc( $field->tag(), $subf[$i][0], $subf[$i][1], '', $tagslib) || $subf[$i][1];
290         }
291
292         my $kohafield = $tagslib->{ $field->tag() }->{ $subf[$i][0] }->{kohafield};
293         $item->{ $subf[$i][0] } = output_pref( { str => $item->{ $subf[$i][0] }, dateonly => 1 } )
294           if grep { $kohafield eq $_ }
295               qw( items.dateaccessioned items.onloan items.datelastseen items.datelastborrowed items.replacementpricedate );
296     }
297     push @item_loop, $item if $item;
298 }
299
300 my ($holdingbrtagf,$holdingbrtagsubf) = &GetMarcFromKohaField( "items.holdingbranch" );
301 @item_loop = sort {$a->{$holdingbrtagsubf} cmp $b->{$holdingbrtagsubf}} @item_loop;
302
303 @item_subfield_codes = uniq @item_subfield_codes;
304 # fill item info
305 my @item_header_loop;
306 for my $subfield_code ( @item_subfield_codes ) {
307     push @item_header_loop, $witness{$subfield_code};
308     for my $item_data ( @item_loop ) {
309         $item_data->{$subfield_code} ||= "&nbsp;"
310     }
311 }
312
313 my $subscriptionscount = CountSubscriptionFromBiblionumber($biblionumber);
314
315 if ($subscriptionscount) {
316     my $subscriptions = GetSubscriptionsFromBiblionumber($biblionumber);
317     my $subscriptiontitle = $subscriptions->[0]{'bibliotitle'};
318     $template->param(
319         subscriptiontitle   => $subscriptiontitle,
320         subscriptionsnumber => $subscriptionscount,
321     );
322 }
323
324 # get biblionumbers stored in the cart
325 my @cart_list;
326
327 if($query->cookie("intranet_bib_list")){
328     my $cart_list = $query->cookie("intranet_bib_list");
329     @cart_list = split(/\//, $cart_list);
330     if ( grep {$_ eq $biblionumber} @cart_list) {
331         $template->param( incart => 1 );
332     }
333 }
334
335 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
336     {
337         borrowernumber => $loggedinuser,
338         add_allowed    => 1,
339         public         => 0,
340     }
341 );
342 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
343     {
344         borrowernumber => $loggedinuser,
345         add_allowed    => 1,
346         public         => 1,
347     }
348 );
349
350
351 $template->param(
352     add_to_some_private_shelves => $some_private_shelves,
353     add_to_some_public_shelves  => $some_public_shelves,
354 );
355
356 $template->param (
357     item_loop               => \@item_loop,
358     item_header_loop        => \@item_header_loop,
359     item_subfield_codes     => \@item_subfield_codes,
360     biblionumber            => $biblionumber,
361     popup                   => $popup,
362     hide_marc               => C4::Context->preference('hide_marc'),
363         marcview => 1,
364         z3950_search_params             => C4::Search::z3950_search_args($biblio),
365         C4::Search::enabled_staff_search_views,
366     searchid                => scalar $query->param('searchid'),
367     biblio                  => $biblio_object,
368     loggedinuser => $loggedinuser,
369 );
370
371 $template->param( holdcount => $biblio_object->holds->count );
372
373 output_html_with_http_headers $query, $cookie, $template->output;