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 under the
12 # terms of the GNU General Public License as published by the Free Software
13 # Foundation; either version 3 of the License, or (at your option) any later
16 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
17 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
18 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
20 # You should have received a copy of the GNU General Public License along
21 # with Koha; if not, write to the Free Software Foundation, Inc.,
22 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
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);
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 / )
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;
183 $sysxml .= "<syspref name=\"singleBranchMode\">$singleBranchMode</syspref>\n";
185 $sysxml .= "</sysprefs>\n";
189 sub XSLTParse4Display {
190 my ( $biblionumber, $orig_record, $xslsyspref, $fixamps, $hidden_items, $sysxml, $xslfilename, $lang ) = @_;
191 #my $xslfilename = C4::Context->preference($xslsyspref);
192 if ( $xslfilename =~ /^\s*"?default"?\s*$/i ) {
195 # my $lang = C4::Languages::getlanguage();
197 if ($xslsyspref eq "XSLTDetailsDisplay") {
198 $htdocs = C4::Context->config('intrahtdocs');
199 $theme = C4::Context->preference("template");
200 $xslfile = C4::Context->preference('marcflavour') .
201 "slim2intranetDetail.xsl";
202 } elsif ($xslsyspref eq "XSLTResultsDisplay") {
203 $htdocs = C4::Context->config('intrahtdocs');
204 $theme = C4::Context->preference("template");
205 $xslfile = C4::Context->preference('marcflavour') .
206 "slim2intranetResults.xsl";
207 } elsif ($xslsyspref eq "OPACXSLTDetailsDisplay") {
208 $htdocs = C4::Context->config('opachtdocs');
209 $theme = C4::Context->preference("opacthemes");
210 $xslfile = C4::Context->preference('marcflavour') .
211 "slim2OPACDetail.xsl";
212 } elsif ($xslsyspref eq "OPACXSLTResultsDisplay") {
213 $htdocs = C4::Context->config('opachtdocs');
214 $theme = C4::Context->preference("opacthemes");
215 $xslfile = C4::Context->preference('marcflavour') .
216 "slim2OPACResults.xsl";
218 $xslfilename = _get_best_default_xslt_filename($htdocs, $theme, $lang, $xslfile);
221 if ( $xslfilename =~ m/\{langcode\}/ ) {
222 my $lang = C4::Languages::getlanguage();
223 $xslfilename =~ s/\{langcode\}/$lang/;
226 # grab the XML, run it through our stylesheet, push it out to the browser
227 my $record = transformMARCXML4XSLT($biblionumber, $orig_record);
228 my $itemsxml = buildKohaItemsNamespace($biblionumber, $hidden_items);
229 my $xmlrecord = $record->as_xml(C4::Context->preference('marcflavour'));
231 $xmlrecord =~ s/\<\/record\>/$itemsxml$sysxml\<\/record\>/;
232 if ($fixamps) { # We need to correct the HTML entities that Zebra outputs
233 $xmlrecord =~ s/\&amp;/\&/g;
234 $xmlrecord =~ s/\&\;lt\;/\<\;/g;
235 $xmlrecord =~ s/\&\;gt\;/\>\;/g;
237 $xmlrecord =~ s/\& /\&\; /;
238 $xmlrecord =~ s/\&\;amp\; /\&\; /;
240 #If the xslt should fail, we will return undef (old behavior was
242 #Note that we did set do_not_return_source at object construction
243 return $engine->transform($xmlrecord, $xslfilename ); #file or URL
246 =head2 buildKohaItemsNamespace
248 Returns XML for items.
249 Is only used in this module currently.
253 sub buildKohaItemsNamespace {
254 my ($biblionumber, $hidden_items) = @_;
256 my @items = C4::Items::GetItemsInfo($biblionumber);
257 if ($hidden_items && @$hidden_items) {
258 my %hi = map {$_ => 1} @$hidden_items;
259 @items = grep { !$hi{$_->{itemnumber}} } @items;
262 my $shelflocations = GetKohaAuthorisedValues('items.location',GetFrameworkCode($biblionumber), 'opac');
263 my $ccodes = GetKohaAuthorisedValues('items.ccode',GetFrameworkCode($biblionumber), 'opac');
265 my $branches = GetBranches();
266 my $itemtypes = GetItemTypes();
270 for my $item (@items) {
273 my ( $transfertwhen, $transfertfrom, $transfertto ) = C4::Circulation::GetTransfers($item->{itemnumber});
275 my $reservestatus = C4::Reserves::GetReserveStatus( $item->{itemnumber} );
277 if ( $itemtypes->{ $item->{itype} }->{notforloan} || $item->{notforloan} || $item->{onloan} || $item->{withdrawn} || $item->{itemlost} || $item->{damaged} ||
278 (defined $transfertwhen && $transfertwhen ne '') || $item->{itemnotforloan} || (defined $reservestatus && $reservestatus eq "Waiting") ){
279 if ( $item->{notforloan} < 0) {
280 $status = "On order";
282 if ( $item->{itemnotforloan} > 0 || $item->{notforloan} > 0 || $itemtypes->{ $item->{itype} }->{notforloan} == 1 ) {
283 $status = "reference";
285 if ($item->{onloan}) {
286 $status = "Checked out";
288 if ( $item->{withdrawn}) {
289 $status = "Withdrawn";
291 if ($item->{itemlost}) {
294 if ($item->{damaged}) {
297 if (defined $transfertwhen && $transfertwhen ne '') {
298 $status = 'In transit';
300 if (defined $reservestatus && $reservestatus eq "Waiting") {
304 $status = "available";
306 my $homebranch = $item->{homebranch}? xml_escape($branches->{$item->{homebranch}}->{'branchname'}):'';
307 my $holdingbranch = $item->{holdingbranch}? xml_escape($branches->{$item->{holdingbranch}}->{'branchname'}):'';
308 $location = $item->{location}? xml_escape($shelflocations->{$item->{location}}||$item->{location}):'';
309 $ccode = $item->{ccode}? xml_escape($ccodes->{$item->{ccode}}||$item->{ccode}):'';
310 my $itemcallnumber = xml_escape($item->{itemcallnumber});
311 $xml.= "<item><homebranch>$homebranch</homebranch>".
312 "<holdingbranch>$holdingbranch</holdingbranch>".
313 "<location>$location</location>".
314 "<ccode>$ccode</ccode>".
315 "<status>$status</status>".
316 "<itemcallnumber>".$itemcallnumber."</itemcallnumber>".
319 $xml = "<items xmlns=\"http://www.koha-community.org/items\">".$xml."</items>";
325 Returns reference to XSLT handler object.
339 Joshua Ferraro <jmf@liblime.com>
341 Koha Development Team <http://koha-community.org/>