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;
31 use Koha::RecordProcessor;
36 my $engine; #XSLT Handler object
38 our (@ISA, @EXPORT_OK);
43 buildKohaItemsNamespace
46 $engine=Koha::XSLT::Base->new( { do_not_return_source => 1 } );
51 C4::XSLT - Functions for displaying XSLT-generated content
55 =head2 XSLTParse4Display
57 Returns xml for biblionumber and requested XSLT transformation.
58 Returns undef if the transform fails.
60 Used in OPAC results and detail, intranet results and detail, list display.
61 (Depending on the settings of your XSLT preferences.)
63 The helper function _get_best_default_xslt_filename is used in a unit test.
67 sub _get_best_default_xslt_filename {
68 my ($htdocs, $theme, $lang, $base_xslfile) = @_;
71 "$htdocs/$theme/$lang/xslt/${base_xslfile}", # exact match
72 "$htdocs/$theme/en/xslt/${base_xslfile}", # if not, preferred theme in English
73 "$htdocs/prog/$lang/xslt/${base_xslfile}", # if not, 'prog' theme in preferred language
74 "$htdocs/prog/en/xslt/${base_xslfile}", # otherwise, prog theme in English; should always
78 foreach my $filename (@candidates) {
79 $xslfilename = $filename;
81 last; # we have a winner!
87 sub get_xslt_sysprefs {
88 my $sysxml = "<sysprefs>\n";
89 foreach my $syspref ( qw/ hidelostitems OPACURLOpenInNewWindow
90 DisplayOPACiconsXSLT URLLinkText viewISBD
91 OPACBaseURL TraceCompleteSubfields UseICUStyleQuotes
92 UseAuthoritiesForTracings TraceSubjectSubdivisions
93 Display856uAsImage OPACDisplay856uAsImage
94 UseControlNumber IntranetBiblioDefaultView BiblioDefaultView
95 OPACItemLocation DisplayIconsXSLT
96 AlternateHoldingsField AlternateHoldingsSeparator
97 TrackClicks opacthemes IdRef OpacSuppression
98 OPACResultsLibrary OPACShowOpenURL
99 OpenURLResolverURL OpenURLImageLocation
100 OPACResultsMaxItems OPACResultsMaxItemsUnavailable OPACResultsUnavailableGroupingBy
101 OpenURLText OPACShowMusicalInscripts OPACPlayMusicalInscripts ContentWarningField / )
103 my $sp = C4::Context->preference( $syspref );
104 next unless defined($sp);
105 $sysxml .= "<syspref name=\"$syspref\">$sp</syspref>\n";
108 # singleBranchMode was a system preference, but no longer is
109 # we can retain it here for compatibility
110 my $singleBranchMode = Koha::Libraries->search->count == 1 ? 1 : 0;
111 $sysxml .= "<syspref name=\"singleBranchMode\">$singleBranchMode</syspref>\n";
113 $sysxml .= "</sysprefs>\n";
117 sub get_xsl_filename {
118 my ( $xslsyspref ) = @_;
120 my $lang = C4::Languages::getlanguage();
122 my $xslfilename = C4::Context->preference($xslsyspref) || "default";
124 if ( $xslfilename =~ /^\s*"?default"?\s*$/i ) {
126 my ( $htdocs, $theme, $xslfile );
128 if ($xslsyspref eq "XSLTDetailsDisplay") {
129 $htdocs = C4::Context->config('intrahtdocs');
130 $theme = C4::Context->preference("template");
131 $xslfile = C4::Context->preference('marcflavour') .
132 "slim2intranetDetail.xsl";
133 } elsif ($xslsyspref eq "XSLTResultsDisplay") {
134 $htdocs = C4::Context->config('intrahtdocs');
135 $theme = C4::Context->preference("template");
136 $xslfile = C4::Context->preference('marcflavour') .
137 "slim2intranetResults.xsl";
138 } elsif ($xslsyspref eq "OPACXSLTDetailsDisplay") {
139 $htdocs = C4::Context->config('opachtdocs');
140 $theme = C4::Context->preference("opacthemes");
141 $xslfile = C4::Context->preference('marcflavour') .
142 "slim2OPACDetail.xsl";
143 } elsif ($xslsyspref eq "OPACXSLTResultsDisplay") {
144 $htdocs = C4::Context->config('opachtdocs');
145 $theme = C4::Context->preference("opacthemes");
146 $xslfile = C4::Context->preference('marcflavour') .
147 "slim2OPACResults.xsl";
148 } elsif ($xslsyspref eq 'XSLTListsDisplay') {
149 # Lists default to *Results.xslt
150 $htdocs = C4::Context->config('intrahtdocs');
151 $theme = C4::Context->preference("template");
152 $xslfile = C4::Context->preference('marcflavour') .
153 "slim2intranetResults.xsl";
154 } elsif ($xslsyspref eq 'OPACXSLTListsDisplay') {
155 # Lists default to *Results.xslt
156 $htdocs = C4::Context->config('opachtdocs');
157 $theme = C4::Context->preference("opacthemes");
158 $xslfile = C4::Context->preference('marcflavour') .
159 "slim2OPACResults.xsl";
161 $xslfilename = _get_best_default_xslt_filename($htdocs, $theme, $lang, $xslfile);
164 if ( $xslfilename =~ m/\{langcode\}/ ) {
165 $xslfilename =~ s/\{langcode\}/$lang/;
171 sub XSLTParse4Display {
174 my $biblionumber = $params->{biblionumber};
175 my $record = $params->{record};
176 my $xslsyspref = $params->{xsl_syspref};
177 my $fixamps = $params->{fix_amps};
178 my $hidden_items = $params->{hidden_items} || [];
179 my $variables = $params->{xslt_variables};
180 my $items_rs = $params->{items_rs};
181 my $interface = C4::Context->interface;
183 die "Mandatory \$params->{xsl_syspref} was not provided, called with biblionumber $params->{biblionumber}"
184 if not defined $params->{xsl_syspref};
186 my $xslfilename = get_xsl_filename( $xslsyspref);
188 my $frameworkcode = GetFrameworkCode($biblionumber) || '';
189 my $record_processor = Koha::RecordProcessor->new(
191 filters => [ 'ExpandCodedFields' ],
193 interface => $interface,
194 frameworkcode => $frameworkcode
198 $record_processor->process($record);
200 # grab the XML, run it through our stylesheet, push it out to the browser
202 if ( $xslsyspref eq "OPACXSLTDetailsDisplay" || $xslsyspref eq "XSLTDetailsDisplay" || $xslsyspref eq "XSLTResultsDisplay" ) {
203 $itemsxml = ""; #We don't use XSLT for items display on these pages
205 $itemsxml = buildKohaItemsNamespace($biblionumber, $hidden_items, $items_rs);
207 my $xmlrecord = $record->as_xml(C4::Context->preference('marcflavour'));
211 if ( $interface eq 'opac' && C4::Context->preference('OPACShowOpenURL')) {
212 my @biblio_itemtypes;
213 $biblio //= Koha::Biblios->find($biblionumber);
214 if (C4::Context->preference('item-level_itypes')) {
215 @biblio_itemtypes = $biblio->items->get_column("itype");
217 push @biblio_itemtypes, $biblio->itemtype;
219 my @itypes = split( /\s/, C4::Context->preference('OPACOpenURLItemTypes') );
221 map { $original{$_} = 1 } @biblio_itemtypes;
222 if ( grep { $original{$_} } @itypes ) {
223 $variables->{OpenURLResolverURL} = $biblio->get_openurl;
228 my $varxml = "<variables>\n";
229 while (my ($key, $value) = each %$variables) {
231 $varxml .= "<variable name=\"$key\">$value</variable>\n";
233 $varxml .= "</variables>\n";
235 my $sysxml = get_xslt_sysprefs();
236 $xmlrecord =~ s/\<\/record\>/$itemsxml$sysxml$varxml\<\/record\>/;
237 if ($fixamps) { # We need to correct the ampersand entities that Zebra outputs
238 $xmlrecord =~ s/\&amp;/\&/g;
239 $xmlrecord =~ s/\&\;lt\;/\<\;/g;
240 $xmlrecord =~ s/\&\;gt\;/\>\;/g;
242 $xmlrecord =~ s/\& /\&\; /;
243 $xmlrecord =~ s/\&\;amp\; /\&\; /;
245 #If the xslt should fail, we will return undef (old behavior was
247 #Note that we did set do_not_return_source at object construction
248 return $engine->transform($xmlrecord, $xslfilename ); #file or URL
251 =head2 buildKohaItemsNamespace
253 my $items_xml = buildKohaItemsNamespace( $biblionumber, [ $hidden_items, $items ] );
255 Returns XML for items. It accepts two optional parameters:
256 - I<$hidden_items>: An arrayref of itemnumber values, for items that should be hidden
257 - I<$items>: A Koha::Items resultset, for the items to be returned
259 If both parameters are passed, I<$items> is used as the basis resultset, and I<$hidden_items>
260 are filtered out of it.
262 Is only used in this module currently.
266 sub buildKohaItemsNamespace {
267 my ($biblionumber, $hidden_items, $items_rs) = @_;
269 $hidden_items ||= [];
272 $query = { 'me.itemnumber' => { not_in => $hidden_items } }
275 unless ( $items_rs && ref($items_rs) eq 'Koha::Items' ) {
276 $query->{'me.biblionumber'} = $biblionumber;
277 $items_rs = Koha::Items->new;
280 my $items = $items_rs->search( $query, { prefetch => [ 'branchtransfers', 'reserves' ] } );
283 { map { $_->{authorised_value} => $_->{opac_description} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => "", kohafield => 'items.location' } ) };
285 { map { $_->{authorised_value} => $_->{opac_description} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => "", kohafield => 'items.ccode' } ) };
287 my %branches = map { $_->branchcode => $_->branchname } Koha::Libraries->search({}, { order_by => 'branchname' })->as_list;
289 my $itemtypes = { map { $_->{itemtype} => $_ } @{ Koha::ItemTypes->search->unblessed } };
291 my %descs = map { $_->{authorised_value} => $_ } Koha::AuthorisedValues->get_descriptions_by_koha_field( { kohafield => 'items.notforloan' } );
292 my $ref_status = C4::Context->preference('Reference_NFL_Statuses') // q{}; # fallback to 1|2 removed
294 while ( my $item = $items->next ) {
299 if ( C4::Context->preference('UseRecalls') ) {
300 $recalls_count = Koha::Recalls->search({ item_id => $item->itemnumber, status => 'waiting' })->count;
303 if ($recalls_count) {
304 # recalls take priority over holds
306 $substatus = 'Recall waiting';
308 elsif ( $item->has_pending_hold ) {
310 $substatus = 'Pending hold';
312 elsif ( $item->holds->waiting->count ) {
314 $substatus = 'Hold waiting';
316 elsif ($item->get_transfer) {
318 $substatus = 'In transit';
320 elsif ($item->damaged) {
322 $substatus = "Damaged";
324 elsif ($item->itemlost) {
328 elsif ( $item->withdrawn) {
330 $substatus = "Withdrawn";
332 elsif ($item->onloan) {
334 $substatus = "Checked out";
336 elsif ( $item->notforloan ) {
337 $status = $item->notforloan =~ /^($ref_status)$/
339 : "reallynotforloan";
340 $substatus = exists $descs{$item->notforloan} ? $descs{$item->notforloan}->{opac_description} : "Not for loan";
342 elsif ( exists $itemtypes->{ $item->effective_itemtype }
343 && $itemtypes->{ $item->effective_itemtype }->{notforloan}
344 && $itemtypes->{ $item->effective_itemtype }->{notforloan} == 1 )
346 $status = "1" =~ /^($ref_status)$/
348 : "reallynotforloan";
349 $substatus = "Not for loan";
352 $status = "available";
354 my $homebranch = C4::Koha::xml_escape($branches{$item->homebranch});
355 my $holdingbranch = C4::Koha::xml_escape($branches{$item->holdingbranch});
356 my $resultbranch = C4::Context->preference('OPACResultsLibrary') eq 'homebranch' ? $homebranch : $holdingbranch;
357 my $location = C4::Koha::xml_escape($item->location && exists $shelflocations->{$item->location} ? $shelflocations->{$item->location} : $item->location);
358 my $ccode = C4::Koha::xml_escape($item->ccode && exists $ccodes->{$item->ccode} ? $ccodes->{$item->ccode} : $item->ccode);
359 my $itemcallnumber = C4::Koha::xml_escape($item->itemcallnumber);
360 my $stocknumber = C4::Koha::xml_escape($item->stocknumber);
363 . "<homebranch>$homebranch</homebranch>"
364 . "<holdingbranch>$holdingbranch</holdingbranch>"
365 . "<resultbranch>$resultbranch</resultbranch>"
366 . "<location>$location</location>"
367 . "<ccode>$ccode</ccode>"
368 . "<status>".( $status // q{} )."</status>"
369 . "<substatus>$substatus</substatus>"
370 . "<itemcallnumber>$itemcallnumber</itemcallnumber>"
371 . "<stocknumber>$stocknumber</stocknumber>"
374 $xml = "<items xmlns=\"http://www.koha-community.org/items\">".$xml."</items>";
380 Returns reference to XSLT handler object.
394 Joshua Ferraro <jmf@liblime.com>
396 Koha Development Team <http://koha-community.org/>