C4/XSLT.pm

   1 package C4::XSLT;
   2
   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
   8 #
   9 # This file is part of Koha.
  10 #
  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
  14 # version.
  15 #
  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.
  19 #
  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.
  23
  24 use strict;
  25 use warnings;
  26
  27 use C4::Context;
  28 use C4::Branch;
  29 use C4::Items;
  30 use C4::Koha;
  31 use C4::Biblio;
  32 use C4::Circulation;
  33 use C4::Reserves;
  34 use Koha::XSLT_Handler;
  35 use Koha::Libraries;
  36
  37 use Encode;
  38
  39 use vars qw(@ISA @EXPORT);
  40
  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...
  45
  46 BEGIN {
  47     require Exporter;
  48     @ISA = qw(Exporter);
  49     @EXPORT = qw(
  50         &XSLTParse4Display
  51     );
  52     $engine=Koha::XSLT_Handler->new( { do_not_return_source => 1 } );
  53 }
  54
  55 =head1 NAME
  56
  57 C4::XSLT - Functions for displaying XSLT-generated content
  58
  59 =head1 FUNCTIONS
  60
  61 =head2 transformMARCXML4XSLT
  62
  63 Replaces codes with authorized values in a MARC::Record object
  64 Is only used in this module currently.
  65
  66 =cut
  67
  68 sub transformMARCXML4XSLT {
  69     my ($biblionumber, $record) = @_;
  70     my $frameworkcode = GetFrameworkCode($biblionumber) || '';
  71     my $tagslib = &GetMarcStructure(1,$frameworkcode);
  72     my @fields;
  73     # FIXME: wish there was a better way to handle exceptions
  74     eval {
  75         @fields = $record->fields();
  76     };
  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 };
  90                     }
  91                     push( @new_subfields, $letter, $value );
  92                 }
  93                 $field ->replace_with( MARC::Field->new(
  94                     $tag,
  95                     $field->indicator(1),
  96                     $field->indicator(2),
  97                     @new_subfields
  98                 ) );
  99             }
 100         }
 101     }
 102     return $record;
 103 }
 104
 105 =head2 getAuthorisedValues4MARCSubfields
 106
 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.
 109
 110 =cut
 111
 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 );
 122         my $av = { };
 123         while ( my ( $tag, $letter ) = $sth->fetchrow() ) {
 124             $av->{ $tag }->{ $letter } = 1;
 125         }
 126         $authval_per_framework{ $frameworkcode } = $av;
 127     }
 128     return $authval_per_framework{ $frameworkcode };
 129 }
 130
 131 =head2 XSLTParse4Display
 132
 133 Returns xml for biblionumber and requested XSLT transformation.
 134 Returns undef if the transform fails.
 135
 136 Used in OPAC results and detail, intranet results and detail, list display.
 137 (Depending on the settings of your XSLT preferences.)
 138
 139 The helper function _get_best_default_xslt_filename is used in a unit test.
 140
 141 =cut
 142
 143 sub _get_best_default_xslt_filename {
 144     my ($htdocs, $theme, $lang, $base_xslfile) = @_;
 145
 146     my @candidates = (
 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
 151                                                      # exist
 152     );
 153     my $xslfilename;
 154     foreach my $filename (@candidates) {
 155         $xslfilename = $filename;
 156         if (-f $filename) {
 157             last; # we have a winner!
 158         }
 159     }
 160     return $xslfilename;
 161 }
 162
 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     {
 175         my $sp = C4::Context->preference( $syspref );
 176         next unless defined($sp);
 177         $sysxml .= "<syspref name=\"$syspref\">$sp</syspref>\n";
 178     }
 179
 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";
 184
 185     $sysxml .= "</sysprefs>\n";
 186     return $sysxml;
 187 }
 188
 189 sub XSLTParse4Display {
 190     my ( $biblionumber, $orig_record, $xslsyspref, $fixamps, $hidden_items, $sysxml, $xslfilename, $lang ) = @_;
 191
 192     $sysxml ||= C4::Context->preference($xslsyspref);
 193     $xslfilename ||= C4::Context->preference($xslsyspref);
 194     $lang ||= C4::Languages::getlanguage();
 195
 196     if ( $xslfilename =~ /^\s*"?default"?\s*$/i ) {
 197         my $htdocs;
 198         my $theme;
 199         my $xslfile;
 200         if ($xslsyspref eq "XSLTDetailsDisplay") {
 201             $htdocs  = C4::Context->config('intrahtdocs');
 202             $theme   = C4::Context->preference("template");
 203             $xslfile = C4::Context->preference('marcflavour') .
 204                        "slim2intranetDetail.xsl";
 205         } elsif ($xslsyspref eq "XSLTResultsDisplay") {
 206             $htdocs  = C4::Context->config('intrahtdocs');
 207             $theme   = C4::Context->preference("template");
 208             $xslfile = C4::Context->preference('marcflavour') .
 209                         "slim2intranetResults.xsl";
 210         } elsif ($xslsyspref eq "OPACXSLTDetailsDisplay") {
 211             $htdocs  = C4::Context->config('opachtdocs');
 212             $theme   = C4::Context->preference("opacthemes");
 213             $xslfile = C4::Context->preference('marcflavour') .
 214                        "slim2OPACDetail.xsl";
 215         } elsif ($xslsyspref eq "OPACXSLTResultsDisplay") {
 216             $htdocs  = C4::Context->config('opachtdocs');
 217             $theme   = C4::Context->preference("opacthemes");
 218             $xslfile = C4::Context->preference('marcflavour') .
 219                        "slim2OPACResults.xsl";
 220         } elsif ($xslsyspref eq 'XSLTListsDisplay') {
 221             # Lists default to *Results.xslt
 222             $htdocs  = C4::Context->config('intrahtdocs');
 223             $theme   = C4::Context->preference("template");
 224             $xslfile = C4::Context->preference('marcflavour') .
 225                         "slim2intranetResults.xsl";
 226         } elsif ($xslsyspref eq 'OPACXSLTListsDisplay') {
 227             # Lists default to *Results.xslt
 228             $htdocs  = C4::Context->config('opachtdocs');
 229             $theme   = C4::Context->preference("opacthemes");
 230             $xslfile = C4::Context->preference('marcflavour') .
 231                        "slim2OPACResults.xsl";
 232         }
 233         $xslfilename = _get_best_default_xslt_filename($htdocs, $theme, $lang, $xslfile);
 234     }
 235
 236     if ( $xslfilename =~ m/\{langcode\}/ ) {
 237         $xslfilename =~ s/\{langcode\}/$lang/;
 238     }
 239
 240     # grab the XML, run it through our stylesheet, push it out to the browser
 241     my $record = transformMARCXML4XSLT($biblionumber, $orig_record);
 242     my $itemsxml  = buildKohaItemsNamespace($biblionumber, $hidden_items);
 243     my $xmlrecord = $record->as_xml(C4::Context->preference('marcflavour'));
 244
 245     $xmlrecord =~ s/\<\/record\>/$itemsxml$sysxml\<\/record\>/;
 246     if ($fixamps) { # We need to correct the HTML entities that Zebra outputs
 247         $xmlrecord =~ s/\&amp;amp;/\&amp;/g;
 248         $xmlrecord =~ s/\&amp\;lt\;/\&lt\;/g;
 249         $xmlrecord =~ s/\&amp\;gt\;/\&gt\;/g;
 250     }
 251     $xmlrecord =~ s/\& /\&amp\; /;
 252     $xmlrecord =~ s/\&amp\;amp\; /\&amp\; /;
 253
 254     #If the xslt should fail, we will return undef (old behavior was
 255     #raw MARC)
 256     #Note that we did set do_not_return_source at object construction
 257     return $engine->transform($xmlrecord, $xslfilename ); #file or URL
 258 }
 259
 260 =head2 buildKohaItemsNamespace
 261
 262 Returns XML for items.
 263 Is only used in this module currently.
 264
 265 =cut
 266
 267 sub buildKohaItemsNamespace {
 268     my ($biblionumber, $hidden_items) = @_;
 269
 270     my @items = C4::Items::GetItemsInfo($biblionumber);
 271     if ($hidden_items && @$hidden_items) {
 272         my %hi = map {$_ => 1} @$hidden_items;
 273         @items = grep { !$hi{$_->{itemnumber}} } @items;
 274     }
 275
 276     my $shelflocations = GetKohaAuthorisedValues('items.location',GetFrameworkCode($biblionumber), 'opac');
 277     my $ccodes         = GetKohaAuthorisedValues('items.ccode',GetFrameworkCode($biblionumber), 'opac');
 278
 279     my $branches = GetBranches();
 280     my $itemtypes = GetItemTypes();
 281     my $location = "";
 282     my $ccode = "";
 283     my $xml = '';
 284     for my $item (@items) {
 285         my $status;
 286
 287         my ( $transfertwhen, $transfertfrom, $transfertto ) = C4::Circulation::GetTransfers($item->{itemnumber});
 288
 289         my $reservestatus = C4::Reserves::GetReserveStatus( $item->{itemnumber} );
 290
 291         if ( $itemtypes->{ $item->{itype} }->{notforloan} || $item->{notforloan} || $item->{onloan} || $item->{withdrawn} || $item->{itemlost} || $item->{damaged} ||
 292              (defined $transfertwhen && $transfertwhen ne '') || $item->{itemnotforloan} || (defined $reservestatus && $reservestatus eq "Waiting") ){
 293             if ( $item->{notforloan} < 0) {
 294                 $status = "On order";
 295             }
 296             if ( $item->{itemnotforloan} > 0 || $item->{notforloan} > 0 || $itemtypes->{ $item->{itype} }->{notforloan} == 1 ) {
 297                 $status = "reference";
 298             }
 299             if ($item->{onloan}) {
 300                 $status = "Checked out";
 301             }
 302             if ( $item->{withdrawn}) {
 303                 $status = "Withdrawn";
 304             }
 305             if ($item->{itemlost}) {
 306                 $status = "Lost";
 307             }
 308             if ($item->{damaged}) {
 309                 $status = "Damaged";
 310             }
 311             if (defined $transfertwhen && $transfertwhen ne '') {
 312                 $status = 'In transit';
 313             }
 314             if (defined $reservestatus && $reservestatus eq "Waiting") {
 315                 $status = 'Waiting';
 316             }
 317         } else {
 318             $status = "available";
 319         }
 320         my $homebranch = $item->{homebranch}? xml_escape($branches->{$item->{homebranch}}->{'branchname'}):'';
 321         my $holdingbranch = $item->{holdingbranch}? xml_escape($branches->{$item->{holdingbranch}}->{'branchname'}):'';
 322         $location = $item->{location}? xml_escape($shelflocations->{$item->{location}}||$item->{location}):'';
 323         $ccode = $item->{ccode}? xml_escape($ccodes->{$item->{ccode}}||$item->{ccode}):'';
 324         my $itemcallnumber = xml_escape($item->{itemcallnumber});
 325         $xml.= "<item><homebranch>$homebranch</homebranch>".
 326                 "<holdingbranch>$holdingbranch</holdingbranch>".
 327                 "<location>$location</location>".
 328                 "<ccode>$ccode</ccode>".
 329                 "<status>$status</status>".
 330                 "<itemcallnumber>".$itemcallnumber."</itemcallnumber>".
 331                 "</item>";
 332     }
 333     $xml = "<items xmlns=\"http://www.koha-community.org/items\">".$xml."</items>";
 334     return $xml;
 335 }
 336
 337 =head2 engine
 338
 339 Returns reference to XSLT handler object.
 340
 341 =cut
 342
 343 sub engine {
 344     return $engine;
 345 }
 346
 347 1;
 348
 349 __END__
 350
 351 =head1 AUTHOR
 352
 353 Joshua Ferraro <jmf@liblime.com>
 354
 355 Koha Development Team <http://koha-community.org/>
 356
 357 =cut