C4/XSLT.pm

   1 package C4::XSLT;
   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
   7 #
   8 # This file is part of Koha.
   9 #
  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
  13 # version.
  14 #
  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.
  18 #
  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.
  22
  23 use strict;
  24 use warnings;
  25
  26 use C4::Context;
  27 use C4::Branch;
  28 use C4::Items;
  29 use C4::Koha;
  30 use C4::Biblio;
  31 use C4::Circulation;
  32 use C4::Reserves;
  33 use Encode;
  34 use XML::LibXML;
  35 use XML::LibXSLT;
  36 use LWP::Simple;
  37
  38 use vars qw($VERSION @ISA @EXPORT);
  39
  40 BEGIN {
  41     require Exporter;
  42     $VERSION = 0.03;
  43     @ISA = qw(Exporter);
  44     @EXPORT = qw(
  45         &XSLTParse4Display
  46         &GetURI
  47     );
  48 }
  49
  50 =head1 NAME
  51
  52 C4::XSLT - Functions for displaying XSLT-generated content
  53
  54 =head1 FUNCTIONS
  55
  56 =head2 GetURI
  57
  58 GetURI file and returns the xslt as a string
  59
  60 =cut
  61
  62 sub GetURI {
  63     my ($uri) = @_;
  64     my $string;
  65     $string = get $uri ;
  66     return $string;
  67 }
  68
  69 =head2 transformMARCXML4XSLT
  70
  71 Replaces codes with authorized values in a MARC::Record object
  72
  73 =cut
  74
  75 sub transformMARCXML4XSLT {
  76     my ($biblionumber, $record) = @_;
  77     my $frameworkcode = GetFrameworkCode($biblionumber) || '';
  78     my $tagslib = &GetMarcStructure(1,$frameworkcode);
  79     my @fields;
  80     # FIXME: wish there was a better way to handle exceptions
  81     eval {
  82         @fields = $record->fields();
  83     };
  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 );
  95                 }
  96                 $field ->replace_with( MARC::Field->new(
  97                     $tag,
  98                     $field->indicator(1),
  99                     $field->indicator(2),
 100                     @new_subfields
 101                 ) );
 102             }
 103         }
 104     }
 105     return $record;
 106 }
 107
 108 =head2 getAuthorisedValues4MARCSubfields
 109
 110 Returns a ref of hash of ref of hash for tag -> letter controled by authorised values
 111
 112 =cut
 113
 114 # Cache for tagfield-tagsubfield to decode per framework.
 115 # Should be preferably be placed in Koha-core...
 116 my %authval_per_framework;
 117
 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 );
 128         my $av = { };
 129         while ( my ( $tag, $letter ) = $sth->fetchrow() ) {
 130             $av->{ $tag }->{ $letter } = 1;
 131         }
 132         $authval_per_framework{ $frameworkcode } = $av;
 133     }
 134     return $authval_per_framework{ $frameworkcode };
 135 }
 136
 137 my $stylesheet;
 138
 139 sub XSLTParse4Display {
 140     my ( $biblionumber, $orig_record, $xslsyspref, $fixamps, $hidden_items ) = @_;
 141     my $xslfilename = C4::Context->preference($xslsyspref);
 142     if ( $xslfilename =~ /^\s*"?default"?\s*$/i ) {
 143         if ($xslsyspref eq "XSLTDetailsDisplay") {
 144             $xslfilename = C4::Context->config('intrahtdocs') .
 145                         '/' . C4::Context->preference("template") .
 146                         '/' . C4::Templates::_current_language() .
 147                         '/xslt/' .
 148                         C4::Context->preference('marcflavour') .
 149                         "slim2intranetDetail.xsl";
 150         } elsif ($xslsyspref eq "XSLTResultsDisplay") {
 151             $xslfilename = C4::Context->config('intrahtdocs') .
 152                         '/' . C4::Context->preference("template") .
 153                         '/' . C4::Templates::_current_language() .
 154                         '/xslt/' .
 155                         C4::Context->preference('marcflavour') .
 156                         "slim2intranetResults.xsl";
 157         } elsif ($xslsyspref eq "OPACXSLTDetailsDisplay") {
 158             $xslfilename = C4::Context->config('opachtdocs') .
 159                         '/' . C4::Context->preference("opacthemes") .
 160                         '/' . C4::Templates::_current_language() .
 161                         '/xslt/' .
 162                         C4::Context->preference('marcflavour') .
 163                         "slim2OPACDetail.xsl";
 164         } elsif ($xslsyspref eq "OPACXSLTResultsDisplay") {
 165             $xslfilename = C4::Context->config('opachtdocs') .
 166                         '/' . C4::Context->preference("opacthemes") .
 167                         '/' . C4::Templates::_current_language() .
 168                         '/xslt/' .
 169                         C4::Context->preference('marcflavour') .
 170                         "slim2OPACResults.xsl";
 171         }
 172     }
 173
 174     if ( $xslfilename =~ m/\{langcode\}/ ) {
 175         my $lang = C4::Templates::_current_language();
 176         $xslfilename =~ s/\{langcode\}/$lang/;
 177     }
 178
 179     # grab the XML, run it through our stylesheet, push it out to the browser
 180     my $record = transformMARCXML4XSLT($biblionumber, $orig_record);
 181     #return $record->as_formatted();
 182     my $itemsxml  = buildKohaItemsNamespace($biblionumber, $hidden_items);
 183     my $xmlrecord = $record->as_xml(C4::Context->preference('marcflavour'));
 184     my $sysxml = "<sysprefs>\n";
 185     foreach my $syspref ( qw/ hidelostitems OPACURLOpenInNewWindow
 186                               DisplayOPACiconsXSLT URLLinkText viewISBD
 187                               OPACBaseURL TraceCompleteSubfields UseICU
 188                               UseAuthoritiesForTracings TraceSubjectSubdivisions
 189                               Display856uAsImage OPACDisplay856uAsImage
 190                               UseControlNumber
 191                               AlternateHoldingsField AlternateHoldingsSeparator / )
 192     {
 193         my $sp = C4::Context->preference( $syspref );
 194         next unless defined($sp);
 195         $sysxml .= "<syspref name=\"$syspref\">$sp</syspref>\n";
 196     }
 197     $sysxml .= "</sysprefs>\n";
 198     $xmlrecord =~ s/\<\/record\>/$itemsxml$sysxml\<\/record\>/;
 199     if ($fixamps) { # We need to correct the ampersand entities that Zebra outputs
 200         $xmlrecord =~ s/\&amp;amp;/\&amp;/g;
 201     }
 202     $xmlrecord =~ s/\& /\&amp\; /;
 203     $xmlrecord =~ s/\&amp\;amp\; /\&amp\; /;
 204
 205     my $parser = XML::LibXML->new();
 206     # don't die when you find &, >, etc
 207     $parser->recover_silently(0);
 208     my $source = $parser->parse_string($xmlrecord);
 209     unless ( $stylesheet->{$xslfilename} ) {
 210         my $xslt = XML::LibXSLT->new();
 211         my $style_doc;
 212         if ( $xslfilename =~ /^https?:\/\// ) {
 213             my $xsltstring = GetURI($xslfilename);
 214             $style_doc = $parser->parse_string($xsltstring);
 215         } else {
 216             use Cwd;
 217             $style_doc = $parser->parse_file($xslfilename);
 218         }
 219         $stylesheet->{$xslfilename} = $xslt->parse_stylesheet($style_doc);
 220     }
 221     my $results      = $stylesheet->{$xslfilename}->transform($source);
 222     my $newxmlrecord = $stylesheet->{$xslfilename}->output_string($results);
 223     return $newxmlrecord;
 224 }
 225
 226 sub buildKohaItemsNamespace {
 227     my ($biblionumber, $hidden_items) = @_;
 228
 229     my @items = C4::Items::GetItemsInfo($biblionumber);
 230     if ($hidden_items && @$hidden_items) {
 231         my %hi = map {$_ => 1} @$hidden_items;
 232         @items = grep { !$hi{$_->{itemnumber}} } @items;
 233     }
 234     my $branches = GetBranches();
 235     my $itemtypes = GetItemTypes();
 236     my $xml = '';
 237     for my $item (@items) {
 238         my $status;
 239
 240         my ( $transfertwhen, $transfertfrom, $transfertto ) = C4::Circulation::GetTransfers($item->{itemnumber});
 241
 242         my ( $reservestatus, $reserveitem, undef ) = C4::Reserves::CheckReserves($item->{itemnumber});
 243
 244         if ( $itemtypes->{ $item->{itype} }->{notforloan} || $item->{notforloan} || $item->{onloan} || $item->{wthdrawn} || $item->{itemlost} || $item->{damaged} ||
 245              (defined $transfertwhen && $transfertwhen ne '') || $item->{itemnotforloan} || (defined $reservestatus && $reservestatus eq "Waiting") ){
 246             if ( $item->{notforloan} < 0) {
 247                 $status = "On order";
 248             }
 249             if ( $item->{itemnotforloan} > 0 || $item->{notforloan} > 0 || $itemtypes->{ $item->{itype} }->{notforloan} == 1 ) {
 250                 $status = "reference";
 251             }
 252             if ($item->{onloan}) {
 253                 $status = "Checked out";
 254             }
 255             if ( $item->{wthdrawn}) {
 256                 $status = "Withdrawn";
 257             }
 258             if ($item->{itemlost}) {
 259                 $status = "Lost";
 260             }
 261             if ($item->{damaged}) {
 262                 $status = "Damaged";
 263             }
 264             if (defined $transfertwhen && $transfertwhen ne '') {
 265                 $status = 'In transit';
 266             }
 267             if (defined $reservestatus && $reservestatus eq "Waiting") {
 268                 $status = 'Waiting';
 269             }
 270         } else {
 271             $status = "available";
 272         }
 273         my $homebranch = $item->{homebranch}? xml_escape($branches->{$item->{homebranch}}->{'branchname'}):'';
 274             my $itemcallnumber = xml_escape($item->{itemcallnumber});
 275         $xml.= "<item><homebranch>$homebranch</homebranch>".
 276                 "<status>$status</status>".
 277                 "<itemcallnumber>".$itemcallnumber."</itemcallnumber>"
 278         . "</item>";
 279
 280     }
 281     $xml = "<items xmlns=\"http://www.koha-community.org/items\">".$xml."</items>";
 282     return $xml;
 283 }
 284
 285
 286
 287 1;
 288 __END__
 289
 290 =head1 NOTES
 291
 292 =cut
 293
 294 =head1 AUTHOR
 295
 296 Joshua Ferraro <jmf@liblime.com>
 297
 298 =cut