C4/Record.pm

   1 package C4::Record;
   2 #
   3 # Copyright 2006 (C) LibLime
   4 # Joshua Ferraro <jmf@liblime.com>
   5 #
   6 # This file is part of Koha.
   7 #
   8 # Koha is free software; you can redistribute it and/or modify it under the
   9 # terms of the GNU General Public License as published by the Free Software
  10 # Foundation; either version 2 of the License, or (at your option) any later
  11 # version.
  12 #
  13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  15 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License along with
  18 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  19 # Suite 330, Boston, MA  02111-1307 USA
  20 #
  21 # $Id$
  22 #
  23 use strict;# use warnings; #FIXME: turn off warnings before release
  24
  25 # please specify in which methods a given module is used
  26 use MARC::Record; # marc2marcxml, marcxml2marc, html2marc, changeEncoding
  27 use MARC::File::XML; # marc2marcxml, marcxml2marc, html2marcxml, changeEncoding
  28 use MARC::Crosswalk::DublinCore; # marc2dcxml
  29 use Unicode::Normalize; # _entity_encode
  30 use XML::LibXSLT;
  31 use XML::LibXML;
  32
  33 use vars qw($VERSION @ISA @EXPORT);
  34
  35 # set the version for version checking
  36 $VERSION = do { my @v = '$Revision$' =~ /\d+/g;
  37                 shift(@v) . "." . join("_", map {sprintf "%03d", $_ } @v); };
  38
  39 @ISA = qw(Exporter);
  40
  41 # only export API methods
  42
  43 @EXPORT = qw(
  44   &marc2marc
  45   &marc2marcxml
  46   &marcxml2marc
  47   &marc2dcxml
  48   &marc2modsxml
  49
  50   &html2marcxml
  51   &html2marc
  52   &changeEncoding
  53 );
  54
  55 =head1 NAME
  56
  57 C4::Record - MARC, MARCXML, DC, MODS, XML, etc. Record Management Functions and API
  58
  59 =head1 SYNOPSIS
  60
  61 New in Koha 3.x. This module handles all record-related management functions.
  62
  63 =head1 API (EXPORTED FUNCTIONS)
  64
  65 =head2 marc2marc - Convert from one flavour of ISO-2709 to another
  66
  67 =over 4
  68
  69 my ($error,$newmarc) = marc2marc($marc,$to_flavour,$from_flavour,$encoding);
  70
  71 Returns an ISO-2709 scalar
  72
  73 =back
  74
  75 =cut
  76
  77 sub marc2marc {
  78         my ($marc,$to_flavour,$from_flavour,$encoding) = @_;
  79         my $error = "Feature not yet implemented\n";
  80         return ($error,$marc);
  81 }
  82
  83 =head2 marc2marcxml - Convert from ISO-2709 to MARCXML
  84
  85 =over 4
  86
  87 my ($error,$marcxml) = marc2marcxml($marc,$encoding,$flavour);
  88
  89 Returns a MARCXML scalar
  90
  91 =over 2
  92
  93 C<$marc> - an ISO-2709 scalar or MARC::Record object
  94
  95 C<$encoding> - UTF-8 or MARC-8 [UTF-8]
  96
  97 C<$flavour> - MARC21 or UNIMARC
  98
  99 C<$dont_entity_encode> - a flag that instructs marc2marcxml not to entity encode the xml before returning (optional)
 100
 101 =back
 102
 103 =back
 104
 105 =cut
 106
 107 sub marc2marcxml {
 108         my ($marc,$encoding,$flavour,$dont_entity_encode) = @_;
 109         my $error; # the error string
 110         my $marcxml; # the final MARCXML scalar
 111
 112         # test if it's already a MARC::Record object, if not, make it one
 113         my $marc_record_obj;
 114         if ($marc =~ /^MARC::Record/) { # it's already a MARC::Record object
 115                 $marc_record_obj = $marc;
 116         } else { # it's not a MARC::Record object, make it one
 117                 eval { $marc_record_obj = MARC::Record->new_from_usmarc($marc) }; # handle exceptions
 118
 119                 # conversion to MARC::Record object failed, populate $error
 120                 if ($@) { $error .="\nCreation of MARC::Record object failed: ".$MARC::File::ERROR };
 121         }
 122         # only proceed if no errors so far
 123         unless ($error) {
 124
 125                 # check the record for warnings
 126                 my @warnings = $marc_record_obj->warnings();
 127                 if (@warnings) {
 128                         warn "\nWarnings encountered while processing ISO-2709 record with title \"".$marc_record_obj->title()."\":\n";
 129                         foreach my $warn (@warnings) { warn "\t".$warn };
 130                 }
 131                 unless($encoding) {$encoding = "UTF-8"}; # set default encoding
 132                 unless($flavour) {$flavour = C4::Context->preference("marcflavour")}; # set default MARC flavour
 133
 134                 # attempt to convert the record to MARCXML
 135                 eval { $marcxml = $marc_record_obj->as_xml_record($flavour) }; #handle exceptions
 136
 137                 # record creation failed, populate $error
 138                 if ($@) {
 139                         $error .= "Creation of MARCXML failed:".$MARC::File::ERROR;
 140                         $error .= "Additional information:\n";
 141                         my @warnings = $@->warnings();
 142                         foreach my $warn (@warnings) { $error.=$warn."\n" };
 143
 144                 # record creation was successful
 145         } else {
 146
 147                         # check the record for warning flags again (warnings() will be cleared already if there was an error, see above block
 148                         @warnings = $marc_record_obj->warnings();
 149                         if (@warnings) {
 150                                 warn "\nWarnings encountered while processing ISO-2709 record with title \"".$marc_record_obj->title()."\":\n";
 151                                 foreach my $warn (@warnings) { warn "\t".$warn };
 152                         }
 153                 }
 154
 155                 # only proceed if no errors so far
 156                 unless ($error) {
 157
 158                         # entity encode the XML unless instructed not to
 159                 unless ($dont_entity_encode) {
 160                         my ($marcxml_entity_encoded) = _entity_encode($marcxml);
 161                         $marcxml = $marcxml_entity_encoded;
 162                 }
 163                 }
 164         }
 165         # return result to calling program
 166         return ($error,$marcxml);
 167 }
 168
 169 =head2 marcxml2marc - Convert from MARCXML to ISO-2709
 170
 171 =over 4
 172
 173 my ($error,$marc) = marcxml2marc($marcxml,$encoding,$flavour);
 174
 175 Returns an ISO-2709 scalar
 176
 177 =over 2
 178
 179 C<$marcxml> - a MARCXML record
 180
 181 C<$encoding> - UTF-8 or MARC-8 [UTF-8]
 182
 183 C<$flavour> - MARC21 or UNIMARC
 184
 185 =back
 186
 187 =back
 188
 189 =cut
 190
 191 sub marcxml2marc {
 192     my ($marcxml,$encoding,$flavour) = @_;
 193         my $error; # the error string
 194         my $marc; # the final ISO-2709 scalar
 195         unless($encoding) {$encoding = "UTF-8"}; # set the default encoding
 196         unless($flavour) {$flavour = C4::Context->preference("marcflavour")}; # set the default MARC flavour
 197
 198         # attempt to do the conversion
 199         eval { $marc = MARC::Record->new_from_xml($marcxml,$encoding,$flavour) }; # handle exceptions
 200
 201         # record creation failed, populate $error
 202         if ($@) {$error .="\nCreation of MARCXML Record failed: ".$@;
 203                 $error.=$MARC::File::ERROR if ($MARC::File::ERROR);
 204                 };
 205         # return result to calling program
 206         return ($error,$marc);
 207 }
 208
 209 =head2 marc2dcxml - Convert from ISO-2709 to Dublin Core
 210
 211 =over 4
 212
 213 my ($error,$dcxml) = marc2dcxml($marc,$qualified);
 214
 215 Returns a DublinCore::Record object, will eventually return a Dublin Core scalar
 216
 217 FIXME: should return actual XML, not just an object
 218
 219 =over 2
 220
 221 C<$marc> - an ISO-2709 scalar or MARC::Record object
 222
 223 C<$qualified> - specify whether qualified Dublin Core should be used in the input or output [0]
 224
 225 =back
 226
 227 =back
 228
 229 =cut
 230
 231 sub marc2dcxml {
 232         my ($marc,$qualified) = @_;
 233         my $error;
 234     # test if it's already a MARC::Record object, if not, make it one
 235     my $marc_record_obj;
 236     if ($marc =~ /^MARC::Record/) { # it's already a MARC::Record object
 237         $marc_record_obj = $marc;
 238     } else { # it's not a MARC::Record object, make it one
 239                 eval { $marc_record_obj = MARC::Record->new_from_usmarc($marc) }; # handle exceptions
 240
 241                 # conversion to MARC::Record object failed, populate $error
 242                 if ($@) {
 243                         $error .="\nCreation of MARC::Record object failed: ".$MARC::File::ERROR;
 244                 }
 245         }
 246         my $crosswalk = MARC::Crosswalk::DublinCore->new;
 247         if ($qualified) {
 248                 $crosswalk = MARC::Crosswalk::DublinCore->new( qualified => 1 );
 249         }
 250         my $dcxml = $crosswalk->as_dublincore($marc_record_obj);
 251         my $dcxmlfinal = "<?xml version=\"1.0\"?>\n";
 252         $dcxmlfinal .= "<metadata
 253   xmlns=\"http://example.org/myapp/\"
 254   xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
 255   xsi:schemaLocation=\"http://example.org/myapp/ http://example.org/myapp/schema.xsd\"
 256   xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
 257   xmlns:dcterms=\"http://purl.org/dc/terms/\">";
 258
 259         foreach my $element ( $dcxml->elements() ) {
 260                 $dcxmlfinal.="<"."dc:".$element->name().">".$element->content()."</"."dc:".$element->name()."\n";
 261     }
 262         $dcxmlfinal .= "\n</metadata>";
 263         return ($error,$dcxmlfinal);
 264 }
 265 =head2 marc2modsxml - Convert from ISO-2709 to MODS
 266
 267 =over 4
 268
 269 my ($error,$modsxml) = marc2modsxml($marc);
 270
 271 Returns a MODS scalar
 272
 273 =back
 274
 275 =cut
 276
 277 sub marc2modsxml {
 278         my ($marc) = @_;
 279         # grab the XML, run it through our stylesheet, push it out to the browser
 280         my $xmlrecord = marc2marcxml($marc);
 281         my $xslfile = C4::Context->config('intranetdir')."/misc/xslt/MARC21slim2MODS3-1.xsl";
 282         my $parser = XML::LibXML->new();
 283         my $xslt = XML::LibXSLT->new();
 284         my $source = $parser->parse_string($xmlrecord);
 285         my $style_doc = $parser->parse_file($xslfile);
 286         my $stylesheet = $xslt->parse_stylesheet($style_doc);
 287         my $results = $stylesheet->transform($source);
 288         my $newxmlrecord = $stylesheet->output_string($results);
 289         return ($newxmlrecord);
 290 }
 291 =head2 html2marcxml
 292
 293 =over 4
 294
 295 my ($error,$marcxml) = html2marcxml($tags,$subfields,$values,$indicator,$ind_tag);
 296
 297 Returns a MARCXML scalar
 298
 299 this is used in addbiblio.pl and additem.pl to build the MARCXML record from
 300 the form submission.
 301
 302 FIXME: this could use some better code documentation
 303
 304 =back
 305
 306 =cut
 307
 308 sub html2marcxml {
 309     my ($tags,$subfields,$values,$indicator,$ind_tag) = @_;
 310         my $error;
 311         # add the header info
 312     my $marcxml= MARC::File::XML::header(C4::Context->preference('TemplateEncoding'),C4::Context->preference('marcflavour'));
 313
 314         # some flags used to figure out where in the record we are
 315     my $prevvalue;
 316     my $prevtag=-1;
 317     my $first=1;
 318     my $j = -1;
 319
 320         # handle characters that would cause the parser to choke FIXME: is there a more elegant solution?
 321     for (my $i=0;$i<=@$tags;$i++){
 322                 @$values[$i] =~ s/&/&amp;/g;
 323                 @$values[$i] =~ s/</&lt;/g;
 324                 @$values[$i] =~ s/>/&gt;/g;
 325                 @$values[$i] =~ s/"/&quot;/g;
 326                 @$values[$i] =~ s/'/&apos;/g;
 327
 328                 if ((@$tags[$i] ne $prevtag)){
 329                         $j++ unless (@$tags[$i] eq "");
 330                         #warn "IND:".substr(@$indicator[$j],0,1).substr(@$indicator[$j],1,1)." ".@$tags[$i];
 331                         if (!$first){
 332                                 $marcxml.="</datafield>\n";
 333                                 if ((@$tags[$i] > 10) && (@$values[$i] ne "")){
 334                         my $ind1 = substr(@$indicator[$j],0,1);
 335                                         my $ind2 = substr(@$indicator[$j],1,1);
 336                                         $marcxml.="<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
 337                                         $marcxml.="<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
 338                                         $first=0;
 339                                 } else {
 340                                         $first=1;
 341                                 }
 342                         } else {
 343                                 if (@$values[$i] ne "") {
 344                                         # handle the leader
 345                                         if (@$tags[$i] eq "000") {
 346                                                 $marcxml.="<leader>@$values[$i]</leader>\n";
 347                                                 $first=1;
 348                                         # rest of the fixed fields
 349                                         } elsif (@$tags[$i] < 010) { #FIXME: <10 was the way it was, there might even be a better way
 350                                                 $marcxml.="<controlfield tag=\"@$tags[$i]\">@$values[$i]</controlfield>\n";
 351                                                 $first=1;
 352                                         } else {
 353                                                 my $ind1 = substr(@$indicator[$j],0,1);
 354                                                 my $ind2 = substr(@$indicator[$j],1,1);
 355                                                 $marcxml.="<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
 356                                                 $marcxml.="<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
 357                                                 $first=0;
 358                                         }
 359                                 }
 360                         }
 361                 } else { # @$tags[$i] eq $prevtag
 362                         if (@$values[$i] eq "") {
 363                         } else {
 364                                 if ($first){
 365                                         my $ind1 = substr(@$indicator[$j],0,1);
 366                                         my $ind2 = substr(@$indicator[$j],1,1);
 367                                         $marcxml.="<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
 368                                         $first=0;
 369                                 }
 370                                 $marcxml.="<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
 371                         }
 372                 }
 373                 $prevtag = @$tags[$i];
 374         }
 375         $marcxml.= MARC::File::XML::footer();
 376         #warn $marcxml;
 377         return ($error,$marcxml);
 378 }
 379
 380 =head2 html2marc
 381
 382 =over 4
 383
 384 Probably best to avoid using this ... it has some rather striking problems:
 385
 386 =over 2
 387
 388 * saves blank subfields
 389
 390 * subfield order is hardcoded to always start with 'a' for repeatable tags (because it is hardcoded in the addfield routine).
 391
 392 * only possible to specify one set of indicators for each set of tags (ie, one for all the 650s). (because they were stored in a hash with the tag as the key).
 393
 394 * the underlying routines didn't support subfield reordering or subfield repeatability.
 395
 396 =back
 397
 398 I've left it in here because it could be useful if someone took the time to fix it. -- kados
 399
 400 =back
 401
 402 =cut
 403
 404 sub html2marc {
 405     my ($dbh,$rtags,$rsubfields,$rvalues,%indicators) = @_;
 406     my $prevtag = -1;
 407     my $record = MARC::Record->new();
 408 #   my %subfieldlist=();
 409     my $prevvalue; # if tag <10
 410     my $field; # if tag >=10
 411     for (my $i=0; $i< @$rtags; $i++) {
 412         # rebuild MARC::Record
 413 #           warn "0=>".@$rtags[$i].@$rsubfields[$i]." = ".@$rvalues[$i].": ";
 414         if (@$rtags[$i] ne $prevtag) {
 415             if ($prevtag < 10) {
 416                 if ($prevvalue) {
 417                     if (($prevtag ne '000') && ($prevvalue ne "")) {
 418                         $record->add_fields((sprintf "%03s",$prevtag),$prevvalue);
 419                     } elsif ($prevvalue ne ""){
 420                         $record->leader($prevvalue);
 421                     }
 422                 }
 423             } else {
 424                 if (($field) && ($field ne "")) {
 425                     $record->add_fields($field);
 426                 }
 427             }
 428             $indicators{@$rtags[$i]}.='  ';
 429                 # skip blank tags, I hope this works
 430                 if (@$rtags[$i] eq ''){
 431                 $prevtag = @$rtags[$i];
 432                 undef $field;
 433                 next;
 434             }
 435             if (@$rtags[$i] <10) {
 436                 $prevvalue= @$rvalues[$i];
 437                 undef $field;
 438             } else {
 439                 undef $prevvalue;
 440                 if (@$rvalues[$i] eq "") {
 441                 undef $field;
 442                 } else {
 443                 $field = MARC::Field->new( (sprintf "%03s",@$rtags[$i]), substr($indicators{@$rtags[$i]},0,1),substr($indicators{@$rtags[$i]},1,1), @$rsubfields[$i] => @$rvalues[$i]);
 444                 }
 445 #           warn "1=>".@$rtags[$i].@$rsubfields[$i]." = ".@$rvalues[$i].": ".$field->as_formatted;
 446             }
 447             $prevtag = @$rtags[$i];
 448         } else {
 449             if (@$rtags[$i] <10) {
 450                 $prevvalue=@$rvalues[$i];
 451             } else {
 452                 if (length(@$rvalues[$i])>0) {
 453                     $field->add_subfields(@$rsubfields[$i] => @$rvalues[$i]);
 454 #           warn "2=>".@$rtags[$i].@$rsubfields[$i]." = ".@$rvalues[$i].": ".$field->as_formatted;
 455                 }
 456             }
 457             $prevtag= @$rtags[$i];
 458         }
 459     }
 460     #}
 461     # the last has not been included inside the loop... do it now !
 462     #use Data::Dumper;
 463     #warn Dumper($field->{_subfields});
 464     $record->add_fields($field) if (($field) && $field ne "");
 465     #warn "HTML2MARC=".$record->as_formatted;
 466     return $record;
 467 }
 468
 469 =head2 changeEncoding - Change the encoding of a record
 470
 471 =over 4
 472
 473 my ($error, $newrecord) = changeEncoding($record,$format,$flavour,$to_encoding,$from_encoding);
 474
 475 Changes the encoding of a record
 476
 477 =over 2
 478
 479 C<$record> - the record itself can be in ISO-2709, a MARC::Record object, or MARCXML for now (required)
 480
 481 C<$format> - MARC or MARCXML (required)
 482
 483 C<$flavour> - MARC21 or UNIMARC, if MARC21, it will change the leader (optional) [defaults to Koha system preference]
 484
 485 C<$to_encoding> - the encoding you want the record to end up in (optional) [UTF-8]
 486
 487 C<$from_encoding> - the encoding the record is currently in (optional, it will probably be able to tell unless there's a problem with the record)
 488
 489 =back
 490
 491 FIXME: the from_encoding doesn't work yet
 492
 493 FIXME: better handling for UNIMARC, it should allow management of 100 field
 494
 495 FIXME: shouldn't have to convert to and from xml/marc just to change encoding someone needs to re-write MARC::Record's 'encoding' method to actually alter the encoding rather than just changing the leader
 496
 497 =back
 498
 499 =cut
 500
 501 sub changeEncoding {
 502         my ($record,$format,$flavour,$to_encoding,$from_encoding) = @_;
 503         my $newrecord;
 504         my $error;
 505         unless($flavour) {$flavour = C4::Context->preference("marcflavour")};
 506         unless($to_encoding) {$to_encoding = "UTF-8"};
 507
 508         # ISO-2709 Record (MARC21 or UNIMARC)
 509         if (lc($format) =~ /^marc$/o) {
 510                 # if we're converting encoding of an ISO2709 file, we need to roundtrip through XML
 511                 #       because MARC::Record doesn't directly provide us with an encoding method
 512                 #       It's definitely less than idea and should be fixed eventually - kados
 513                 my $marcxml; # temporary storage of MARCXML scalar
 514                 ($error,$marcxml) = marc2marcxml($record,$to_encoding,$flavour);
 515                 unless ($error) {
 516                         ($error,$newrecord) = marcxml2marc($marcxml,$to_encoding,$flavour);
 517                 }
 518
 519         # MARCXML Record
 520         } elsif (lc($format) =~ /^marcxml$/o) { # MARCXML Record
 521                 my $marc;
 522                 ($error,$marc) = marcxml2marc($record,$to_encoding,$flavour);
 523                 unless ($error) {
 524                         ($error,$newrecord) = marc2marcxml($record,$to_encoding,$flavour);
 525                 }
 526         } else {
 527                 $error.="Unsupported record format:".$format;
 528         }
 529         return ($error,$newrecord);
 530 }
 531
 532 =head1 INTERNAL FUNCTIONS
 533
 534 =head2 _entity_encode - Entity-encode an array of strings
 535
 536 =over 4
 537
 538 my ($entity_encoded_string) = _entity_encode($string);
 539
 540 or
 541
 542 my (@entity_encoded_strings) = _entity_encode(@strings);
 543
 544 Entity-encode an array of strings
 545
 546 =back
 547
 548 =cut
 549
 550 sub _entity_encode {
 551         my @strings = @_;
 552         my @strings_entity_encoded;
 553         foreach my $string (@strings) {
 554                 my $nfc_string = NFC($string);
 555                 $nfc_string =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
 556                 push @strings_entity_encoded, $nfc_string;
 557         }
 558         return @strings_entity_encoded;
 559 }
 560
 561 END { }       # module clean-up code here (global destructor)
 562 1;
 563 __END__
 564
 565 =head1 AUTHOR
 566
 567 Joshua Ferraro <jmf@liblime.com>
 568
 569 =head1 MODIFICATIONS
 570
 571 # $Id$
 572
 573 =cut