3 # Copyright 2006 (C) LibLime
4 # Joshua Ferraro <jmf@liblime.com>
6 # This file is part of Koha.
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
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.
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
22 use strict
;# use warnings; #FIXME: turn off warnings before release
24 # please specify in which methods a given module is used
25 use MARC
::Record
; # marc2marcxml, marcxml2marc, html2marc, changeEncoding
26 use MARC
::File
::XML
; # marc2marcxml, marcxml2marc, html2marcxml, changeEncoding
27 use MARC
::Crosswalk
::DublinCore
; # marc2dcxml
28 use Biblio
::EndnoteStyle
;
29 use Unicode
::Normalize
; # _entity_encode
33 use vars
qw($VERSION @ISA @EXPORT);
35 # set the version for version checking
40 # only export API methods
57 C4::Record - MARC, MARCXML, DC, MODS, XML, etc. Record Management Functions and API
61 New in Koha 3.x. This module handles all record-related management functions.
63 =head1 API (EXPORTED FUNCTIONS)
65 =head2 marc2marc - Convert from one flavour of ISO-2709 to another
69 my ($error,$newmarc) = marc2marc($marc,$to_flavour,$from_flavour,$encoding);
71 Returns an ISO-2709 scalar
78 my ($marc,$to_flavour,$from_flavour,$encoding) = @_;
79 my $error = "Feature not yet implemented\n";
80 return ($error,$marc);
83 =head2 marc2marcxml - Convert from ISO-2709 to MARCXML
87 my ($error,$marcxml) = marc2marcxml($marc,$encoding,$flavour);
89 Returns a MARCXML scalar
93 C<$marc> - an ISO-2709 scalar or MARC::Record object
95 C<$encoding> - UTF-8 or MARC-8 [UTF-8]
97 C<$flavour> - MARC21 or UNIMARC
99 C<$dont_entity_encode> - a flag that instructs marc2marcxml not to entity encode the xml before returning (optional)
108 my ($marc,$encoding,$flavour,$dont_entity_encode) = @_;
109 my $error; # the error string
110 my $marcxml; # the final MARCXML scalar
112 # test if it's already a MARC::Record object, if not, make it one
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
119 # conversion to MARC::Record object failed, populate $error
120 if ($@
) { $error .="\nCreation of MARC::Record object failed: ".$MARC::File
::ERROR
};
122 # only proceed if no errors so far
125 # check the record for warnings
126 my @warnings = $marc_record_obj->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 };
131 unless($encoding) {$encoding = "UTF-8"}; # set default encoding
132 unless($flavour) {$flavour = C4
::Context
->preference("marcflavour")}; # set default MARC flavour
134 # attempt to convert the record to MARCXML
135 eval { $marcxml = $marc_record_obj->as_xml_record($flavour) }; #handle exceptions
137 # record creation failed, populate $error
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" };
144 # record creation was successful
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();
150 warn "\nWarnings encountered while processing ISO-2709 record with title \"".$marc_record_obj->title()."\":\n";
151 foreach my $warn (@warnings) { warn "\t".$warn };
155 # only proceed if no errors so far
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;
165 # return result to calling program
166 return ($error,$marcxml);
169 =head2 marcxml2marc - Convert from MARCXML to ISO-2709
173 my ($error,$marc) = marcxml2marc($marcxml,$encoding,$flavour);
175 Returns an ISO-2709 scalar
179 C<$marcxml> - a MARCXML record
181 C<$encoding> - UTF-8 or MARC-8 [UTF-8]
183 C<$flavour> - MARC21 or UNIMARC
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
198 # attempt to do the conversion
199 eval { $marc = MARC
::Record
->new_from_xml($marcxml,$encoding,$flavour) }; # handle exceptions
201 # record creation failed, populate $error
202 if ($@
) {$error .="\nCreation of MARCXML Record failed: ".$@
;
203 $error.=$MARC::File
::ERROR
if ($MARC::File
::ERROR
);
205 # return result to calling program
206 return ($error,$marc);
209 =head2 marc2dcxml - Convert from ISO-2709 to Dublin Core
213 my ($error,$dcxml) = marc2dcxml($marc,$qualified);
215 Returns a DublinCore::Record object, will eventually return a Dublin Core scalar
217 FIXME: should return actual XML, not just an object
221 C<$marc> - an ISO-2709 scalar or MARC::Record object
223 C<$qualified> - specify whether qualified Dublin Core should be used in the input or output [0]
232 my ($marc,$qualified) = @_;
234 # test if it's already a MARC::Record object, if not, make it one
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
241 # conversion to MARC::Record object failed, populate $error
243 $error .="\nCreation of MARC::Record object failed: ".$MARC::File
::ERROR
;
246 my $crosswalk = MARC
::Crosswalk
::DublinCore
->new;
248 $crosswalk = MARC
::Crosswalk
::DublinCore
->new( qualified
=> 1 );
250 my $dcxml = $crosswalk->as_dublincore($marc_record_obj);
251 my $dcxmlfinal = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\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/\">";
259 foreach my $element ( $dcxml->elements() ) {
260 $dcxmlfinal.="<"."dc:".$element->name().">".$element->content()."</"."dc:".$element->name().">\n";
262 $dcxmlfinal .= "\n</metadata>";
263 return ($error,$dcxmlfinal);
265 =head2 marc2modsxml - Convert from ISO-2709 to MODS
269 my ($error,$modsxml) = marc2modsxml($marc);
271 Returns a MODS scalar
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('intrahtdocs')."/prog/en/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);
294 my $marc_rec_obj = MARC
::Record
->new_from_usmarc($marc);
295 my $f260 = $marc_rec_obj->field('260');
296 my $f260a = $f260->subfield('a') if $f260;
297 my $f710 = $marc_rec_obj->field('710');
298 my $f710a = $f710->subfield('a') if $f710;
299 my $f500 = $marc_rec_obj->field('500');
300 my $abstract = $f500->subfield('a') if $f500;
302 DB
=> C4
::Context
->preference("LibraryName"),
303 Title
=> $marc_rec_obj->title(),
304 Author
=> $marc_rec_obj->author(),
307 Year
=> $marc_rec_obj->publication_date,
308 Abstract
=> $abstract,
311 my $style = new Biblio
::EndnoteStyle
();
313 $template.= "DB - DB\n" if C4
::Context
->preference("LibraryName");
314 $template.="T1 - Title\n" if $marc_rec_obj->title();
315 $template.="A1 - Author\n" if $marc_rec_obj->author();
316 $template.="PB - Publisher\n" if $f710a;
317 $template.="CY - City\n" if $f260a;
318 $template.="Y1 - Year\n" if $marc_rec_obj->publication_date;
319 $template.="AB - Abstract\n" if $abstract;
320 my ($text, $errmsg) = $style->format($template, $fields);
330 my ($error,$marcxml) = html2marcxml($tags,$subfields,$values,$indicator,$ind_tag);
332 Returns a MARCXML scalar
334 this is used in addbiblio.pl and additem.pl to build the MARCXML record from
337 FIXME: this could use some better code documentation
344 my ($tags,$subfields,$values,$indicator,$ind_tag) = @_;
346 # add the header info
347 my $marcxml= MARC
::File
::XML
::header
(C4
::Context
->preference('TemplateEncoding'),C4
::Context
->preference('marcflavour'));
349 # some flags used to figure out where in the record we are
355 # handle characters that would cause the parser to choke FIXME: is there a more elegant solution?
356 for (my $i=0;$i<=@
$tags;$i++){
357 @
$values[$i] =~ s/&/&/g;
358 @
$values[$i] =~ s/</</g;
359 @
$values[$i] =~ s/>/>/g;
360 @
$values[$i] =~ s/"/"/g;
361 @
$values[$i] =~ s/'/'/g;
363 if ((@
$tags[$i] ne $prevtag)){
364 $j++ unless (@
$tags[$i] eq "");
365 #warn "IND:".substr(@$indicator[$j],0,1).substr(@$indicator[$j],1,1)." ".@$tags[$i];
367 $marcxml.="</datafield>\n";
368 if ((@
$tags[$i] > 10) && (@
$values[$i] ne "")){
369 my $ind1 = substr(@
$indicator[$j],0,1);
370 my $ind2 = substr(@
$indicator[$j],1,1);
371 $marcxml.="<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
372 $marcxml.="<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
378 if (@
$values[$i] ne "") {
380 if (@
$tags[$i] eq "000") {
381 $marcxml.="<leader>@$values[$i]</leader>\n";
383 # rest of the fixed fields
384 } elsif (@
$tags[$i] lt '010') { # don't compare numerically 010 == 8
385 $marcxml.="<controlfield tag=\"@$tags[$i]\">@$values[$i]</controlfield>\n";
388 my $ind1 = substr(@
$indicator[$j],0,1);
389 my $ind2 = substr(@
$indicator[$j],1,1);
390 $marcxml.="<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
391 $marcxml.="<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
396 } else { # @$tags[$i] eq $prevtag
397 if (@
$values[$i] eq "") {
400 my $ind1 = substr(@
$indicator[$j],0,1);
401 my $ind2 = substr(@
$indicator[$j],1,1);
402 $marcxml.="<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
405 $marcxml.="<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
408 $prevtag = @
$tags[$i];
410 $marcxml.= MARC
::File
::XML
::footer
();
412 return ($error,$marcxml);
419 Probably best to avoid using this ... it has some rather striking problems:
423 * saves blank subfields
425 * subfield order is hardcoded to always start with 'a' for repeatable tags (because it is hardcoded in the addfield routine).
427 * 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).
429 * the underlying routines didn't support subfield reordering or subfield repeatability.
433 I've left it in here because it could be useful if someone took the time to fix it. -- kados
440 my ($dbh,$rtags,$rsubfields,$rvalues,%indicators) = @_;
442 my $record = MARC
::Record
->new();
443 # my %subfieldlist=();
444 my $prevvalue; # if tag <10
445 my $field; # if tag >=10
446 for (my $i=0; $i< @
$rtags; $i++) {
447 # rebuild MARC::Record
448 # warn "0=>".@$rtags[$i].@$rsubfields[$i]." = ".@$rvalues[$i].": ";
449 if (@
$rtags[$i] ne $prevtag) {
452 if (($prevtag ne '000') && ($prevvalue ne "")) {
453 $record->add_fields((sprintf "%03s",$prevtag),$prevvalue);
454 } elsif ($prevvalue ne ""){
455 $record->leader($prevvalue);
459 if (($field) && ($field ne "")) {
460 $record->add_fields($field);
463 $indicators{@
$rtags[$i]}.=' ';
464 # skip blank tags, I hope this works
465 if (@
$rtags[$i] eq ''){
466 $prevtag = @
$rtags[$i];
470 if (@
$rtags[$i] <10) {
471 $prevvalue= @
$rvalues[$i];
475 if (@
$rvalues[$i] eq "") {
478 $field = MARC
::Field
->new( (sprintf "%03s",@
$rtags[$i]), substr($indicators{@
$rtags[$i]},0,1),substr($indicators{@
$rtags[$i]},1,1), @
$rsubfields[$i] => @
$rvalues[$i]);
480 # warn "1=>".@$rtags[$i].@$rsubfields[$i]." = ".@$rvalues[$i].": ".$field->as_formatted;
482 $prevtag = @
$rtags[$i];
484 if (@
$rtags[$i] <10) {
485 $prevvalue=@
$rvalues[$i];
487 if (length(@
$rvalues[$i])>0) {
488 $field->add_subfields(@
$rsubfields[$i] => @
$rvalues[$i]);
489 # warn "2=>".@$rtags[$i].@$rsubfields[$i]." = ".@$rvalues[$i].": ".$field->as_formatted;
492 $prevtag= @
$rtags[$i];
496 # the last has not been included inside the loop... do it now !
498 #warn Dumper($field->{_subfields});
499 $record->add_fields($field) if (($field) && $field ne "");
500 #warn "HTML2MARC=".$record->as_formatted;
504 =head2 changeEncoding - Change the encoding of a record
508 my ($error, $newrecord) = changeEncoding($record,$format,$flavour,$to_encoding,$from_encoding);
510 Changes the encoding of a record
514 C<$record> - the record itself can be in ISO-2709, a MARC::Record object, or MARCXML for now (required)
516 C<$format> - MARC or MARCXML (required)
518 C<$flavour> - MARC21 or UNIMARC, if MARC21, it will change the leader (optional) [defaults to Koha system preference]
520 C<$to_encoding> - the encoding you want the record to end up in (optional) [UTF-8]
522 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)
526 FIXME: the from_encoding doesn't work yet
528 FIXME: better handling for UNIMARC, it should allow management of 100 field
530 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
537 my ($record,$format,$flavour,$to_encoding,$from_encoding) = @_;
540 unless($flavour) {$flavour = C4
::Context
->preference("marcflavour")};
541 unless($to_encoding) {$to_encoding = "UTF-8"};
543 # ISO-2709 Record (MARC21 or UNIMARC)
544 if (lc($format) =~ /^marc$/o) {
545 # if we're converting encoding of an ISO2709 file, we need to roundtrip through XML
546 # because MARC::Record doesn't directly provide us with an encoding method
547 # It's definitely less than idea and should be fixed eventually - kados
548 my $marcxml; # temporary storage of MARCXML scalar
549 ($error,$marcxml) = marc2marcxml
($record,$to_encoding,$flavour);
551 ($error,$newrecord) = marcxml2marc
($marcxml,$to_encoding,$flavour);
555 } elsif (lc($format) =~ /^marcxml$/o) { # MARCXML Record
557 ($error,$marc) = marcxml2marc
($record,$to_encoding,$flavour);
559 ($error,$newrecord) = marc2marcxml
($record,$to_encoding,$flavour);
562 $error.="Unsupported record format:".$format;
564 return ($error,$newrecord);
567 =head1 INTERNAL FUNCTIONS
569 =head2 _entity_encode - Entity-encode an array of strings
573 my ($entity_encoded_string) = _entity_encode($string);
577 my (@entity_encoded_strings) = _entity_encode(@strings);
579 Entity-encode an array of strings
587 my @strings_entity_encoded;
588 foreach my $string (@strings) {
589 my $nfc_string = NFC
($string);
590 $nfc_string =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
591 push @strings_entity_encoded, $nfc_string;
593 return @strings_entity_encoded;
596 END { } # module clean-up code here (global destructor)
602 Joshua Ferraro <jmf@liblime.com>