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>.
32 use Koha::AuthorisedValues;
34 use Koha::XSLT_Handler;
39 use vars qw(@ISA @EXPORT);
41 my $engine; #XSLT Handler object
42 my %authval_per_framework;
43 # Cache for tagfield-tagsubfield to decode per framework.
44 # Should be preferably be placed in Koha-core...
52 $engine=Koha::XSLT_Handler->new( { do_not_return_source => 1 } );
57 C4::XSLT - Functions for displaying XSLT-generated content
61 =head2 transformMARCXML4XSLT
63 Replaces codes with authorized values in a MARC::Record object
64 Is only used in this module currently.
68 sub transformMARCXML4XSLT {
69 my ($biblionumber, $record) = @_;
70 my $frameworkcode = GetFrameworkCode($biblionumber) || '';
71 my $tagslib = &GetMarcStructure(1, $frameworkcode, { unsafe => 1 });
73 # FIXME: wish there was a better way to handle exceptions
75 @fields = $record->fields();
77 if ($@) { warn "PROBLEM WITH RECORD"; next; }
78 my $marcflavour = C4::Context->preference('marcflavour');
79 my $av = getAuthorisedValues4MARCSubfields($frameworkcode);
80 foreach my $tag ( keys %$av ) {
81 foreach my $field ( $record->field( $tag ) ) {
82 if ( $av->{ $tag } ) {
83 my @new_subfields = ();
84 for my $subfield ( $field->subfields() ) {
85 my ( $letter, $value ) = @$subfield;
86 # Replace the field value with the authorised value *except* for MARC21/NORMARC field 942$n (suppression in opac)
87 if ( !( $tag eq '942' && $subfield eq 'n' ) || $marcflavour eq 'UNIMARC' ) {
88 $value = GetAuthorisedValueDesc( $tag, $letter, $value, '', $tagslib )
89 if $av->{ $tag }->{ $letter };
91 push( @new_subfields, $letter, $value );
93 $field ->replace_with( MARC::Field->new(
105 =head2 getAuthorisedValues4MARCSubfields
107 Returns a ref of hash of ref of hash for tag -> letter controlled by authorised values
108 Is only used in this module currently.
112 sub getAuthorisedValues4MARCSubfields {
113 my ($frameworkcode) = @_;
114 unless ( $authval_per_framework{ $frameworkcode } ) {
115 my $dbh = C4::Context->dbh;
116 my $sth = $dbh->prepare("SELECT DISTINCT tagfield, tagsubfield
117 FROM marc_subfield_structure
118 WHERE authorised_value IS NOT NULL
119 AND authorised_value!=''
120 AND frameworkcode=?");
121 $sth->execute( $frameworkcode );
123 while ( my ( $tag, $letter ) = $sth->fetchrow() ) {
124 $av->{ $tag }->{ $letter } = 1;
126 $authval_per_framework{ $frameworkcode } = $av;
128 return $authval_per_framework{ $frameworkcode };
131 =head2 XSLTParse4Display
133 Returns xml for biblionumber and requested XSLT transformation.
134 Returns undef if the transform fails.
136 Used in OPAC results and detail, intranet results and detail, list display.
137 (Depending on the settings of your XSLT preferences.)
139 The helper function _get_best_default_xslt_filename is used in a unit test.
143 sub _get_best_default_xslt_filename {
144 my ($htdocs, $theme, $lang, $base_xslfile) = @_;
147 "$htdocs/$theme/$lang/xslt/${base_xslfile}", # exact match
148 "$htdocs/$theme/en/xslt/${base_xslfile}", # if not, preferred theme in English
149 "$htdocs/prog/$lang/xslt/${base_xslfile}", # if not, 'prog' theme in preferred language
150 "$htdocs/prog/en/xslt/${base_xslfile}", # otherwise, prog theme in English; should always
154 foreach my $filename (@candidates) {
155 $xslfilename = $filename;
157 last; # we have a winner!
163 sub get_xslt_sysprefs {
164 my $sysxml = "<sysprefs>\n";
165 foreach my $syspref ( qw/ hidelostitems OPACURLOpenInNewWindow
166 DisplayOPACiconsXSLT URLLinkText viewISBD
167 OPACBaseURL TraceCompleteSubfields UseICU
168 UseAuthoritiesForTracings TraceSubjectSubdivisions
169 Display856uAsImage OPACDisplay856uAsImage
170 UseControlNumber IntranetBiblioDefaultView BiblioDefaultView
171 OPACItemLocation DisplayIconsXSLT
172 AlternateHoldingsField AlternateHoldingsSeparator
173 TrackClicks opacthemes IdRef OpacSuppression
174 OPACResultsLibrary OPACShowOpenURL
175 OpenURLResolverURL OpenURLImageLocation
176 OpenURLText OPACShowMusicalInscripts OPACPlayMusicalInscripts / )
178 my $sp = C4::Context->preference( $syspref );
179 next unless defined($sp);
180 $sysxml .= "<syspref name=\"$syspref\">$sp</syspref>\n";
183 # singleBranchMode was a system preference, but no longer is
184 # we can retain it here for compatibility
185 my $singleBranchMode = Koha::Libraries->search->count == 1 ? 1 : 0;
186 $sysxml .= "<syspref name=\"singleBranchMode\">$singleBranchMode</syspref>\n";
188 $sysxml .= "</sysprefs>\n";
192 sub XSLTParse4Display {
193 my ( $biblionumber, $orig_record, $xslsyspref, $fixamps, $hidden_items, $sysxml, $xslfilename, $lang, $variables ) = @_;
195 $sysxml ||= C4::Context->preference($xslsyspref);
196 $xslfilename ||= C4::Context->preference($xslsyspref);
197 $lang ||= C4::Languages::getlanguage();
199 if ( $xslfilename =~ /^\s*"?default"?\s*$/i ) {
203 if ($xslsyspref eq "XSLTDetailsDisplay") {
204 $htdocs = C4::Context->config('intrahtdocs');
205 $theme = C4::Context->preference("template");
206 $xslfile = C4::Context->preference('marcflavour') .
207 "slim2intranetDetail.xsl";
208 } elsif ($xslsyspref eq "XSLTResultsDisplay") {
209 $htdocs = C4::Context->config('intrahtdocs');
210 $theme = C4::Context->preference("template");
211 $xslfile = C4::Context->preference('marcflavour') .
212 "slim2intranetResults.xsl";
213 } elsif ($xslsyspref eq "OPACXSLTDetailsDisplay") {
214 $htdocs = C4::Context->config('opachtdocs');
215 $theme = C4::Context->preference("opacthemes");
216 $xslfile = C4::Context->preference('marcflavour') .
217 "slim2OPACDetail.xsl";
218 } elsif ($xslsyspref eq "OPACXSLTResultsDisplay") {
219 $htdocs = C4::Context->config('opachtdocs');
220 $theme = C4::Context->preference("opacthemes");
221 $xslfile = C4::Context->preference('marcflavour') .
222 "slim2OPACResults.xsl";
223 } elsif ($xslsyspref eq 'XSLTListsDisplay') {
224 # Lists default to *Results.xslt
225 $htdocs = C4::Context->config('intrahtdocs');
226 $theme = C4::Context->preference("template");
227 $xslfile = C4::Context->preference('marcflavour') .
228 "slim2intranetResults.xsl";
229 } elsif ($xslsyspref eq 'OPACXSLTListsDisplay') {
230 # Lists default to *Results.xslt
231 $htdocs = C4::Context->config('opachtdocs');
232 $theme = C4::Context->preference("opacthemes");
233 $xslfile = C4::Context->preference('marcflavour') .
234 "slim2OPACResults.xsl";
236 $xslfilename = _get_best_default_xslt_filename($htdocs, $theme, $lang, $xslfile);
239 if ( $xslfilename =~ m/\{langcode\}/ ) {
240 $xslfilename =~ s/\{langcode\}/$lang/;
243 # grab the XML, run it through our stylesheet, push it out to the browser
244 my $record = transformMARCXML4XSLT($biblionumber, $orig_record);
246 if ( $xslsyspref eq "OPACXSLTDetailsDisplay" || $xslsyspref eq "XSLTDetailsDisplay" || $xslsyspref eq "XSLTResultsDisplay" ) {
247 $itemsxml = ""; #We don't use XSLT for items display on these pages
249 $itemsxml = buildKohaItemsNamespace($biblionumber, $hidden_items);
251 my $xmlrecord = $record->as_xml(C4::Context->preference('marcflavour'));
254 if (C4::Context->preference('OPACShowOpenURL')) {
255 my @biblio_itemtypes;
256 my $biblio = Koha::Biblios->find($biblionumber);
257 if (C4::Context->preference('item-level_itypes')) {
258 @biblio_itemtypes = $biblio->items->get_column("itype");
260 push @biblio_itemtypes, $biblio->itemtype;
262 my @itypes = split( /\s/, C4::Context->preference('OPACOpenURLItemTypes') );
264 map { $original{$_} = 1 } @biblio_itemtypes;
265 if ( grep { $original{$_} } @itypes ) {
266 $variables->{OpenURLResolverURL} = $biblio->get_openurl;
269 my $varxml = "<variables>\n";
270 while (my ($key, $value) = each %$variables) {
271 $varxml .= "<variable name=\"$key\">$value</variable>\n";
273 $varxml .= "</variables>\n";
275 $xmlrecord =~ s/\<\/record\>/$itemsxml$sysxml$varxml\<\/record\>/;
276 if ($fixamps) { # We need to correct the ampersand entities that Zebra outputs
277 $xmlrecord =~ s/\&amp;/\&/g;
278 $xmlrecord =~ s/\&\;lt\;/\<\;/g;
279 $xmlrecord =~ s/\&\;gt\;/\>\;/g;
281 $xmlrecord =~ s/\& /\&\; /;
282 $xmlrecord =~ s/\&\;amp\; /\&\; /;
284 #If the xslt should fail, we will return undef (old behavior was
286 #Note that we did set do_not_return_source at object construction
287 return $engine->transform($xmlrecord, $xslfilename ); #file or URL
290 =head2 buildKohaItemsNamespace
292 Returns XML for items.
293 Is only used in this module currently.
297 sub buildKohaItemsNamespace {
298 my ($biblionumber, $hidden_items) = @_;
300 $hidden_items ||= [];
301 my @items = Koha::Items->search(
303 'me.biblionumber' => $biblionumber,
304 'me.itemnumber' => { not_in => $hidden_items }
306 { prefetch => [ 'branchtransfers', 'reserves' ] }
310 { map { $_->{authorised_value} => $_->{opac_description} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => "", kohafield => 'items.location' } ) };
312 { map { $_->{authorised_value} => $_->{opac_description} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => "", kohafield => 'items.ccode' } ) };
314 my %branches = map { $_->branchcode => $_->branchname } Koha::Libraries->search({}, { order_by => 'branchname' });
316 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search->unblessed } };
318 my %descs = map { $_->{authorised_value} => $_ } Koha::AuthorisedValues->get_descriptions_by_koha_field( { kohafield => 'items.notforloan' } );
320 for my $item (@items) {
325 if ($item->has_pending_hold) {
326 $status = 'Pending hold';
328 elsif ( $item->holds->waiting->count ) {
331 elsif ($item->get_transfer) {
332 $status = 'In transit';
334 elsif ($item->damaged) {
337 elsif ($item->itemlost) {
340 elsif ( $item->withdrawn) {
341 $status = "Withdrawn";
343 elsif ($item->onloan) {
344 $status = "Checked out";
346 elsif ( $item->notforloan > 0 ) {
347 $status = "reallynotforloan";
348 $substatus = $descs{$item->{notforloan}} || '';
349 $substatus = $substatus->{opac_description} if $substatus;
351 elsif ( $item->notforloan && $item->notforloan > 0
352 || exists $itemtypes->{ $item->effective_itemtype }
353 && $itemtypes->{ $item->effective_itemtype }->{notforloan} == 1 )
355 $status = "reference";
357 elsif ( $item->notforloan < 0) {
358 $status = "On order";
361 $status = "available";
363 my $homebranch = xml_escape($branches{$item->homebranch});
364 my $holdingbranch = xml_escape($branches{$item->holdingbranch});
365 my $location = xml_escape($item->location && exists $shelflocations->{$item->location} ? $shelflocations->{$item->location} : $item->location);
366 my $ccode = xml_escape($item->ccode && exists $ccodes->{$item->ccode} ? $ccodes->{$item->ccode} : $item->ccode);
367 my $itemcallnumber = xml_escape($item->itemcallnumber);
368 my $stocknumber = xml_escape($item->stocknumber);
371 . "<homebranch>$homebranch</homebranch>"
372 . "<holdingbranch>$holdingbranch</holdingbranch>"
373 . "<location>$location</location>"
374 . "<ccode>$ccode</ccode>"
375 . "<status>".( $status // q{} )."</status>"
376 . "<substatus>$substatus</substatus>"
377 . "<itemcallnumber>$itemcallnumber</itemcallnumber>"
378 . "<stocknumber>$stocknumber</stocknumber>"
381 $xml = "<items xmlns=\"http://www.koha-community.org/items\">".$xml."</items>";
387 Returns reference to XSLT handler object.
401 Joshua Ferraro <jmf@liblime.com>
403 Koha Development Team <http://koha-community.org/>