3 # Copyright (C) 2006 LibLime
4 # <jmf at liblime dot com>
5 # Parts Copyright Katrin Fischer 2011
6 # Parts Copyright ByWater Solutions 2011
7 # Parts Copyright Biblibre 2012
9 # This file is part of Koha.
11 # Koha is free software; you can redistribute it and/or modify it
12 # under the terms of the GNU General Public License as published by
13 # the Free Software Foundation; either version 3 of the License, or
14 # (at your option) any later version.
16 # Koha is distributed in the hope that it will be useful, but
17 # WITHOUT ANY WARRANTY; without even the implied warranty of
18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 # GNU General Public License for more details.
21 # You should have received a copy of the GNU General Public License
22 # along with Koha; if not, see <http://www.gnu.org/licenses>.
27 use C4::Koha qw( xml_escape );
28 use C4::Biblio qw( GetAuthorisedValueDesc GetFrameworkCode GetMarcStructure );
29 use Koha::AuthorisedValues;
34 my $engine; #XSLT Handler object
35 my %authval_per_framework;
36 # Cache for tagfield-tagsubfield to decode per framework.
37 # Should be preferably be placed in Koha-core...
39 our (@ISA, @EXPORT_OK);
45 getAuthorisedValues4MARCSubfields
46 buildKohaItemsNamespace
49 $engine=Koha::XSLT::Base->new( { do_not_return_source => 1 } );
54 C4::XSLT - Functions for displaying XSLT-generated content
58 =head2 transformMARCXML4XSLT
60 Replaces codes with authorized values in a MARC::Record object
64 sub transformMARCXML4XSLT {
65 my ($biblionumber, $record, $opac) = @_;
66 my $frameworkcode = GetFrameworkCode($biblionumber) || '';
67 my $tagslib = &GetMarcStructure(1, $frameworkcode, { unsafe => 1 });
69 # FIXME: wish there was a better way to handle exceptions
71 @fields = $record->fields();
73 if ($@) { warn "PROBLEM WITH RECORD"; next; }
74 my $marcflavour = C4::Context->preference('marcflavour');
75 my $av = getAuthorisedValues4MARCSubfields($frameworkcode);
76 foreach my $tag ( keys %$av ) {
77 foreach my $field ( $record->field( $tag ) ) {
78 if ( $av->{ $tag } ) {
79 my @new_subfields = ();
80 for my $subfield ( $field->subfields() ) {
81 my ( $letter, $value ) = @$subfield;
82 # Replace the field value with the authorised value *except* for MARC21 field 942$n (suppression in opac)
83 if ( !( $tag eq '942' && $subfield->[0] eq 'n' ) || $marcflavour eq 'UNIMARC' ) {
84 $value = GetAuthorisedValueDesc( $tag, $letter, $value, '', $tagslib, undef, $opac )
85 if $av->{ $tag }->{ $letter };
87 push( @new_subfields, $letter, $value );
89 $field ->replace_with( MARC::Field->new(
101 =head2 getAuthorisedValues4MARCSubfields
103 Returns a ref of hash of ref of hash for tag -> letter controlled by authorised values
104 Is only used in this module currently.
108 sub getAuthorisedValues4MARCSubfields {
109 my ($frameworkcode) = @_;
110 unless ( $authval_per_framework{ $frameworkcode } ) {
111 my $dbh = C4::Context->dbh;
112 my $sth = $dbh->prepare("SELECT DISTINCT tagfield, tagsubfield
113 FROM marc_subfield_structure
114 WHERE authorised_value IS NOT NULL
115 AND authorised_value!=''
116 AND frameworkcode=?");
117 $sth->execute( $frameworkcode );
119 while ( my ( $tag, $letter ) = $sth->fetchrow() ) {
120 $av->{ $tag }->{ $letter } = 1;
122 $authval_per_framework{ $frameworkcode } = $av;
124 return $authval_per_framework{ $frameworkcode };
127 =head2 XSLTParse4Display
129 Returns xml for biblionumber and requested XSLT transformation.
130 Returns undef if the transform fails.
132 Used in OPAC results and detail, intranet results and detail, list display.
133 (Depending on the settings of your XSLT preferences.)
135 The helper function _get_best_default_xslt_filename is used in a unit test.
139 sub _get_best_default_xslt_filename {
140 my ($htdocs, $theme, $lang, $base_xslfile) = @_;
143 "$htdocs/$theme/$lang/xslt/${base_xslfile}", # exact match
144 "$htdocs/$theme/en/xslt/${base_xslfile}", # if not, preferred theme in English
145 "$htdocs/prog/$lang/xslt/${base_xslfile}", # if not, 'prog' theme in preferred language
146 "$htdocs/prog/en/xslt/${base_xslfile}", # otherwise, prog theme in English; should always
150 foreach my $filename (@candidates) {
151 $xslfilename = $filename;
153 last; # we have a winner!
159 sub get_xslt_sysprefs {
160 my $sysxml = "<sysprefs>\n";
161 foreach my $syspref ( qw/ hidelostitems OPACURLOpenInNewWindow
162 DisplayOPACiconsXSLT URLLinkText viewISBD
163 OPACBaseURL TraceCompleteSubfields UseICUStyleQuotes
164 UseAuthoritiesForTracings TraceSubjectSubdivisions
165 Display856uAsImage OPACDisplay856uAsImage
166 UseControlNumber IntranetBiblioDefaultView BiblioDefaultView
167 OPACItemLocation DisplayIconsXSLT
168 AlternateHoldingsField AlternateHoldingsSeparator
169 TrackClicks opacthemes IdRef OpacSuppression
170 OPACResultsLibrary OPACShowOpenURL
171 OpenURLResolverURL OpenURLImageLocation
172 OPACResultsMaxItems OPACResultsMaxItemsUnavailable OPACResultsUnavailableGroupingBy
173 OpenURLText OPACShowMusicalInscripts OPACPlayMusicalInscripts / )
175 my $sp = C4::Context->preference( $syspref );
176 next unless defined($sp);
177 $sysxml .= "<syspref name=\"$syspref\">$sp</syspref>\n";
180 # singleBranchMode was a system preference, but no longer is
181 # we can retain it here for compatibility
182 my $singleBranchMode = Koha::Libraries->search->count == 1 ? 1 : 0;
183 $sysxml .= "<syspref name=\"singleBranchMode\">$singleBranchMode</syspref>\n";
185 $sysxml .= "</sysprefs>\n";
189 sub get_xsl_filename {
190 my ( $xslsyspref ) = @_;
192 my $lang = C4::Languages::getlanguage();
194 my $xslfilename = C4::Context->preference($xslsyspref) || "default";
196 if ( $xslfilename =~ /^\s*"?default"?\s*$/i ) {
198 my ( $htdocs, $theme, $xslfile );
200 if ($xslsyspref eq "XSLTDetailsDisplay") {
201 $htdocs = C4::Context->config('intrahtdocs');
202 $theme = C4::Context->preference("template");
203 $xslfile = C4::Context->preference('marcflavour') .
204 "slim2intranetDetail.xsl";
205 } elsif ($xslsyspref eq "XSLTResultsDisplay") {
206 $htdocs = C4::Context->config('intrahtdocs');
207 $theme = C4::Context->preference("template");
208 $xslfile = C4::Context->preference('marcflavour') .
209 "slim2intranetResults.xsl";
210 } elsif ($xslsyspref eq "OPACXSLTDetailsDisplay") {
211 $htdocs = C4::Context->config('opachtdocs');
212 $theme = C4::Context->preference("opacthemes");
213 $xslfile = C4::Context->preference('marcflavour') .
214 "slim2OPACDetail.xsl";
215 } elsif ($xslsyspref eq "OPACXSLTResultsDisplay") {
216 $htdocs = C4::Context->config('opachtdocs');
217 $theme = C4::Context->preference("opacthemes");
218 $xslfile = C4::Context->preference('marcflavour') .
219 "slim2OPACResults.xsl";
220 } elsif ($xslsyspref eq 'XSLTListsDisplay') {
221 # Lists default to *Results.xslt
222 $htdocs = C4::Context->config('intrahtdocs');
223 $theme = C4::Context->preference("template");
224 $xslfile = C4::Context->preference('marcflavour') .
225 "slim2intranetResults.xsl";
226 } elsif ($xslsyspref eq 'OPACXSLTListsDisplay') {
227 # Lists default to *Results.xslt
228 $htdocs = C4::Context->config('opachtdocs');
229 $theme = C4::Context->preference("opacthemes");
230 $xslfile = C4::Context->preference('marcflavour') .
231 "slim2OPACResults.xsl";
233 $xslfilename = _get_best_default_xslt_filename($htdocs, $theme, $lang, $xslfile);
236 if ( $xslfilename =~ m/\{langcode\}/ ) {
237 $xslfilename =~ s/\{langcode\}/$lang/;
243 sub XSLTParse4Display {
246 my $biblionumber = $params->{biblionumber};
247 my $orig_record = $params->{record};
248 my $xslsyspref = $params->{xsl_syspref};
249 my $fixamps = $params->{fix_amps};
250 my $hidden_items = $params->{hidden_items} || [];
251 my $variables = $params->{xslt_variables};
252 my $items_rs = $params->{items_rs};
254 my $xslfilename = get_xsl_filename( $xslsyspref);
256 # grab the XML, run it through our stylesheet, push it out to the browser
257 my $record = transformMARCXML4XSLT($biblionumber, $orig_record);
259 if ( $xslsyspref eq "OPACXSLTDetailsDisplay" || $xslsyspref eq "XSLTDetailsDisplay" || $xslsyspref eq "XSLTResultsDisplay" ) {
260 $itemsxml = ""; #We don't use XSLT for items display on these pages
262 $itemsxml = buildKohaItemsNamespace($biblionumber, $hidden_items, $items_rs);
264 my $xmlrecord = $record->as_xml(C4::Context->preference('marcflavour'));
268 if (C4::Context->preference('OPACShowOpenURL')) {
269 my @biblio_itemtypes;
270 $biblio //= Koha::Biblios->find($biblionumber);
271 if (C4::Context->preference('item-level_itypes')) {
272 @biblio_itemtypes = $biblio->items->get_column("itype");
274 push @biblio_itemtypes, $biblio->itemtype;
276 my @itypes = split( /\s/, C4::Context->preference('OPACOpenURLItemTypes') );
278 map { $original{$_} = 1 } @biblio_itemtypes;
279 if ( grep { $original{$_} } @itypes ) {
280 $variables->{OpenURLResolverURL} = $biblio->get_openurl;
284 # possibly show analytics link in Detail views
285 if ( $xslsyspref eq "OPACXSLTDetailsDisplay" || $xslsyspref eq "XSLTDetailsDisplay" ) {
286 $biblio //= Koha::Biblios->find( $biblionumber );
287 my $components = $biblio->get_marc_components();
288 $variables->{show_analytics_link} = ( scalar @{$components} == 0 ) ? 0 : 1;
290 my $showcomp = C4::Context->preference('ShowComponentRecords');
292 $variables->{show_analytics_link}
293 && ( $showcomp eq 'both'
294 || ( $showcomp eq 'staff' && $xslsyspref !~ m/OPAC/ )
295 || ( $showcomp eq 'opac' && $xslsyspref =~ m/OPAC/ ) )
298 $variables->{show_analytics_link} = 0;
302 my $varxml = "<variables>\n";
303 while (my ($key, $value) = each %$variables) {
304 $varxml .= "<variable name=\"$key\">$value</variable>\n";
306 $varxml .= "</variables>\n";
308 my $sysxml = get_xslt_sysprefs();
309 $xmlrecord =~ s/\<\/record\>/$itemsxml$sysxml$varxml\<\/record\>/;
310 if ($fixamps) { # We need to correct the ampersand entities that Zebra outputs
311 $xmlrecord =~ s/\&amp;/\&/g;
312 $xmlrecord =~ s/\&\;lt\;/\<\;/g;
313 $xmlrecord =~ s/\&\;gt\;/\>\;/g;
315 $xmlrecord =~ s/\& /\&\; /;
316 $xmlrecord =~ s/\&\;amp\; /\&\; /;
318 #If the xslt should fail, we will return undef (old behavior was
320 #Note that we did set do_not_return_source at object construction
321 return $engine->transform($xmlrecord, $xslfilename ); #file or URL
324 =head2 buildKohaItemsNamespace
326 my $items_xml = buildKohaItemsNamespace( $biblionumber, [ $hidden_items, $items ] );
328 Returns XML for items. It accepts two optional parameters:
329 - I<$hidden_items>: An arrayref of itemnumber values, for items that should be hidden
330 - I<$items>: A Koha::Items resultset, for the items to be returned
332 If both parameters are passed, I<$items> is used as the basis resultset, and I<$hidden_items>
333 are filtered out of it.
335 Is only used in this module currently.
339 sub buildKohaItemsNamespace {
340 my ($biblionumber, $hidden_items, $items_rs) = @_;
342 $hidden_items ||= [];
345 $query = { 'me.itemnumber' => { not_in => $hidden_items } }
348 unless ( $items_rs && ref($items_rs) eq 'Koha::Items' ) {
349 $query->{'me.biblionumber'} = $biblionumber;
350 $items_rs = Koha::Items->new;
353 my $items = $items_rs->search( $query, { prefetch => [ 'branchtransfers', 'reserves' ] } );
356 { map { $_->{authorised_value} => $_->{opac_description} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => "", kohafield => 'items.location' } ) };
358 { map { $_->{authorised_value} => $_->{opac_description} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => "", kohafield => 'items.ccode' } ) };
360 my %branches = map { $_->branchcode => $_->branchname } Koha::Libraries->search({}, { order_by => 'branchname' });
362 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search->unblessed } };
364 my %descs = map { $_->{authorised_value} => $_ } Koha::AuthorisedValues->get_descriptions_by_koha_field( { kohafield => 'items.notforloan' } );
365 my $ref_status = C4::Context->preference('Reference_NFL_Statuses') || '1|2';
367 while ( my $item = $items->next ) {
371 if ($item->has_pending_hold) {
373 $substatus = 'Pending hold';
375 elsif ( $item->holds->waiting->count ) {
377 $substatus = 'Waiting';
379 elsif ($item->get_transfer) {
381 $substatus = 'In transit';
383 elsif ($item->damaged) {
385 $substatus = "Damaged";
387 elsif ($item->itemlost) {
391 elsif ( $item->withdrawn) {
393 $substatus = "Withdrawn";
395 elsif ($item->onloan) {
397 $substatus = "Checked out";
399 elsif ( $item->notforloan ) {
400 $status = $item->notforloan =~ /^($ref_status)$/
402 : "reallynotforloan";
403 $substatus = exists $descs{$item->notforloan} ? $descs{$item->notforloan}->{opac_description} : "Not for loan";
405 elsif ( exists $itemtypes->{ $item->effective_itemtype }
406 && $itemtypes->{ $item->effective_itemtype }->{notforloan}
407 && $itemtypes->{ $item->effective_itemtype }->{notforloan} == 1 )
409 $status = "1" =~ /^($ref_status)$/
411 : "reallynotforloan";
412 $substatus = "Not for loan";
415 $status = "available";
417 my $homebranch = C4::Koha::xml_escape($branches{$item->homebranch});
418 my $holdingbranch = C4::Koha::xml_escape($branches{$item->holdingbranch});
419 my $resultbranch = C4::Context->preference('OPACResultsLibrary') eq 'homebranch' ? $homebranch : $holdingbranch;
420 my $location = C4::Koha::xml_escape($item->location && exists $shelflocations->{$item->location} ? $shelflocations->{$item->location} : $item->location);
421 my $ccode = C4::Koha::xml_escape($item->ccode && exists $ccodes->{$item->ccode} ? $ccodes->{$item->ccode} : $item->ccode);
422 my $itemcallnumber = C4::Koha::xml_escape($item->itemcallnumber);
423 my $stocknumber = C4::Koha::xml_escape($item->stocknumber);
426 . "<homebranch>$homebranch</homebranch>"
427 . "<holdingbranch>$holdingbranch</holdingbranch>"
428 . "<resultbranch>$resultbranch</resultbranch>"
429 . "<location>$location</location>"
430 . "<ccode>$ccode</ccode>"
431 . "<status>".( $status // q{} )."</status>"
432 . "<substatus>$substatus</substatus>"
433 . "<itemcallnumber>$itemcallnumber</itemcallnumber>"
434 . "<stocknumber>$stocknumber</stocknumber>"
437 $xml = "<items xmlns=\"http://www.koha-community.org/items\">".$xml."</items>";
443 Returns reference to XSLT handler object.
457 Joshua Ferraro <jmf@liblime.com>
459 Koha Development Team <http://koha-community.org/>