C4/Record.pm

   1 package C4::Record;
   2 #
   3 # Copyright 2006 (C) LibLime
   4 # Parts copyright 2010 BibLibre
   5 # Part copyright 2015 Universidad de El Salvador
   6 #
   7 # This file is part of Koha.
   8 #
   9 # Koha is free software; you can redistribute it and/or modify it
  10 # under the terms of the GNU General Public License as published by
  11 # the Free Software Foundation; either version 3 of the License, or
  12 # (at your option) any later version.
  13 #
  14 # Koha is distributed in the hope that it will be useful, but
  15 # WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17 # GNU General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU General Public License
  20 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  21
  22 use Modern::Perl;
  23
  24 # please specify in which methods a given module is used
  25 use MARC::Record; # marc2marcxml, marcxml2marc, changeEncoding
  26 use MARC::File::XML; # marc2marcxml, marcxml2marc, changeEncoding
  27 use Biblio::EndnoteStyle;
  28 use Unicode::Normalize qw( NFC ); # _entity_encode
  29 use C4::Biblio qw( GetFrameworkCode );
  30 use C4::Koha; #marc2csv
  31 use C4::XSLT;
  32 use YAML::XS; #marcrecords2csv
  33 use Encode;
  34 use Template;
  35 use Text::CSV::Encoded; #marc2csv
  36 use Koha::Items;
  37 use Koha::SimpleMARC qw( read_field );
  38 use Koha::XSLT::Base;
  39 use Koha::CsvProfiles;
  40 use Koha::AuthorisedValues;
  41 use Carp qw( carp croak );
  42
  43 use vars qw(@ISA @EXPORT);
  44
  45
  46 @ISA = qw(Exporter);
  47
  48 # only export API methods
  49
  50 @EXPORT = qw(
  51   marc2endnote
  52   marc2marc
  53   marc2marcxml
  54   marcxml2marc
  55   marc2dcxml
  56   marc2modsxml
  57   marc2madsxml
  58   marc2bibtex
  59   marc2csv
  60   marcrecord2csv
  61   changeEncoding
  62 );
  63
  64 =head1 NAME
  65
  66 C4::Record - MARC, MARCXML, DC, MODS, XML, etc. Record Management Functions and API
  67
  68 =head1 SYNOPSIS
  69
  70 New in Koha 3.x. This module handles all record-related management functions.
  71
  72 =head1 API (EXPORTED FUNCTIONS)
  73
  74 =head2 marc2marc - Convert from one flavour of ISO-2709 to another
  75
  76   my ($error,$newmarc) = marc2marc($marc,$to_flavour,$from_flavour,$encoding);
  77
  78 Returns an ISO-2709 scalar
  79
  80 =cut
  81
  82 sub marc2marc {
  83         my ($marc,$to_flavour,$from_flavour,$encoding) = @_;
  84         my $error;
  85     if ($to_flavour && $to_flavour =~ m/marcstd/) {
  86         my $marc_record_obj;
  87         if ($marc =~ /^MARC::Record/) { # it's already a MARC::Record object
  88             $marc_record_obj = $marc;
  89         } else { # it's not a MARC::Record object, make it one
  90             eval { $marc_record_obj = MARC::Record->new_from_usmarc($marc) }; # handle exceptions
  91
  92 # conversion to MARC::Record object failed, populate $error
  93                 if ($@) { $error .="\nCreation of MARC::Record object failed: ".$MARC::File::ERROR };
  94         }
  95         unless ($error) {
  96             my @privatefields;
  97             foreach my $field ($marc_record_obj->fields()) {
  98                 if ($field->tag() =~ m/9/ && ($field->tag() != '490' || C4::Context->preference("marcflavour") eq 'UNIMARC')) {
  99                     push @privatefields, $field;
 100                 } elsif (! ($field->is_control_field())) {
 101                     $field->delete_subfield(code => '9') if ($field->subfield('9'));
 102                 }
 103             }
 104             $marc_record_obj->delete_field($_) for @privatefields;
 105             $marc = $marc_record_obj->as_usmarc();
 106         }
 107     } else {
 108         $error = "Feature not yet implemented\n";
 109     }
 110         return ($error,$marc);
 111 }
 112
 113 =head2 marc2marcxml - Convert from ISO-2709 to MARCXML
 114
 115   my ($error,$marcxml) = marc2marcxml($marc,$encoding,$flavour);
 116
 117 Returns a MARCXML scalar
 118
 119 C<$marc> - an ISO-2709 scalar or MARC::Record object
 120
 121 C<$encoding> - UTF-8 or MARC-8 [UTF-8]
 122
 123 C<$flavour> - MARC21 or UNIMARC
 124
 125 C<$dont_entity_encode> - a flag that instructs marc2marcxml not to entity encode the xml before returning (optional)
 126
 127 =cut
 128
 129 sub marc2marcxml {
 130         my ($marc,$encoding,$flavour,$dont_entity_encode) = @_;
 131         my $error; # the error string
 132         my $marcxml; # the final MARCXML scalar
 133
 134         # test if it's already a MARC::Record object, if not, make it one
 135         my $marc_record_obj;
 136         if ($marc =~ /^MARC::Record/) { # it's already a MARC::Record object
 137                 $marc_record_obj = $marc;
 138         } else { # it's not a MARC::Record object, make it one
 139                 eval { $marc_record_obj = MARC::Record->new_from_usmarc($marc) }; # handle exceptions
 140
 141                 # conversion to MARC::Record object failed, populate $error
 142                 if ($@) { $error .="\nCreation of MARC::Record object failed: ".$MARC::File::ERROR };
 143         }
 144         # only proceed if no errors so far
 145         unless ($error) {
 146
 147                 # check the record for warnings
 148                 my @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                 unless($encoding) {$encoding = "UTF-8"}; # set default encoding
 154                 unless($flavour) {$flavour = C4::Context->preference("marcflavour")}; # set default MARC flavour
 155
 156                 # attempt to convert the record to MARCXML
 157                 eval { $marcxml = $marc_record_obj->as_xml_record($flavour) }; #handle exceptions
 158
 159                 # record creation failed, populate $error
 160                 if ($@) {
 161                         $error .= "Creation of MARCXML failed:".$MARC::File::ERROR;
 162                         $error .= "Additional information:\n";
 163                         my @warnings = $@->warnings();
 164                         foreach my $warn (@warnings) { $error.=$warn."\n" };
 165
 166                 # record creation was successful
 167         } else {
 168
 169                         # check the record for warning flags again (warnings() will be cleared already if there was an error, see above block
 170                         @warnings = $marc_record_obj->warnings();
 171                         if (@warnings) {
 172                                 warn "\nWarnings encountered while processing ISO-2709 record with title \"".$marc_record_obj->title()."\":\n";
 173                                 foreach my $warn (@warnings) { warn "\t".$warn };
 174                         }
 175                 }
 176
 177                 # only proceed if no errors so far
 178                 unless ($error) {
 179
 180                         # entity encode the XML unless instructed not to
 181                 unless ($dont_entity_encode) {
 182                         my ($marcxml_entity_encoded) = _entity_encode($marcxml);
 183                         $marcxml = $marcxml_entity_encoded;
 184                 }
 185                 }
 186         }
 187         # return result to calling program
 188         return ($error,$marcxml);
 189 }
 190
 191 =head2 marcxml2marc - Convert from MARCXML to ISO-2709
 192
 193   my ($error,$marc) = marcxml2marc($marcxml,$encoding,$flavour);
 194
 195 Returns an ISO-2709 scalar
 196
 197 C<$marcxml> - a MARCXML record
 198
 199 C<$encoding> - UTF-8 or MARC-8 [UTF-8]
 200
 201 C<$flavour> - MARC21 or UNIMARC
 202
 203 =cut
 204
 205 sub marcxml2marc {
 206     my ($marcxml,$encoding,$flavour) = @_;
 207         my $error; # the error string
 208         my $marc; # the final ISO-2709 scalar
 209         unless($encoding) {$encoding = "UTF-8"}; # set the default encoding
 210         unless($flavour) {$flavour = C4::Context->preference("marcflavour")}; # set the default MARC flavour
 211
 212         # attempt to do the conversion
 213         eval { $marc = MARC::Record->new_from_xml($marcxml,$encoding,$flavour) }; # handle exceptions
 214
 215         # record creation failed, populate $error
 216         if ($@) {$error .="\nCreation of MARCXML Record failed: ".$@;
 217                 $error.=$MARC::File::ERROR if ($MARC::File::ERROR);
 218                 };
 219         # return result to calling program
 220         return ($error,$marc);
 221 }
 222
 223 =head2 marc2dcxml - Convert from ISO-2709 to Dublin Core
 224
 225     my dcxml = marc2dcxml ($marc, $xml, $biblionumber, $format);
 226
 227 EXAMPLE
 228
 229     my dcxml = marc2dcxml (undef, undef, 1, "oaidc");
 230
 231 Convert MARC or MARCXML to Dublin Core metadata (XSLT Transformation),
 232 optionally can get an XML directly from biblio_metadata
 233 without item information. This method take into consideration the syspref
 234 'marcflavour' (UNIMARC or MARC21).
 235 Return an XML file with the format defined in C<$format>
 236
 237 C<$marc> - an ISO-2709 scalar or MARC::Record object
 238
 239 C<$xml> - a MARCXML file
 240
 241 C<$biblionumber> - biblionumber for database access
 242
 243 C<$format> - accept three type of DC formats (oaidc, srwdc, and rdfdc )
 244
 245 =cut
 246
 247 sub marc2dcxml {
 248     my ( $marc, $xml, $biblionumber, $format ) = @_;
 249
 250     # global variables
 251     my ( $marcxml, $record, $output );
 252
 253     # set the default path for intranet xslts
 254     # differents xslts to process (OAIDC, SRWDC and RDFDC)
 255     my $xsl = C4::Context->config('intrahtdocs') . '/prog/en/xslt/' .
 256               C4::Context->preference('marcflavour') . 'slim2' . uc ( $format ) . '.xsl';
 257
 258     if ( defined $marc ) {
 259         # no need to catch errors or warnings marc2marcxml do it instead
 260         $marcxml = C4::Record::marc2marcxml( $marc );
 261     } elsif ( not defined $xml and defined $biblionumber ) {
 262         # get MARCXML biblio directly without item information
 263         $marcxml = C4::Biblio::GetXmlBiblio( $biblionumber );
 264     } else {
 265         $marcxml = $xml;
 266     }
 267
 268     eval { $record = MARC::Record->new_from_xml(
 269                      $marcxml,
 270                      'UTF-8',
 271                      C4::Context->preference('marcflavour')
 272            );
 273     };
 274
 275     # conversion to MARC::Record object failed
 276     if ( $@ ) {
 277         croak "Creation of MARC::Record object failed.";
 278     } elsif ( $record->warnings() ) {
 279         carp "Warnings encountered while processing ISO-2709 record.\n";
 280         my @warnings = $record->warnings();
 281         foreach my $warn (@warnings) {
 282             carp "\t". $warn;
 283         };
 284     } elsif ( $record =~ /^MARC::Record/ ) { # if OK makes xslt transformation
 285         my $xslt_engine = Koha::XSLT::Base->new;
 286         if ( $format =~ /^(dc|oaidc|srwdc|rdfdc)$/i ) {
 287             $output = $xslt_engine->transform( $marcxml, $xsl );
 288         } else {
 289             croak "The format argument ($format) not accepted.\n" .
 290                   "Please pass a valid format (oaidc, srwdc, or rdfdc)\n";
 291         }
 292         my $err = $xslt_engine->err; # error code
 293         if ( $err ) {
 294             croak "Error $err while processing\n";
 295         } else {
 296             return $output;
 297         }
 298     }
 299 }
 300
 301 =head2 marc2modsxml - Convert from ISO-2709 to MODS
 302
 303   my $modsxml = marc2modsxml($marc);
 304
 305 Returns a MODS scalar
 306
 307 =cut
 308
 309 sub marc2modsxml {
 310     my ($marc) = @_;
 311     return _transformWithStylesheet($marc, "/prog/en/xslt/MARC21slim2MODS3-1.xsl");
 312 }
 313
 314 =head2 marc2madsxml - Convert from ISO-2709 to MADS
 315
 316   my $madsxml = marc2madsxml($marc);
 317
 318 Returns a MADS scalar
 319
 320 =cut
 321
 322 sub marc2madsxml {
 323     my ($marc) = @_;
 324     return _transformWithStylesheet($marc, "/prog/en/xslt/MARC21slim2MADS.xsl");
 325 }
 326
 327 =head2 _transformWithStylesheet - Transform a MARC record with a stylesheet
 328
 329     my $xml = _transformWithStylesheet($marc, $stylesheet)
 330
 331 Returns the XML scalar result of the transformation. $stylesheet should
 332 contain the path to a stylesheet under intrahtdocs.
 333
 334 =cut
 335
 336 sub _transformWithStylesheet {
 337     my ($marc, $stylesheet) = @_;
 338     # grab the XML, run it through our stylesheet, push it out to the browser
 339     my $xmlrecord = marc2marcxml($marc);
 340     my $xslfile = C4::Context->config('intrahtdocs') . $stylesheet;
 341     return C4::XSLT::engine->transform($xmlrecord, $xslfile);
 342 }
 343
 344 sub marc2endnote {
 345     my ($marc) = @_;
 346         my $marc_rec_obj =  MARC::Record->new_from_usmarc($marc);
 347     my ( $abstract, $f260a, $f710a );
 348     my $f260 = $marc_rec_obj->field('260');
 349     if ($f260) {
 350         $f260a = $f260->subfield('a') if $f260;
 351     }
 352     my $f710 = $marc_rec_obj->field('710');
 353     if ($f710) {
 354         $f710a = $f710->subfield('a');
 355     }
 356     my $f500 = $marc_rec_obj->field('500');
 357     if ($f500) {
 358         $abstract = $f500->subfield('a');
 359     }
 360     my $fields = {
 361         DB => C4::Context->preference("LibraryName"),
 362         Title => $marc_rec_obj->title(),
 363         Author => $marc_rec_obj->author(),
 364         Publisher => $f710a,
 365         City => $f260a,
 366         Year => $marc_rec_obj->publication_date,
 367         Abstract => $abstract,
 368     };
 369     my $style = Biblio::EndnoteStyle->new();
 370     my $template;
 371     $template.= "DB - DB\n" if C4::Context->preference("LibraryName");
 372     $template.="T1 - Title\n" if $marc_rec_obj->title();
 373     $template.="A1 - Author\n" if $marc_rec_obj->author();
 374     $template.="PB - Publisher\n" if  $f710a;
 375     $template.="CY - City\n" if $f260a;
 376     $template.="Y1 - Year\n" if $marc_rec_obj->publication_date;
 377     $template.="AB - Abstract\n" if $abstract;
 378     my ($text, $errmsg) = $style->format($template, $fields);
 379     return ($text);
 380
 381 }
 382
 383 =head2 marc2csv - Convert several records from UNIMARC to CSV
 384
 385   my ($csv) = marc2csv($biblios, $csvprofileid, $itemnumbers);
 386
 387 Pre and postprocessing can be done through a YAML file
 388
 389 Returns a CSV scalar
 390
 391 C<$biblio> - a list of biblionumbers
 392
 393 C<$csvprofileid> - the id of the CSV profile to use for the export (see export_format.export_format_id)
 394
 395 C<$itemnumbers> - a list of itemnumbers to export
 396
 397 =cut
 398
 399 sub marc2csv {
 400     my ($biblios, $id, $itemnumbers) = @_;
 401     $itemnumbers ||= [];
 402     my $output;
 403     my $csv = Text::CSV::Encoded->new();
 404
 405     # Getting yaml file
 406     my $configfile = "../tools/csv-profiles/$id.yaml";
 407     my ($preprocess, $postprocess, $fieldprocessing);
 408     if (-e $configfile){
 409         ($preprocess,$postprocess, $fieldprocessing) = YAML::XS::LoadFile($configfile);
 410     }
 411
 412     # Preprocessing
 413     eval $preprocess if ($preprocess); ## no critic (StringyEval)
 414
 415     my $firstpass = 1;
 416     if ( @$itemnumbers ) {
 417         for my $itemnumber ( @$itemnumbers) {
 418             my $item = Koha::Items->find( $itemnumber );
 419             my $biblionumber = $item->biblio->biblionumber;
 420             $output .= marcrecord2csv( $biblionumber, $id, $firstpass, $csv, $fieldprocessing, [$itemnumber] ) // '';
 421             $firstpass = 0;
 422         }
 423     } else {
 424         foreach my $biblio (@$biblios) {
 425             $output .= marcrecord2csv( $biblio, $id, $firstpass, $csv, $fieldprocessing ) // '';
 426             $firstpass = 0;
 427         }
 428     }
 429
 430     # Postprocessing
 431     eval $postprocess if ($postprocess); ## no critic (StringyEval)
 432
 433     return $output;
 434 }
 435
 436 =head2 marcrecord2csv - Convert a single record from UNIMARC to CSV
 437
 438   my ($csv) = marcrecord2csv($biblio, $csvprofileid, $header);
 439
 440 Returns a CSV scalar
 441
 442 C<$biblio> - a biblionumber
 443
 444 C<$csvprofileid> - the id of the CSV profile to use for the export (see export_format.export_format_id)
 445
 446 C<$header> - true if the headers are to be printed (typically at first pass)
 447
 448 C<$csv> - an already initialised Text::CSV object
 449
 450 C<$fieldprocessing>
 451
 452 C<$itemnumbers> a list of itemnumbers to export
 453
 454 =cut
 455
 456 sub marcrecord2csv {
 457     my ($biblionumber, $id, $header, $csv, $fieldprocessing, $itemnumbers) = @_;
 458     my $output;
 459
 460     # Getting the record
 461     my $biblio = Koha::Biblios->find($biblionumber);
 462     return unless $biblio;
 463     my $record = eval {
 464         $biblio->metadata->record(
 465             { embed_items => 1, itemnumbers => $itemnumbers } );
 466     };
 467     return unless $record;
 468     # Getting the framework
 469     my $frameworkcode = $biblio->frameworkcode;
 470
 471     # Getting information about the csv profile
 472     my $profile = Koha::CsvProfiles->find($id);
 473
 474     # Getting output encoding
 475     my $encoding          = $profile->encoding || 'utf8';
 476     # Getting separators
 477     my $csvseparator      = $profile->csv_separator      || ',';
 478     my $fieldseparator    = $profile->field_separator    || '#';
 479     my $subfieldseparator = $profile->subfield_separator || '|';
 480
 481     # TODO: Be more generic (in case we have to handle other protected chars or more separators)
 482     if ($csvseparator eq '\t') { $csvseparator = "\t" }
 483     if ($fieldseparator eq '\t') { $fieldseparator = "\t" }
 484     if ($subfieldseparator eq '\t') { $subfieldseparator = "\t" }
 485     if ($csvseparator eq '\n') { $csvseparator = "\n" }
 486     if ($fieldseparator eq '\n') { $fieldseparator = "\n" }
 487     if ($subfieldseparator eq '\n') { $subfieldseparator = "\n" }
 488
 489     $csv = $csv->encoding_out($encoding) ;
 490     $csv->sep_char($csvseparator);
 491
 492     # Getting the marcfields
 493     my $marcfieldslist = $profile->content;
 494
 495     # Getting the marcfields as an array
 496     my @marcfieldsarray = split('\|', $marcfieldslist);
 497
 498    # Separating the marcfields from the user-supplied headers
 499     my @csv_structures;
 500     foreach (@marcfieldsarray) {
 501         my @result = split('=', $_, 2);
 502         my $content = ( @result == 2 )
 503             ? $result[1]
 504             : $result[0];
 505         my @fields;
 506         while ( $content =~ m|(\d{3})\$?(.)?|g ) {
 507             my $fieldtag = $1;
 508             my $subfieldtag = $2;
 509             push @fields, { fieldtag => $fieldtag, subfieldtag => $subfieldtag };
 510         }
 511         if ( @result == 2) {
 512            push @csv_structures, { header => $result[0], content => $content, fields => \@fields };
 513         } else {
 514            push @csv_structures, { content => $content, fields => \@fields }
 515         }
 516     }
 517
 518     my ( @marcfieldsheaders, @csv_rows );
 519     my $dbh = C4::Context->dbh;
 520
 521     my $field_list;
 522     for my $field ( $record->fields ) {
 523         my $fieldtag = $field->tag;
 524         my $values;
 525         if ( $field->is_control_field ) {
 526             $values = $field->data();
 527         } else {
 528             $values->{indicator}{1} = $field->indicator(1);
 529             $values->{indicator}{2} = $field->indicator(2);
 530             for my $subfield ( $field->subfields ) {
 531                 my $subfieldtag = $subfield->[0];
 532                 my $value = $subfield->[1];
 533                 push @{ $values->{$subfieldtag} }, $value;
 534             }
 535         }
 536         # We force the key as an integer (trick for 00X and OXX fields)
 537         push @{ $field_list->{fields}{0+$fieldtag} }, $values;
 538     }
 539
 540     # For each field or subfield
 541     foreach my $csv_structure (@csv_structures) {
 542         my @field_values;
 543         my $tags = $csv_structure->{fields};
 544         my $content = $csv_structure->{content};
 545
 546         if ( $header ) {
 547             # If we have a user-supplied header, we use it
 548             if ( exists $csv_structure->{header} ) {
 549                 push @marcfieldsheaders, $csv_structure->{header};
 550             } else {
 551                 # If not, we get the matching tag name from koha
 552                 my $tag = $tags->[0];
 553                 if (defined $tag->{subfieldtag} ) {
 554                     my $query = "SELECT liblibrarian FROM marc_subfield_structure WHERE tagfield=? AND tagsubfield=?";
 555                     my @results = $dbh->selectrow_array( $query, {}, $tag->{fieldtag}, $tag->{subfieldtag} );
 556                     push @marcfieldsheaders, $results[0];
 557                 } else {
 558                     my $query = "SELECT liblibrarian FROM marc_tag_structure WHERE tagfield=?";
 559                     my @results = $dbh->selectrow_array( $query, {}, $tag->{fieldtag} );
 560                     push @marcfieldsheaders, $results[0];
 561                 }
 562             }
 563         }
 564
 565         # TT tags exist
 566         if ( $content =~ m|\[\%.*\%\]| ) {
 567             my $tt = Template->new();
 568             my $template = $content;
 569             # Replace 00X and 0XX with X or XX
 570             $content =~ s|fields.00(\d)|fields.$1|g;
 571             $content =~ s|fields.0(\d{2})|fields.$1|g;
 572             my $tt_output;
 573             $tt->process( \$content, $field_list, \$tt_output );
 574             push @csv_rows, $tt_output;
 575         } else {
 576             for my $tag ( @$tags ) {
 577                 my @fields = $record->field( $tag->{fieldtag} );
 578                 # If it is a subfield
 579                 my @loop_values;
 580                 if (defined $tag->{subfieldtag} ) {
 581                     my $av = Koha::AuthorisedValues->search_by_marc_field({ frameworkcode => $frameworkcode, tagfield => $tag->{fieldtag}, tagsubfield => $tag->{subfieldtag}, });
 582                     $av = $av->count ? $av->unblessed : [];
 583                     my $av_description_mapping = { map { ( $_->{authorised_value} => $_->{lib} ) } @$av };
 584                     # For each field
 585                     foreach my $field (@fields) {
 586                         my @subfields = $field->subfield( $tag->{subfieldtag} );
 587                         foreach my $subfield (@subfields) {
 588                             push @loop_values, (defined $av_description_mapping->{$subfield}) ? $av_description_mapping->{$subfield} : $subfield;
 589                         }
 590                     }
 591
 592                 # Or a field
 593                 } else {
 594                     my $av = Koha::AuthorisedValues->search_by_marc_field({ frameworkcode => $frameworkcode, tagfield => $tag->{fieldtag}, });
 595                     $av = $av->count ? $av->unblessed : [];
 596                     my $authvalues = { map { ( $_->{authorised_value} => $_->{lib} ) } @$av };
 597
 598                     foreach my $field ( @fields ) {
 599                         my $value;
 600
 601                         # If it is a control field
 602                         if ($field->is_control_field) {
 603                             $value = defined $authvalues->{$field->as_string} ? $authvalues->{$field->as_string} : $field->as_string;
 604                         } else {
 605                             # If it is a field, we gather all subfields, joined by the subfield separator
 606                             my @subvaluesarray;
 607                             my @subfields = $field->subfields;
 608                             foreach my $subfield (@subfields) {
 609                                 push (@subvaluesarray, defined $authvalues->{$subfield->[1]} ? $authvalues->{$subfield->[1]} : $subfield->[1]);
 610                             }
 611                             $value = join ($subfieldseparator, @subvaluesarray);
 612                         }
 613
 614                         # Field processing
 615                         my $marcfield = $tag->{fieldtag}; # This line fixes a retrocompatibility concern
 616                                                           # The "processing" could be based on the $marcfield variable.
 617                         eval $fieldprocessing if ($fieldprocessing); ## no critic (StringyEval)
 618
 619                         push @loop_values, $value;
 620                     }
 621
 622                 }
 623                 push @field_values, {
 624                     fieldtag => $tag->{fieldtag},
 625                     subfieldtag => $tag->{subfieldtag},
 626                     values => \@loop_values,
 627                 };
 628             }
 629             for my $field_value ( @field_values ) {
 630                 if ( $field_value->{subfieldtag} ) {
 631                     push @csv_rows, join( $subfieldseparator, @{ $field_value->{values} } );
 632                 } else {
 633                     push @csv_rows, join( $fieldseparator, @{ $field_value->{values} } );
 634                 }
 635             }
 636         }
 637     }
 638
 639
 640     if ( $header ) {
 641         $csv->combine(@marcfieldsheaders);
 642         $output = $csv->string() . "\n";
 643     }
 644     $csv->combine(@csv_rows);
 645     $output .= $csv->string() . "\n";
 646
 647     return $output;
 648
 649 }
 650
 651
 652 =head2 changeEncoding - Change the encoding of a record
 653
 654   my ($error, $newrecord) = changeEncoding($record,$format,$flavour,$to_encoding,$from_encoding);
 655
 656 Changes the encoding of a record
 657
 658 C<$record> - the record itself can be in ISO-2709, a MARC::Record object, or MARCXML for now (required)
 659
 660 C<$format> - MARC or MARCXML (required)
 661
 662 C<$flavour> - MARC21 or UNIMARC, if MARC21, it will change the leader (optional) [defaults to Koha system preference]
 663
 664 C<$to_encoding> - the encoding you want the record to end up in (optional) [UTF-8]
 665
 666 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)
 667
 668 FIXME: the from_encoding doesn't work yet
 669
 670 FIXME: better handling for UNIMARC, it should allow management of 100 field
 671
 672 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
 673
 674 =cut
 675
 676 sub changeEncoding {
 677         my ($record,$format,$flavour,$to_encoding,$from_encoding) = @_;
 678         my $newrecord;
 679         my $error;
 680         unless($flavour) {$flavour = C4::Context->preference("marcflavour")};
 681         unless($to_encoding) {$to_encoding = "UTF-8"};
 682
 683         # ISO-2709 Record (MARC21 or UNIMARC)
 684         if (lc($format) =~ /^marc$/o) {
 685                 # if we're converting encoding of an ISO2709 file, we need to roundtrip through XML
 686                 #       because MARC::Record doesn't directly provide us with an encoding method
 687                 #       It's definitely less than idea and should be fixed eventually - kados
 688                 my $marcxml; # temporary storage of MARCXML scalar
 689                 ($error,$marcxml) = marc2marcxml($record,$to_encoding,$flavour);
 690                 unless ($error) {
 691                         ($error,$newrecord) = marcxml2marc($marcxml,$to_encoding,$flavour);
 692                 }
 693
 694         # MARCXML Record
 695         } elsif (lc($format) =~ /^marcxml$/o) { # MARCXML Record
 696                 my $marc;
 697                 ($error,$marc) = marcxml2marc($record,$to_encoding,$flavour);
 698                 unless ($error) {
 699                         ($error,$newrecord) = marc2marcxml($record,$to_encoding,$flavour);
 700                 }
 701         } else {
 702                 $error.="Unsupported record format:".$format;
 703         }
 704         return ($error,$newrecord);
 705 }
 706
 707 =head2 marc2bibtex - Convert from MARC21 and UNIMARC to BibTex
 708
 709   my ($bibtex) = marc2bibtex($record, $id);
 710
 711 Returns a BibTex scalar
 712
 713 C<$record> - a MARC::Record object
 714
 715 C<$id> - an id for the BibTex record (might be the biblionumber)
 716
 717 =cut
 718
 719
 720 sub marc2bibtex {
 721     my ($record, $id) = @_;
 722     my $tex;
 723     my $marcflavour = C4::Context->preference("marcflavour");
 724
 725     # Authors
 726     my $author;
 727     my @texauthors;
 728     my @authorFields = ('100','110','111','700','710','711');
 729     @authorFields = ('700','701','702','710','711','721') if ( $marcflavour eq "UNIMARC" );
 730
 731     foreach my $field ( @authorFields ) {
 732         # author formatted surname, firstname
 733         my $texauthor = '';
 734         if ( $marcflavour eq "UNIMARC" ) {
 735            $texauthor = join ', ',
 736            ( $record->subfield($field,"a"), $record->subfield($field,"b") );
 737        } else {
 738            $texauthor = $record->subfield($field,"a");
 739        }
 740        push @texauthors, $texauthor if $texauthor;
 741     }
 742     $author = join ' and ', @texauthors;
 743
 744     # Defining the conversion array according to the marcflavour
 745     my @bh;
 746     if ( $marcflavour eq "UNIMARC" ) {
 747
 748         # FIXME, TODO : handle repeatable fields
 749         # TODO : handle more types of documents
 750
 751         # Unimarc to bibtex array
 752         @bh = (
 753
 754             # Mandatory
 755             author    => $author,
 756             title     => $record->subfield("200", "a") || "",
 757             editor    => $record->subfield("210", "g") || "",
 758             publisher => $record->subfield("210", "c") || "",
 759             year      => $record->subfield("210", "d") || $record->subfield("210", "h") || "",
 760
 761             # Optional
 762             volume  =>  $record->subfield("200", "v") || "",
 763             series  =>  $record->subfield("225", "a") || "",
 764             address =>  $record->subfield("210", "a") || "",
 765             edition =>  $record->subfield("205", "a") || "",
 766             note    =>  $record->subfield("300", "a") || "",
 767             url     =>  $record->subfield("856", "u") || ""
 768         );
 769     } else {
 770
 771         # Marc21 to bibtex array
 772         @bh = (
 773
 774             # Mandatory
 775             author    => $author,
 776             title     => $record->subfield("245", "a") || "",
 777             editor    => $record->subfield("260", "f") || "",
 778             publisher => $record->subfield("264", "b") || $record->subfield("260", "b") || "",
 779             year      => $record->subfield("264", "c") || $record->subfield("260", "c") || $record->subfield("260", "g") || "",
 780
 781             # Optional
 782             # unimarc to marc21 specification says not to convert 200$v to marc21
 783             series  =>  $record->subfield("490", "a") || "",
 784             address =>  $record->subfield("264", "a") || $record->subfield("260", "a") || "",
 785             edition =>  $record->subfield("250", "a") || "",
 786             note    =>  $record->subfield("500", "a") || "",
 787             url     =>  $record->subfield("856", "u") || ""
 788         );
 789     }
 790
 791     my $BibtexExportAdditionalFields = C4::Context->preference('BibtexExportAdditionalFields');
 792     my $additional_fields;
 793     if ($BibtexExportAdditionalFields) {
 794         $BibtexExportAdditionalFields = "$BibtexExportAdditionalFields\n\n";
 795         $additional_fields = eval { YAML::XS::Load(Encode::encode_utf8($BibtexExportAdditionalFields)); };
 796         if ($@) {
 797             warn "Unable to parse BibtexExportAdditionalFields : $@";
 798             $additional_fields = undef;
 799         }
 800     }
 801
 802     if ( $additional_fields && $additional_fields->{'@'} ) {
 803         my ( $f, $sf ) = split( /\$/, $additional_fields->{'@'} );
 804         my ( $type ) = read_field( { record => $record, field => $f, subfield => $sf, field_numbers => [1] } );
 805
 806         if ($type) {
 807             $tex .= '@' . $type . '{';
 808         }
 809         else {
 810             $tex .= "\@book{";
 811         }
 812     }
 813     else {
 814         $tex .= "\@book{";
 815     }
 816
 817     my @elt;
 818     for ( my $i = 0 ; $i < scalar( @bh ) ; $i = $i + 2 ) {
 819         next unless $bh[$i+1];
 820         push @elt, qq|\t$bh[$i] = {$bh[$i+1]}|;
 821     }
 822     $tex .= join(",\n", $id, @elt);
 823
 824     if ($additional_fields) {
 825         $tex .= ",\n";
 826         foreach my $bibtex_tag ( keys %$additional_fields ) {
 827             next if $bibtex_tag eq '@';
 828
 829             my @fields =
 830               ref( $additional_fields->{$bibtex_tag} ) eq 'ARRAY'
 831               ? @{ $additional_fields->{$bibtex_tag} }
 832               : $additional_fields->{$bibtex_tag};
 833
 834             for my $tag (@fields) {
 835                 my ( $f, $sf ) = split( /\$/, $tag );
 836                 my @values = read_field( { record => $record, field => $f, subfield => $sf } );
 837                 foreach my $v (@values) {
 838                     $tex .= qq(\t$bibtex_tag = {$v}\n);
 839                 }
 840             }
 841         }
 842     }
 843     else {
 844         $tex .= "\n";
 845     }
 846
 847     $tex .= "}\n";
 848
 849     return $tex;
 850 }
 851
 852
 853 =head1 INTERNAL FUNCTIONS
 854
 855 =head2 _entity_encode - Entity-encode an array of strings
 856
 857   my ($entity_encoded_string) = _entity_encode($string);
 858
 859 or
 860
 861   my (@entity_encoded_strings) = _entity_encode(@strings);
 862
 863 Entity-encode an array of strings
 864
 865 =cut
 866
 867 sub _entity_encode {
 868         my @strings = @_;
 869         my @strings_entity_encoded;
 870         foreach my $string (@strings) {
 871                 my $nfc_string = NFC($string);
 872                 $nfc_string =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
 873                 push @strings_entity_encoded, $nfc_string;
 874         }
 875         return @strings_entity_encoded;
 876 }
 877
 878 END { }       # module clean-up code here (global destructor)
 879 1;
 880 __END__
 881
 882 =head1 AUTHOR
 883
 884 Joshua Ferraro <jmf@liblime.com>
 885
 886 =head1 MODIFICATIONS
 887
 888
 889 =cut