2 # Copyright (C) 2006 LibLime
3 # <jmf at liblime dot com>
4 # Parts Copyright Katrin Fischer 2011
5 # Parts Copyright ByWater Solutions 2011
6 # Parts Copyright Biblibre 2012
8 # This file is part of Koha.
10 # Koha is free software; you can redistribute it and/or modify it under the
11 # terms of the GNU General Public License as published by the Free Software
12 # Foundation; either version 2 of the License, or (at your option) any later
15 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
16 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License along
20 # with Koha; if not, write to the Free Software Foundation, Inc.,
21 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
38 use vars qw($VERSION @ISA @EXPORT);
42 $VERSION = 3.07.00.049;
52 C4::XSLT - Functions for displaying XSLT-generated content
58 GetURI file and returns the xslt as a string
69 =head2 transformMARCXML4XSLT
71 Replaces codes with authorized values in a MARC::Record object
75 sub transformMARCXML4XSLT {
76 my ($biblionumber, $record) = @_;
77 my $frameworkcode = GetFrameworkCode($biblionumber) || '';
78 my $tagslib = &GetMarcStructure(1,$frameworkcode);
80 # FIXME: wish there was a better way to handle exceptions
82 @fields = $record->fields();
84 if ($@) { warn "PROBLEM WITH RECORD"; next; }
85 my $av = getAuthorisedValues4MARCSubfields($frameworkcode);
86 foreach my $tag ( keys %$av ) {
87 foreach my $field ( $record->field( $tag ) ) {
88 if ( $av->{ $tag } ) {
89 my @new_subfields = ();
90 for my $subfield ( $field->subfields() ) {
91 my ( $letter, $value ) = @$subfield;
92 $value = GetAuthorisedValueDesc( $tag, $letter, $value, '', $tagslib )
93 if $av->{ $tag }->{ $letter };
94 push( @new_subfields, $letter, $value );
96 $field ->replace_with( MARC::Field->new(
108 =head2 getAuthorisedValues4MARCSubfields
110 Returns a ref of hash of ref of hash for tag -> letter controled by authorised values
114 # Cache for tagfield-tagsubfield to decode per framework.
115 # Should be preferably be placed in Koha-core...
116 my %authval_per_framework;
118 sub getAuthorisedValues4MARCSubfields {
119 my ($frameworkcode) = @_;
120 unless ( $authval_per_framework{ $frameworkcode } ) {
121 my $dbh = C4::Context->dbh;
122 my $sth = $dbh->prepare("SELECT DISTINCT tagfield, tagsubfield
123 FROM marc_subfield_structure
124 WHERE authorised_value IS NOT NULL
125 AND authorised_value!=''
126 AND frameworkcode=?");
127 $sth->execute( $frameworkcode );
129 while ( my ( $tag, $letter ) = $sth->fetchrow() ) {
130 $av->{ $tag }->{ $letter } = 1;
132 $authval_per_framework{ $frameworkcode } = $av;
134 return $authval_per_framework{ $frameworkcode };
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 XSLTParse4Display {
160 my ( $biblionumber, $orig_record, $xslsyspref, $fixamps, $hidden_items ) = @_;
161 my $xslfilename = C4::Context->preference($xslsyspref);
162 if ( $xslfilename =~ /^\s*"?default"?\s*$/i ) {
165 my $lang = C4::Templates::_current_language();
167 if ($xslsyspref eq "XSLTDetailsDisplay") {
168 $htdocs = C4::Context->config('intrahtdocs');
169 $theme = C4::Context->preference("template");
170 $xslfile = C4::Context->preference('marcflavour') .
171 "slim2intranetDetail.xsl";
172 } elsif ($xslsyspref eq "XSLTResultsDisplay") {
173 $htdocs = C4::Context->config('intrahtdocs');
174 $theme = C4::Context->preference("template");
175 $xslfile = C4::Context->preference('marcflavour') .
176 "slim2intranetResults.xsl";
177 } elsif ($xslsyspref eq "OPACXSLTDetailsDisplay") {
178 $htdocs = C4::Context->config('opachtdocs');
179 $theme = C4::Context->preference("opacthemes");
180 $xslfile = C4::Context->preference('marcflavour') .
181 "slim2OPACDetail.xsl";
182 } elsif ($xslsyspref eq "OPACXSLTResultsDisplay") {
183 $htdocs = C4::Context->config('opachtdocs');
184 $theme = C4::Context->preference("opacthemes");
185 $xslfile = C4::Context->preference('marcflavour') .
186 "slim2OPACResults.xsl";
188 $xslfilename = _get_best_default_xslt_filename($htdocs, $theme, $lang, $xslfile);
191 if ( $xslfilename =~ m/\{langcode\}/ ) {
192 my $lang = C4::Templates::_current_language();
193 $xslfilename =~ s/\{langcode\}/$lang/;
196 # grab the XML, run it through our stylesheet, push it out to the browser
197 my $record = transformMARCXML4XSLT($biblionumber, $orig_record);
198 #return $record->as_formatted();
199 my $itemsxml = buildKohaItemsNamespace($biblionumber, $hidden_items);
200 my $xmlrecord = $record->as_xml(C4::Context->preference('marcflavour'));
201 my $sysxml = "<sysprefs>\n";
202 foreach my $syspref ( qw/ hidelostitems OPACURLOpenInNewWindow
203 DisplayOPACiconsXSLT URLLinkText viewISBD
204 OPACBaseURL TraceCompleteSubfields UseICU
205 UseAuthoritiesForTracings TraceSubjectSubdivisions
206 Display856uAsImage OPACDisplay856uAsImage
207 UseControlNumber IntranetBiblioDefaultView BiblioDefaultView
208 singleBranchMode OPACItemLocation DisplayIconsXSLT
209 AlternateHoldingsField AlternateHoldingsSeparator
212 my $sp = C4::Context->preference( $syspref );
213 next unless defined($sp);
214 $sysxml .= "<syspref name=\"$syspref\">$sp</syspref>\n";
216 $sysxml .= "</sysprefs>\n";
217 $xmlrecord =~ s/\<\/record\>/$itemsxml$sysxml\<\/record\>/;
218 if ($fixamps) { # We need to correct the HTML entities that Zebra outputs
219 $xmlrecord =~ s/\&amp;/\&/g;
220 $xmlrecord =~ s/\&\;lt\;/\<\;/g;
221 $xmlrecord =~ s/\&\;gt\;/\>\;/g;
223 $xmlrecord =~ s/\& /\&\; /;
224 $xmlrecord =~ s/\&\;amp\; /\&\; /;
226 my $parser = XML::LibXML->new();
227 # don't die when you find &, >, etc
228 $parser->recover_silently(0);
229 my $source = $parser->parse_string($xmlrecord);
230 unless ( $stylesheet->{$xslfilename} ) {
231 my $xslt = XML::LibXSLT->new();
233 if ( $xslfilename =~ /^https?:\/\// ) {
234 my $xsltstring = GetURI($xslfilename);
235 $style_doc = $parser->parse_string($xsltstring);
238 $style_doc = $parser->parse_file($xslfilename);
240 $stylesheet->{$xslfilename} = $xslt->parse_stylesheet($style_doc);
242 my $results = $stylesheet->{$xslfilename}->transform($source);
243 my $newxmlrecord = $stylesheet->{$xslfilename}->output_string($results);
244 return $newxmlrecord;
247 sub buildKohaItemsNamespace {
248 my ($biblionumber, $hidden_items) = @_;
250 my @items = C4::Items::GetItemsInfo($biblionumber);
251 if ($hidden_items && @$hidden_items) {
252 my %hi = map {$_ => 1} @$hidden_items;
253 @items = grep { !$hi{$_->{itemnumber}} } @items;
256 my $shelflocations = GetKohaAuthorisedValues('items.location',GetFrameworkCode($biblionumber), 'opac');
257 my $ccodes = GetKohaAuthorisedValues('items.ccode',GetFrameworkCode($biblionumber), 'opac');
259 my $branches = GetBranches();
260 my $itemtypes = GetItemTypes();
264 for my $item (@items) {
267 my ( $transfertwhen, $transfertfrom, $transfertto ) = C4::Circulation::GetTransfers($item->{itemnumber});
269 my $reservestatus = C4::Reserves::GetReserveStatus( $item->{itemnumber} );
271 if ( $itemtypes->{ $item->{itype} }->{notforloan} || $item->{notforloan} || $item->{onloan} || $item->{withdrawn} || $item->{itemlost} || $item->{damaged} ||
272 (defined $transfertwhen && $transfertwhen ne '') || $item->{itemnotforloan} || (defined $reservestatus && $reservestatus eq "Waiting") ){
273 if ( $item->{notforloan} < 0) {
274 $status = "On order";
276 if ( $item->{itemnotforloan} > 0 || $item->{notforloan} > 0 || $itemtypes->{ $item->{itype} }->{notforloan} == 1 ) {
277 $status = "reference";
279 if ($item->{onloan}) {
280 $status = "Checked out";
282 if ( $item->{withdrawn}) {
283 $status = "Withdrawn";
285 if ($item->{itemlost}) {
288 if ($item->{damaged}) {
291 if (defined $transfertwhen && $transfertwhen ne '') {
292 $status = 'In transit';
294 if (defined $reservestatus && $reservestatus eq "Waiting") {
298 $status = "available";
300 my $homebranch = $item->{homebranch}? xml_escape($branches->{$item->{homebranch}}->{'branchname'}):'';
301 my $holdingbranch = $item->{holdingbranch}? xml_escape($branches->{$item->{holdingbranch}}->{'branchname'}):'';
302 $location = $item->{location}? xml_escape($shelflocations->{$item->{location}}||$item->{location}):'';
303 $ccode = $item->{ccode}? xml_escape($ccodes->{$item->{ccode}}||$item->{ccode}):'';
304 my $itemcallnumber = xml_escape($item->{itemcallnumber});
305 $xml.= "<item><homebranch>$homebranch</homebranch>".
306 "<holdingbranch>$holdingbranch</holdingbranch>".
307 "<location>$location</location>".
308 "<ccode>$ccode</ccode>".
309 "<status>$status</status>".
310 "<itemcallnumber>".$itemcallnumber."</itemcallnumber>"
314 $xml = "<items xmlns=\"http://www.koha-community.org/items\">".$xml."</items>";
329 Joshua Ferraro <jmf@liblime.com>