C4/Biblio.pm

   1 package C4::Biblio;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 # Copyright 2010 BibLibre
   5 # Copyright 2011 Equinox Software, Inc.
   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 use vars qw(@ISA @EXPORT);
  25 BEGIN {
  26     require Exporter;
  27     @ISA = qw(Exporter);
  28
  29     @EXPORT = qw(
  30         AddBiblio
  31         GetBiblioData
  32         GetMarcBiblio
  33         GetRecordValue
  34         GetISBDView
  35         GetMarcControlnumber
  36         GetMarcNotes
  37         GetMarcISBN
  38         GetMarcISSN
  39         GetMarcSubjects
  40         GetMarcAuthors
  41         GetMarcSeries
  42         GetMarcHosts
  43         GetMarcUrls
  44         GetUsedMarcStructure
  45         GetXmlBiblio
  46         GetCOinSBiblio
  47         GetMarcPrice
  48         MungeMarcPrice
  49         GetMarcQuantity
  50         GetAuthorisedValueDesc
  51         GetMarcStructure
  52         IsMarcStructureInternal
  53         GetMarcFromKohaField
  54         GetMarcSubfieldStructureFromKohaField
  55         GetFrameworkCode
  56         TransformKohaToMarc
  57         PrepHostMarcField
  58         CountItemsIssued
  59         CountBiblioInOrders
  60         ModBiblio
  61         ModZebra
  62         UpdateTotalIssues
  63         RemoveAllNsb
  64         DelBiblio
  65         BiblioAutoLink
  66         LinkBibHeadingsToAuthorities
  67         TransformMarcToKoha
  68         TransformHtmlToMarc
  69         TransformHtmlToXml
  70         prepare_host_field
  71     );
  72
  73     # Internal functions
  74     # those functions are exported but should not be used
  75     # they are useful in a few circumstances, so they are exported,
  76     # but don't use them unless you are a core developer ;-)
  77     push @EXPORT, qw(
  78       ModBiblioMarc
  79     );
  80 }
  81
  82 use Carp;
  83
  84 use Encode qw( decode is_utf8 );
  85 use List::MoreUtils qw( uniq );
  86 use MARC::Record;
  87 use MARC::File::USMARC;
  88 use MARC::File::XML;
  89 use POSIX qw(strftime);
  90 use Module::Load::Conditional qw(can_load);
  91
  92 use C4::Koha;
  93 use C4::Log;    # logaction
  94 use C4::Budgets;
  95 use C4::ClassSource;
  96 use C4::Charset;
  97 use C4::Linker;
  98 use C4::OAI::Sets;
  99 use C4::Debug;
 100
 101 use Koha::Caches;
 102 use Koha::Authority::Types;
 103 use Koha::Acquisition::Currencies;
 104 use Koha::Biblio::Metadata;
 105 use Koha::Biblio::Metadatas;
 106 use Koha::Holds;
 107 use Koha::ItemTypes;
 108 use Koha::SearchEngine;
 109 use Koha::Libraries;
 110
 111 use vars qw($debug $cgi_debug);
 112
 113
 114 =head1 NAME
 115
 116 C4::Biblio - cataloging management functions
 117
 118 =head1 DESCRIPTION
 119
 120 Biblio.pm contains functions for managing storage and editing of bibliographic data within Koha. Most of the functions in this module are used for cataloging records: adding, editing, or removing biblios, biblioitems, or items. Koha's stores bibliographic information in three places:
 121
 122 =over 4
 123
 124 =item 1. in the biblio,biblioitems,items, etc tables, which are limited to a one-to-one mapping to underlying MARC data
 125
 126 =item 2. as raw MARC in the Zebra index and storage engine
 127
 128 =item 3. as MARC XML in biblio_metadata.metadata
 129
 130 =back
 131
 132 In the 3.0 version of Koha, the authoritative record-level information is in biblio_metadata.metadata
 133
 134 Because the data isn't completely normalized there's a chance for information to get out of sync. The design choice to go with a un-normalized schema was driven by performance and stability concerns. However, if this occur, it can be considered as a bug : The API is (or should be) complete & the only entry point for all biblio/items managements.
 135
 136 =over 4
 137
 138 =item 1. Compared with MySQL, Zebra is slow to update an index for small data changes -- especially for proc-intensive operations like circulation
 139
 140 =item 2. Zebra's index has been known to crash and a backup of the data is necessary to rebuild it in such cases
 141
 142 =back
 143
 144 Because of this design choice, the process of managing storage and editing is a bit convoluted. Historically, Biblio.pm's grown to an unmanagable size and as a result we have several types of functions currently:
 145
 146 =over 4
 147
 148 =item 1. Add*/Mod*/Del*/ - high-level external functions suitable for being called from external scripts to manage the collection
 149
 150 =item 2. _koha_* - low-level internal functions for managing the koha tables
 151
 152 =item 3. Marc management function : as the MARC record is stored in biblio_metadata.metadata, some subs dedicated to it's management are in this package. They should be used only internally by Biblio.pm, the only official entry points being AddBiblio, AddItem, ModBiblio, ModItem.
 153
 154 =item 4. Zebra functions used to update the Zebra index
 155
 156 =item 5. internal helper functions such as char_decode, checkitems, etc. Some of these probably belong in Koha.pm
 157
 158 =back
 159
 160 The MARC record (in biblio_metadata.metadata) contains the complete marc record, including items. It also contains the biblionumber. That is the reason why it is not stored directly by AddBiblio, with all other fields . To save a biblio, we need to :
 161
 162 =over 4
 163
 164 =item 1. save datas in biblio and biblioitems table, that gives us a biblionumber and a biblioitemnumber
 165
 166 =item 2. add the biblionumber and biblioitemnumber into the MARC records
 167
 168 =item 3. save the marc record
 169
 170 =back
 171
 172 =head1 EXPORTED FUNCTIONS
 173
 174 =head2 AddBiblio
 175
 176   ($biblionumber,$biblioitemnumber) = AddBiblio($record,$frameworkcode);
 177
 178 Exported function (core API) for adding a new biblio to koha.
 179
 180 The first argument is a C<MARC::Record> object containing the
 181 bib to add, while the second argument is the desired MARC
 182 framework code.
 183
 184 This function also accepts a third, optional argument: a hashref
 185 to additional options.  The only defined option is C<defer_marc_save>,
 186 which if present and mapped to a true value, causes C<AddBiblio>
 187 to omit the call to save the MARC in C<biblio_metadata.metadata>
 188 This option is provided B<only>
 189 for the use of scripts such as C<bulkmarcimport.pl> that may need
 190 to do some manipulation of the MARC record for item parsing before
 191 saving it and which cannot afford the performance hit of saving
 192 the MARC record twice.  Consequently, do not use that option
 193 unless you can guarantee that C<ModBiblioMarc> will be called.
 194
 195 =cut
 196
 197 sub AddBiblio {
 198     my $record          = shift;
 199     my $frameworkcode   = shift;
 200     my $options         = @_ ? shift : undef;
 201     my $defer_marc_save = 0;
 202     if (!$record) {
 203         carp('AddBiblio called with undefined record');
 204         return;
 205     }
 206     if ( defined $options and exists $options->{'defer_marc_save'} and $options->{'defer_marc_save'} ) {
 207         $defer_marc_save = 1;
 208     }
 209
 210     if (C4::Context->preference('BiblioAddsAuthorities')) {
 211         BiblioAutoLink( $record, $frameworkcode );
 212     }
 213
 214     my ( $biblionumber, $biblioitemnumber, $error );
 215     my $dbh = C4::Context->dbh;
 216
 217     # transform the data into koha-table style data
 218     SetUTF8Flag($record);
 219     my $olddata = TransformMarcToKoha( $record, $frameworkcode );
 220     ( $biblionumber, $error ) = _koha_add_biblio( $dbh, $olddata, $frameworkcode );
 221     $olddata->{'biblionumber'} = $biblionumber;
 222     ( $biblioitemnumber, $error ) = _koha_add_biblioitem( $dbh, $olddata );
 223
 224     _koha_marc_update_bib_ids( $record, $frameworkcode, $biblionumber, $biblioitemnumber );
 225
 226     # update MARC subfield that stores biblioitems.cn_sort
 227     _koha_marc_update_biblioitem_cn_sort( $record, $olddata, $frameworkcode );
 228
 229     # now add the record
 230     ModBiblioMarc( $record, $biblionumber, $frameworkcode ) unless $defer_marc_save;
 231
 232     # update OAI-PMH sets
 233     if(C4::Context->preference("OAI-PMH:AutoUpdateSets")) {
 234         C4::OAI::Sets::UpdateOAISetsBiblio($biblionumber, $record);
 235     }
 236
 237     logaction( "CATALOGUING", "ADD", $biblionumber, "biblio" ) if C4::Context->preference("CataloguingLog");
 238     return ( $biblionumber, $biblioitemnumber );
 239 }
 240
 241 =head2 ModBiblio
 242
 243   ModBiblio( $record,$biblionumber,$frameworkcode);
 244
 245 Replace an existing bib record identified by C<$biblionumber>
 246 with one supplied by the MARC::Record object C<$record>.  The embedded
 247 item, biblioitem, and biblionumber fields from the previous
 248 version of the bib record replace any such fields of those tags that
 249 are present in C<$record>.  Consequently, ModBiblio() is not
 250 to be used to try to modify item records.
 251
 252 C<$frameworkcode> specifies the MARC framework to use
 253 when storing the modified bib record; among other things,
 254 this controls how MARC fields get mapped to display columns
 255 in the C<biblio> and C<biblioitems> tables, as well as
 256 which fields are used to store embedded item, biblioitem,
 257 and biblionumber data for indexing.
 258
 259 Returns 1 on success 0 on failure
 260
 261 =cut
 262
 263 sub ModBiblio {
 264     my ( $record, $biblionumber, $frameworkcode ) = @_;
 265     if (!$record) {
 266         carp 'No record passed to ModBiblio';
 267         return 0;
 268     }
 269
 270     if ( C4::Context->preference("CataloguingLog") ) {
 271         my $newrecord = GetMarcBiblio({ biblionumber => $biblionumber });
 272         logaction( "CATALOGUING", "MODIFY", $biblionumber, "biblio BEFORE=>" . $newrecord->as_formatted );
 273     }
 274
 275     if (C4::Context->preference('BiblioAddsAuthorities')) {
 276         BiblioAutoLink( $record, $frameworkcode );
 277     }
 278
 279     # Cleaning up invalid fields must be done early or SetUTF8Flag is liable to
 280     # throw an exception which probably won't be handled.
 281     foreach my $field ($record->fields()) {
 282         if (! $field->is_control_field()) {
 283             if (scalar($field->subfields()) == 0 || (scalar($field->subfields()) == 1 && $field->subfield('9'))) {
 284                 $record->delete_field($field);
 285             }
 286         }
 287     }
 288
 289     SetUTF8Flag($record);
 290     my $dbh = C4::Context->dbh;
 291
 292     $frameworkcode = "" if !$frameworkcode || $frameworkcode eq "Default"; # XXX
 293
 294     _strip_item_fields($record, $frameworkcode);
 295
 296     # update biblionumber and biblioitemnumber in MARC
 297     # FIXME - this is assuming a 1 to 1 relationship between
 298     # biblios and biblioitems
 299     my $sth = $dbh->prepare("select biblioitemnumber from biblioitems where biblionumber=?");
 300     $sth->execute($biblionumber);
 301     my ($biblioitemnumber) = $sth->fetchrow;
 302     $sth->finish();
 303     _koha_marc_update_bib_ids( $record, $frameworkcode, $biblionumber, $biblioitemnumber );
 304
 305     # load the koha-table data object
 306     my $oldbiblio = TransformMarcToKoha( $record, $frameworkcode );
 307
 308     # update MARC subfield that stores biblioitems.cn_sort
 309     _koha_marc_update_biblioitem_cn_sort( $record, $oldbiblio, $frameworkcode );
 310
 311     # update the MARC record (that now contains biblio and items) with the new record data
 312     &ModBiblioMarc( $record, $biblionumber, $frameworkcode );
 313
 314     # modify the other koha tables
 315     _koha_modify_biblio( $dbh, $oldbiblio, $frameworkcode );
 316     _koha_modify_biblioitem_nonmarc( $dbh, $oldbiblio );
 317
 318     # update OAI-PMH sets
 319     if(C4::Context->preference("OAI-PMH:AutoUpdateSets")) {
 320         C4::OAI::Sets::UpdateOAISetsBiblio($biblionumber, $record);
 321     }
 322
 323     return 1;
 324 }
 325
 326 =head2 _strip_item_fields
 327
 328   _strip_item_fields($record, $frameworkcode)
 329
 330 Utility routine to remove item tags from a
 331 MARC bib.
 332
 333 =cut
 334
 335 sub _strip_item_fields {
 336     my $record = shift;
 337     my $frameworkcode = shift;
 338     # get the items before and append them to the biblio before updating the record, atm we just have the biblio
 339     my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
 340
 341     # delete any item fields from incoming record to avoid
 342     # duplication or incorrect data - use AddItem() or ModItem()
 343     # to change items
 344     foreach my $field ( $record->field($itemtag) ) {
 345         $record->delete_field($field);
 346     }
 347 }
 348
 349 =head2 DelBiblio
 350
 351   my $error = &DelBiblio($biblionumber);
 352
 353 Exported function (core API) for deleting a biblio in koha.
 354 Deletes biblio record from Zebra and Koha tables (biblio & biblioitems)
 355 Also backs it up to deleted* tables.
 356 Checks to make sure that the biblio has no items attached.
 357 return:
 358 C<$error> : undef unless an error occurs
 359
 360 =cut
 361
 362 sub DelBiblio {
 363     my ($biblionumber) = @_;
 364
 365     my $biblio = Koha::Biblios->find( $biblionumber );
 366     return unless $biblio; # Should we throw an exception instead?
 367
 368     my $dbh = C4::Context->dbh;
 369     my $error;    # for error handling
 370
 371     # First make sure this biblio has no items attached
 372     my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber=?");
 373     $sth->execute($biblionumber);
 374     if ( my $itemnumber = $sth->fetchrow ) {
 375
 376         # Fix this to use a status the template can understand
 377         $error .= "This Biblio has items attached, please delete them first before deleting this biblio ";
 378     }
 379
 380     return $error if $error;
 381
 382     # We delete attached subscriptions
 383     require C4::Serials;
 384     my $subscriptions = C4::Serials::GetFullSubscriptionsFromBiblionumber($biblionumber);
 385     foreach my $subscription (@$subscriptions) {
 386         C4::Serials::DelSubscription( $subscription->{subscriptionid} );
 387     }
 388
 389     # We delete any existing holds
 390     my $holds = $biblio->holds;
 391     while ( my $hold = $holds->next ) {
 392         $hold->cancel;
 393     }
 394
 395     # Delete in Zebra. Be careful NOT to move this line after _koha_delete_biblio
 396     # for at least 2 reasons :
 397     # - if something goes wrong, the biblio may be deleted from Koha but not from zebra
 398     #   and we would have no way to remove it (except manually in zebra, but I bet it would be very hard to handle the problem)
 399     ModZebra( $biblionumber, "recordDelete", "biblioserver" );
 400
 401     # delete biblioitems and items from Koha tables and save in deletedbiblioitems,deleteditems
 402     $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
 403     $sth->execute($biblionumber);
 404     while ( my $biblioitemnumber = $sth->fetchrow ) {
 405
 406         # delete this biblioitem
 407         $error = _koha_delete_biblioitems( $dbh, $biblioitemnumber );
 408         return $error if $error;
 409     }
 410
 411
 412     # delete biblio from Koha tables and save in deletedbiblio
 413     # must do this *after* _koha_delete_biblioitems, otherwise
 414     # delete cascade will prevent deletedbiblioitems rows
 415     # from being generated by _koha_delete_biblioitems
 416     $error = _koha_delete_biblio( $dbh, $biblionumber );
 417
 418     logaction( "CATALOGUING", "DELETE", $biblionumber, "biblio" ) if C4::Context->preference("CataloguingLog");
 419
 420     return;
 421 }
 422
 423
 424 =head2 BiblioAutoLink
 425
 426   my $headings_linked = BiblioAutoLink($record, $frameworkcode)
 427
 428 Automatically links headings in a bib record to authorities.
 429
 430 Returns the number of headings changed
 431
 432 =cut
 433
 434 sub BiblioAutoLink {
 435     my $record        = shift;
 436     my $frameworkcode = shift;
 437     if (!$record) {
 438         carp('Undefined record passed to BiblioAutoLink');
 439         return 0;
 440     }
 441     my ( $num_headings_changed, %results );
 442
 443     my $linker_module =
 444       "C4::Linker::" . ( C4::Context->preference("LinkerModule") || 'Default' );
 445     unless ( can_load( modules => { $linker_module => undef } ) ) {
 446         $linker_module = 'C4::Linker::Default';
 447         unless ( can_load( modules => { $linker_module => undef } ) ) {
 448             return 0;
 449         }
 450     }
 451
 452     my $linker = $linker_module->new(
 453         { 'options' => C4::Context->preference("LinkerOptions") } );
 454     my ( $headings_changed, undef ) =
 455       LinkBibHeadingsToAuthorities( $linker, $record, $frameworkcode, C4::Context->preference("CatalogModuleRelink") || '' );
 456     # By default we probably don't want to relink things when cataloging
 457     return $headings_changed;
 458 }
 459
 460 =head2 LinkBibHeadingsToAuthorities
 461
 462   my $num_headings_changed, %results = LinkBibHeadingsToAuthorities($linker, $marc, $frameworkcode, [$allowrelink]);
 463
 464 Links bib headings to authority records by checking
 465 each authority-controlled field in the C<MARC::Record>
 466 object C<$marc>, looking for a matching authority record,
 467 and setting the linking subfield $9 to the ID of that
 468 authority record.
 469
 470 If $allowrelink is false, existing authids will never be
 471 replaced, regardless of the values of LinkerKeepStale and
 472 LinkerRelink.
 473
 474 Returns the number of heading links changed in the
 475 MARC record.
 476
 477 =cut
 478
 479 sub LinkBibHeadingsToAuthorities {
 480     my $linker        = shift;
 481     my $bib           = shift;
 482     my $frameworkcode = shift;
 483     my $allowrelink = shift;
 484     my %results;
 485     if (!$bib) {
 486         carp 'LinkBibHeadingsToAuthorities called on undefined bib record';
 487         return ( 0, {});
 488     }
 489     require C4::Heading;
 490     require C4::AuthoritiesMarc;
 491
 492     $allowrelink = 1 unless defined $allowrelink;
 493     my $num_headings_changed = 0;
 494     foreach my $field ( $bib->fields() ) {
 495         my $heading = C4::Heading->new_from_bib_field( $field, $frameworkcode );
 496         next unless defined $heading;
 497
 498         # check existing $9
 499         my $current_link = $field->subfield('9');
 500
 501         if ( defined $current_link && (!$allowrelink || !C4::Context->preference('LinkerRelink')) )
 502         {
 503             $results{'linked'}->{ $heading->display_form() }++;
 504             next;
 505         }
 506
 507         my ( $authid, $fuzzy ) = $linker->get_link($heading);
 508         if ($authid) {
 509             $results{ $fuzzy ? 'fuzzy' : 'linked' }
 510               ->{ $heading->display_form() }++;
 511             next if defined $current_link and $current_link == $authid;
 512
 513             $field->delete_subfield( code => '9' ) if defined $current_link;
 514             $field->add_subfields( '9', $authid );
 515             $num_headings_changed++;
 516         }
 517         else {
 518             if ( defined $current_link
 519                 && (!$allowrelink || C4::Context->preference('LinkerKeepStale')) )
 520             {
 521                 $results{'fuzzy'}->{ $heading->display_form() }++;
 522             }
 523             elsif ( C4::Context->preference('AutoCreateAuthorities') ) {
 524                 if ( _check_valid_auth_link( $current_link, $field ) ) {
 525                     $results{'linked'}->{ $heading->display_form() }++;
 526                 }
 527                 else {
 528                     my $authority_type = Koha::Authority::Types->find( $heading->auth_type() );
 529                     my $marcrecordauth = MARC::Record->new();
 530                     if ( C4::Context->preference('marcflavour') eq 'MARC21' ) {
 531                         $marcrecordauth->leader('     nz  a22     o  4500');
 532                         SetMarcUnicodeFlag( $marcrecordauth, 'MARC21' );
 533                     }
 534                     $field->delete_subfield( code => '9' )
 535                       if defined $current_link;
 536                     my $authfield =
 537                       MARC::Field->new( $authority_type->auth_tag_to_report,
 538                         '', '', "a" => "" . $field->subfield('a') );
 539                     map {
 540                         $authfield->add_subfields( $_->[0] => $_->[1] )
 541                           if ( $_->[0] =~ /[A-z]/ && $_->[0] ne "a" )
 542                     } $field->subfields();
 543                     $marcrecordauth->insert_fields_ordered($authfield);
 544
 545 # bug 2317: ensure new authority knows it's using UTF-8; currently
 546 # only need to do this for MARC21, as MARC::Record->as_xml_record() handles
 547 # automatically for UNIMARC (by not transcoding)
 548 # FIXME: AddAuthority() instead should simply explicitly require that the MARC::Record
 549 # use UTF-8, but as of 2008-08-05, did not want to introduce that kind
 550 # of change to a core API just before the 3.0 release.
 551
 552                     if ( C4::Context->preference('marcflavour') eq 'MARC21' ) {
 553                         my $userenv = C4::Context->userenv;
 554                         my $library;
 555                         if ( $userenv && $userenv->{'branch'} ) {
 556                             $library = Koha::Libraries->find( $userenv->{'branch'} );
 557                         }
 558                         $marcrecordauth->insert_fields_ordered(
 559                             MARC::Field->new(
 560                                 '667', '', '',
 561                                 'a' => "Machine generated authority record."
 562                             )
 563                         );
 564                         my $cite =
 565                             $bib->author() . ", "
 566                           . $bib->title_proper() . ", "
 567                           . $bib->publication_date() . " ";
 568                         $cite =~ s/^[\s\,]*//;
 569                         $cite =~ s/[\s\,]*$//;
 570                         $cite =
 571                             "Work cat.: ("
 572                           . ( $library ? $library->get_effective_marcorgcode : C4::Context->preference('MARCOrgCode') ) . ")"
 573                           . $bib->subfield( '999', 'c' ) . ": "
 574                           . $cite;
 575                         $marcrecordauth->insert_fields_ordered(
 576                             MARC::Field->new( '670', '', '', 'a' => $cite ) );
 577                     }
 578
 579            #          warn "AUTH RECORD ADDED : ".$marcrecordauth->as_formatted;
 580
 581                     $authid =
 582                       C4::AuthoritiesMarc::AddAuthority( $marcrecordauth, '',
 583                         $heading->auth_type() );
 584                     $field->add_subfields( '9', $authid );
 585                     $num_headings_changed++;
 586                     $linker->update_cache($heading, $authid);
 587                     $results{'added'}->{ $heading->display_form() }++;
 588                 }
 589             }
 590             elsif ( defined $current_link ) {
 591                 if ( _check_valid_auth_link( $current_link, $field ) ) {
 592                     $results{'linked'}->{ $heading->display_form() }++;
 593                 }
 594                 else {
 595                     $field->delete_subfield( code => '9' );
 596                     $num_headings_changed++;
 597                     $results{'unlinked'}->{ $heading->display_form() }++;
 598                 }
 599             }
 600             else {
 601                 $results{'unlinked'}->{ $heading->display_form() }++;
 602             }
 603         }
 604
 605     }
 606     return $num_headings_changed, \%results;
 607 }
 608
 609 =head2 _check_valid_auth_link
 610
 611     if ( _check_valid_auth_link($authid, $field) ) {
 612         ...
 613     }
 614
 615 Check whether the specified heading-auth link is valid without reference
 616 to Zebra. Ideally this code would be in C4::Heading, but that won't be
 617 possible until we have de-cycled C4::AuthoritiesMarc, so this is the
 618 safest place.
 619
 620 =cut
 621
 622 sub _check_valid_auth_link {
 623     my ( $authid, $field ) = @_;
 624
 625     require C4::AuthoritiesMarc;
 626
 627     my $authorized_heading =
 628       C4::AuthoritiesMarc::GetAuthorizedHeading( { 'authid' => $authid } ) || '';
 629
 630    return ($field->as_string('abcdefghijklmnopqrstuvwxyz') eq $authorized_heading);
 631 }
 632
 633 =head2 GetRecordValue
 634
 635   my $values = GetRecordValue($field, $record, $frameworkcode);
 636
 637 Get MARC fields from a keyword defined in fieldmapping table.
 638
 639 =cut
 640
 641 sub GetRecordValue {
 642     my ( $field, $record, $frameworkcode ) = @_;
 643
 644     if (!$record) {
 645         carp 'GetRecordValue called with undefined record';
 646         return;
 647     }
 648     my $dbh = C4::Context->dbh;
 649
 650     my $sth = $dbh->prepare('SELECT fieldcode, subfieldcode FROM fieldmapping WHERE frameworkcode = ? AND field = ?');
 651     $sth->execute( $frameworkcode, $field );
 652
 653     my @result = ();
 654
 655     while ( my $row = $sth->fetchrow_hashref ) {
 656         foreach my $field ( $record->field( $row->{fieldcode} ) ) {
 657             if ( ( $row->{subfieldcode} ne "" && $field->subfield( $row->{subfieldcode} ) ) ) {
 658                 foreach my $subfield ( $field->subfield( $row->{subfieldcode} ) ) {
 659                     push @result, { 'subfield' => $subfield };
 660                 }
 661
 662             } elsif ( $row->{subfieldcode} eq "" ) {
 663                 push @result, { 'subfield' => $field->as_string() };
 664             }
 665         }
 666     }
 667
 668     return \@result;
 669 }
 670
 671 =head2 GetBiblioData
 672
 673   $data = &GetBiblioData($biblionumber);
 674
 675 Returns information about the book with the given biblionumber.
 676 C<&GetBiblioData> returns a reference-to-hash. The keys are the fields in
 677 the C<biblio> and C<biblioitems> tables in the
 678 Koha database.
 679
 680 In addition, C<$data-E<gt>{subject}> is the list of the book's
 681 subjects, separated by C<" , "> (space, comma, space).
 682 If there are multiple biblioitems with the given biblionumber, only
 683 the first one is considered.
 684
 685 =cut
 686
 687 sub GetBiblioData {
 688     my ($bibnum) = @_;
 689     my $dbh = C4::Context->dbh;
 690
 691     my $query = " SELECT * , biblioitems.notes AS bnotes, itemtypes.notforloan as bi_notforloan, biblio.notes
 692             FROM biblio
 693             LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
 694             LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
 695             WHERE biblio.biblionumber = ?";
 696
 697     my $sth = $dbh->prepare($query);
 698     $sth->execute($bibnum);
 699     my $data;
 700     $data = $sth->fetchrow_hashref;
 701     $sth->finish;
 702
 703     return ($data);
 704 }    # sub GetBiblioData
 705
 706 =head2 GetISBDView
 707
 708   $isbd = &GetISBDView({
 709       'record'    => $marc_record,
 710       'template'  => $interface, # opac/intranet
 711       'framework' => $framework,
 712   });
 713
 714 Return the ISBD view which can be included in opac and intranet
 715
 716 =cut
 717
 718 sub GetISBDView {
 719     my ( $params ) = @_;
 720
 721     # Expecting record WITH items.
 722     my $record    = $params->{record};
 723     return unless defined $record;
 724
 725     my $template  = $params->{template} // q{};
 726     my $sysprefname = $template eq 'opac' ? 'opacisbd' : 'isbd';
 727     my $framework = $params->{framework};
 728     my $itemtype  = $framework;
 729     my ( $holdingbrtagf, $holdingbrtagsubf ) = &GetMarcFromKohaField( "items.holdingbranch", $itemtype );
 730     my $tagslib = GetMarcStructure( 1, $itemtype, { unsafe => 1 } );
 731
 732     my $ISBD = C4::Context->preference($sysprefname);
 733     my $bloc = $ISBD;
 734     my $res;
 735     my $blocres;
 736
 737     foreach my $isbdfield ( split( /#/, $bloc ) ) {
 738
 739         #         $isbdfield= /(.?.?.?)/;
 740         $isbdfield =~ /(\d\d\d)([^\|])?\|(.*)\|(.*)\|(.*)/;
 741         my $fieldvalue = $1 || 0;
 742         my $subfvalue  = $2 || "";
 743         my $textbefore = $3;
 744         my $analysestring = $4;
 745         my $textafter     = $5;
 746
 747         #         warn "==> $1 / $2 / $3 / $4";
 748         #         my $fieldvalue=substr($isbdfield,0,3);
 749         if ( $fieldvalue > 0 ) {
 750             my $hasputtextbefore = 0;
 751             my @fieldslist       = $record->field($fieldvalue);
 752             @fieldslist = sort { $a->subfield($holdingbrtagsubf) cmp $b->subfield($holdingbrtagsubf) } @fieldslist if ( $fieldvalue eq $holdingbrtagf );
 753
 754             #         warn "ERROR IN ISBD DEFINITION at : $isbdfield" unless $fieldvalue;
 755             #             warn "FV : $fieldvalue";
 756             if ( $subfvalue ne "" ) {
 757                 # OPAC hidden subfield
 758                 next
 759                   if ( ( $template eq 'opac' )
 760                     && ( $tagslib->{$fieldvalue}->{$subfvalue}->{'hidden'} || 0 ) > 0 );
 761                 foreach my $field (@fieldslist) {
 762                     foreach my $subfield ( $field->subfield($subfvalue) ) {
 763                         my $calculated = $analysestring;
 764                         my $tag        = $field->tag();
 765                         if ( $tag < 10 ) {
 766                         } else {
 767                             my $subfieldvalue = GetAuthorisedValueDesc( $tag, $subfvalue, $subfield, '', $tagslib );
 768                             my $tagsubf = $tag . $subfvalue;
 769                             $calculated =~ s/\{(.?.?.?.?)$tagsubf(.*?)\}/$1$subfieldvalue$2\{$1$tagsubf$2\}/g;
 770                             if ( $template eq "opac" ) { $calculated =~ s#/cgi-bin/koha/[^/]+/([^.]*.pl\?.*)$#opac-$1#g; }
 771
 772                             # field builded, store the result
 773                             if ( $calculated && !$hasputtextbefore ) {    # put textbefore if not done
 774                                 $blocres .= $textbefore;
 775                                 $hasputtextbefore = 1;
 776                             }
 777
 778                             # remove punctuation at start
 779                             $calculated =~ s/^( |;|:|\.|-)*//g;
 780                             $blocres .= $calculated;
 781
 782                         }
 783                     }
 784                 }
 785                 $blocres .= $textafter if $hasputtextbefore;
 786             } else {
 787                 foreach my $field (@fieldslist) {
 788                     my $calculated = $analysestring;
 789                     my $tag        = $field->tag();
 790                     if ( $tag < 10 ) {
 791                     } else {
 792                         my @subf = $field->subfields;
 793                         for my $i ( 0 .. $#subf ) {
 794                             my $valuecode     = $subf[$i][1];
 795                             my $subfieldcode  = $subf[$i][0];
 796                             # OPAC hidden subfield
 797                             next
 798                               if ( ( $template eq 'opac' )
 799                                 && ( $tagslib->{$fieldvalue}->{$subfieldcode}->{'hidden'} || 0 ) > 0 );
 800                             my $subfieldvalue = GetAuthorisedValueDesc( $tag, $subf[$i][0], $subf[$i][1], '', $tagslib );
 801                             my $tagsubf       = $tag . $subfieldcode;
 802
 803                             $calculated =~ s/                  # replace all {{}} codes by the value code.
 804                                   \{\{$tagsubf\}\} # catch the {{actualcode}}
 805                                 /
 806                                   $valuecode     # replace by the value code
 807                                /gx;
 808
 809                             $calculated =~ s/\{(.?.?.?.?)$tagsubf(.*?)\}/$1$subfieldvalue$2\{$1$tagsubf$2\}/g;
 810                             if ( $template eq "opac" ) { $calculated =~ s#/cgi-bin/koha/[^/]+/([^.]*.pl\?.*)$#opac-$1#g; }
 811                         }
 812
 813                         # field builded, store the result
 814                         if ( $calculated && !$hasputtextbefore ) {    # put textbefore if not done
 815                             $blocres .= $textbefore;
 816                             $hasputtextbefore = 1;
 817                         }
 818
 819                         # remove punctuation at start
 820                         $calculated =~ s/^( |;|:|\.|-)*//g;
 821                         $blocres .= $calculated;
 822                     }
 823                 }
 824                 $blocres .= $textafter if $hasputtextbefore;
 825             }
 826         } else {
 827             $blocres .= $isbdfield;
 828         }
 829     }
 830     $res .= $blocres;
 831
 832     $res =~ s/\{(.*?)\}//g;
 833     $res =~ s/\\n/\n/g;
 834     $res =~ s/\n/<br\/>/g;
 835
 836     # remove empty ()
 837     $res =~ s/\(\)//g;
 838
 839     return $res;
 840 }
 841
 842 =head1 FUNCTIONS FOR HANDLING MARC MANAGEMENT
 843
 844 =head2 IsMarcStructureInternal
 845
 846     my $tagslib = C4::Biblio::GetMarcStructure();
 847     for my $tag ( sort keys %$tagslib ) {
 848         next unless $tag;
 849         for my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
 850             next if IsMarcStructureInternal($tagslib->{$tag}{$subfield});
 851         }
 852         # Process subfield
 853     }
 854
 855 GetMarcStructure creates keys (lib, tab, mandatory, repeatable) for a display purpose.
 856 These different values should not be processed as valid subfields.
 857
 858 =cut
 859
 860 sub IsMarcStructureInternal {
 861     my ( $subfield ) = @_;
 862     return ref $subfield ? 0 : 1;
 863 }
 864
 865 =head2 GetMarcStructure
 866
 867   $res = GetMarcStructure($forlibrarian, $frameworkcode, [ $params ]);
 868
 869 Returns a reference to a big hash of hash, with the Marc structure for the given frameworkcode
 870 $forlibrarian  :if set to 1, the MARC descriptions are the librarians ones, otherwise it's the public (OPAC) ones
 871 $frameworkcode : the framework code to read
 872 $params allows you to pass { unsafe => 1 } for better performance.
 873
 874 Note: If you call GetMarcStructure with unsafe => 1, do not modify or
 875 even autovivify its contents. It is a cached/shared data structure. Your
 876 changes c/would be passed around in subsequent calls.
 877
 878 =cut
 879
 880 sub GetMarcStructure {
 881     my ( $forlibrarian, $frameworkcode, $params ) = @_;
 882     $frameworkcode = "" unless $frameworkcode;
 883
 884     $forlibrarian = $forlibrarian ? 1 : 0;
 885     my $unsafe = ($params && $params->{unsafe})? 1: 0;
 886     my $cache = Koha::Caches->get_instance();
 887     my $cache_key = "MarcStructure-$forlibrarian-$frameworkcode";
 888     my $cached = $cache->get_from_cache($cache_key, { unsafe => $unsafe });
 889     return $cached if $cached;
 890
 891     my $dbh = C4::Context->dbh;
 892     my $sth = $dbh->prepare(
 893         "SELECT tagfield,liblibrarian,libopac,mandatory,repeatable,ind1_defaultvalue,ind2_defaultvalue
 894         FROM marc_tag_structure
 895         WHERE frameworkcode=?
 896         ORDER BY tagfield"
 897     );
 898     $sth->execute($frameworkcode);
 899     my ( $liblibrarian, $libopac, $tag, $res, $tab, $mandatory, $repeatable, $ind1_defaultvalue, $ind2_defaultvalue );
 900
 901     while ( ( $tag, $liblibrarian, $libopac, $mandatory, $repeatable, $ind1_defaultvalue, $ind2_defaultvalue ) = $sth->fetchrow ) {
 902         $res->{$tag}->{lib}        = ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
 903         $res->{$tag}->{tab}        = "";
 904         $res->{$tag}->{mandatory}  = $mandatory;
 905         $res->{$tag}->{repeatable} = $repeatable;
 906     $res->{$tag}->{ind1_defaultvalue} = $ind1_defaultvalue;
 907     $res->{$tag}->{ind2_defaultvalue} = $ind2_defaultvalue;
 908     }
 909
 910     $sth = $dbh->prepare(
 911         "SELECT tagfield,tagsubfield,liblibrarian,libopac,tab,mandatory,repeatable,authorised_value,authtypecode,value_builder,kohafield,seealso,hidden,isurl,link,defaultvalue,maxlength
 912          FROM   marc_subfield_structure
 913          WHERE  frameworkcode=?
 914          ORDER BY tagfield,tagsubfield
 915         "
 916     );
 917
 918     $sth->execute($frameworkcode);
 919
 920     my $subfield;
 921     my $authorised_value;
 922     my $authtypecode;
 923     my $value_builder;
 924     my $kohafield;
 925     my $seealso;
 926     my $hidden;
 927     my $isurl;
 928     my $link;
 929     my $defaultvalue;
 930     my $maxlength;
 931
 932     while (
 933         (   $tag,          $subfield,      $liblibrarian, $libopac, $tab,    $mandatory, $repeatable, $authorised_value,
 934             $authtypecode, $value_builder, $kohafield,    $seealso, $hidden, $isurl,     $link,       $defaultvalue,
 935             $maxlength
 936         )
 937         = $sth->fetchrow
 938       ) {
 939         $res->{$tag}->{$subfield}->{lib}              = ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
 940         $res->{$tag}->{$subfield}->{tab}              = $tab;
 941         $res->{$tag}->{$subfield}->{mandatory}        = $mandatory;
 942         $res->{$tag}->{$subfield}->{repeatable}       = $repeatable;
 943         $res->{$tag}->{$subfield}->{authorised_value} = $authorised_value;
 944         $res->{$tag}->{$subfield}->{authtypecode}     = $authtypecode;
 945         $res->{$tag}->{$subfield}->{value_builder}    = $value_builder;
 946         $res->{$tag}->{$subfield}->{kohafield}        = $kohafield;
 947         $res->{$tag}->{$subfield}->{seealso}          = $seealso;
 948         $res->{$tag}->{$subfield}->{hidden}           = $hidden;
 949         $res->{$tag}->{$subfield}->{isurl}            = $isurl;
 950         $res->{$tag}->{$subfield}->{'link'}           = $link;
 951         $res->{$tag}->{$subfield}->{defaultvalue}     = $defaultvalue;
 952         $res->{$tag}->{$subfield}->{maxlength}        = $maxlength;
 953     }
 954
 955     $cache->set_in_cache($cache_key, $res);
 956     return $res;
 957 }
 958
 959 =head2 GetUsedMarcStructure
 960
 961 The same function as GetMarcStructure except it just takes field
 962 in tab 0-9. (used field)
 963
 964   my $results = GetUsedMarcStructure($frameworkcode);
 965
 966 C<$results> is a ref to an array which each case contains a ref
 967 to a hash which each keys is the columns from marc_subfield_structure
 968
 969 C<$frameworkcode> is the framework code.
 970
 971 =cut
 972
 973 sub GetUsedMarcStructure {
 974     my $frameworkcode = shift || '';
 975     my $query = q{
 976         SELECT *
 977         FROM   marc_subfield_structure
 978         WHERE   tab > -1
 979             AND frameworkcode = ?
 980         ORDER BY tagfield, tagsubfield
 981     };
 982     my $sth = C4::Context->dbh->prepare($query);
 983     $sth->execute($frameworkcode);
 984     return $sth->fetchall_arrayref( {} );
 985 }
 986
 987 =pod
 988
 989 =head2 GetMarcSubfieldStructure
 990
 991   my $structure = GetMarcSubfieldStructure($frameworkcode, [$params]);
 992
 993 Returns a reference to hash representing MARC subfield structure
 994 for framework with framework code C<$frameworkcode>, C<$params> is
 995 optional and may contain additional options.
 996
 997 =over 4
 998
 999 =item C<$frameworkcode>
1000
1001 The framework code.
1002
1003 =item C<$params>
1004
1005 An optional hash reference with additional options.
1006 The following options are supported:
1007
1008 =over 4
1009
1010 =item unsafe
1011
1012 Pass { unsafe => 1 } do disable cached object cloning,
1013 and instead get a shared reference, resulting in better
1014 performance (but care must be taken so that retured object
1015 is never modified).
1016
1017 Note: If you call GetMarcSubfieldStructure with unsafe => 1, do not modify or
1018 even autovivify its contents. It is a cached/shared data structure. Your
1019 changes would be passed around in subsequent calls.
1020
1021 =back
1022
1023 =back
1024
1025 =cut
1026
1027 sub GetMarcSubfieldStructure {
1028     my ( $frameworkcode, $params ) = @_;
1029
1030     $frameworkcode //= '';
1031
1032     my $cache     = Koha::Caches->get_instance();
1033     my $cache_key = "MarcSubfieldStructure-$frameworkcode";
1034     my $cached  = $cache->get_from_cache($cache_key, { unsafe => ($params && $params->{unsafe}) });
1035     return $cached if $cached;
1036
1037     my $dbh = C4::Context->dbh;
1038     # We moved to selectall_arrayref since selectall_hashref does not
1039     # keep duplicate mappings on kohafield (like place in 260 vs 264)
1040     my $subfield_aref = $dbh->selectall_arrayref( q|
1041         SELECT *
1042         FROM marc_subfield_structure
1043         WHERE frameworkcode = ?
1044         AND kohafield > ''
1045         ORDER BY frameworkcode,tagfield,tagsubfield
1046     |, { Slice => {} }, $frameworkcode );
1047     # Now map the output to a hash structure
1048     my $subfield_structure = {};
1049     foreach my $row ( @$subfield_aref ) {
1050         push @{ $subfield_structure->{ $row->{kohafield} }}, $row;
1051     }
1052     $cache->set_in_cache( $cache_key, $subfield_structure );
1053     return $subfield_structure;
1054 }
1055
1056 =head2 GetMarcFromKohaField
1057
1058     ( $field,$subfield ) = GetMarcFromKohaField( $kohafield );
1059     @fields = GetMarcFromKohaField( $kohafield );
1060     $field = GetMarcFromKohaField( $kohafield );
1061
1062     Returns the MARC fields & subfields mapped to $kohafield.
1063     Since the Default framework is considered as authoritative for such
1064     mappings, the former frameworkcode parameter is obsoleted.
1065
1066     In list context all mappings are returned; there can be multiple
1067     mappings. Note that in the above example you could miss a second
1068     mappings in the first call.
1069     In scalar context only the field tag of the first mapping is returned.
1070
1071 =cut
1072
1073 sub GetMarcFromKohaField {
1074     my ( $kohafield ) = @_;
1075     return unless $kohafield;
1076     # The next call uses the Default framework since it is AUTHORITATIVE
1077     # for all Koha to MARC mappings.
1078     my $mss = GetMarcSubfieldStructure( '', { unsafe => 1 } ); # Do not change framework
1079     my @retval;
1080     foreach( @{ $mss->{$kohafield} } ) {
1081         push @retval, $_->{tagfield}, $_->{tagsubfield};
1082     }
1083     return wantarray ? @retval : ( @retval ? $retval[0] : undef );
1084 }
1085
1086 =head2 GetMarcSubfieldStructureFromKohaField
1087
1088     my $str = GetMarcSubfieldStructureFromKohaField( $kohafield );
1089
1090     Returns marc subfield structure information for $kohafield.
1091     The Default framework is used, since it is authoritative for kohafield
1092     mappings.
1093     In list context returns a list of all hashrefs, since there may be
1094     multiple mappings. In scalar context the first hashref is returned.
1095
1096 =cut
1097
1098 sub GetMarcSubfieldStructureFromKohaField {
1099     my ( $kohafield ) = @_;
1100
1101     return unless $kohafield;
1102
1103     # The next call uses the Default framework since it is AUTHORITATIVE
1104     # for all Koha to MARC mappings.
1105     my $mss = GetMarcSubfieldStructure( '', { unsafe => 1 } ); # Do not change framework
1106     return unless $mss->{$kohafield};
1107     return wantarray ? @{$mss->{$kohafield}} : $mss->{$kohafield}->[0];
1108 }
1109
1110 =head2 GetMarcBiblio
1111
1112   my $record = GetMarcBiblio({
1113       biblionumber => $biblionumber,
1114       embed_items  => $embeditems,
1115       opac         => $opac,
1116       borcat       => $patron_category });
1117
1118 Returns MARC::Record representing a biblio record, or C<undef> if the
1119 biblionumber doesn't exist.
1120
1121 Both embed_items and opac are optional.
1122 If embed_items is passed and is 1, items are embedded.
1123 If opac is passed and is 1, the record is filtered as needed.
1124
1125 =over 4
1126
1127 =item C<$biblionumber>
1128
1129 the biblionumber
1130
1131 =item C<$embeditems>
1132
1133 set to true to include item information.
1134
1135 =item C<$opac>
1136
1137 set to true to make the result suited for OPAC view. This causes things like
1138 OpacHiddenItems to be applied.
1139
1140 =item C<$borcat>
1141
1142 If the OpacHiddenItemsExceptions system preference is set, this patron category
1143 can be used to make visible OPAC items which would be normally hidden.
1144 It only makes sense in combination both embed_items and opac values true.
1145
1146 =back
1147
1148 =cut
1149
1150 sub GetMarcBiblio {
1151     my ($params) = @_;
1152
1153     if (not defined $params) {
1154         carp 'GetMarcBiblio called without parameters';
1155         return;
1156     }
1157
1158     my $biblionumber = $params->{biblionumber};
1159     my $embeditems   = $params->{embed_items} || 0;
1160     my $opac         = $params->{opac} || 0;
1161     my $borcat       = $params->{borcat} // q{};
1162
1163     if (not defined $biblionumber) {
1164         carp 'GetMarcBiblio called with undefined biblionumber';
1165         return;
1166     }
1167
1168     my $dbh          = C4::Context->dbh;
1169     my $sth          = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=? ");
1170     $sth->execute($biblionumber);
1171     my $row     = $sth->fetchrow_hashref;
1172     my $biblioitemnumber = $row->{'biblioitemnumber'};
1173     my $marcxml = GetXmlBiblio( $biblionumber );
1174     $marcxml = StripNonXmlChars( $marcxml );
1175     my $frameworkcode = GetFrameworkCode($biblionumber);
1176     MARC::File::XML->default_record_format( C4::Context->preference('marcflavour') );
1177     my $record = MARC::Record->new();
1178
1179     if ($marcxml) {
1180         $record = eval {
1181             MARC::Record::new_from_xml( $marcxml, "utf8",
1182                 C4::Context->preference('marcflavour') );
1183         };
1184         if ($@) { warn " problem with :$biblionumber : $@ \n$marcxml"; }
1185         return unless $record;
1186
1187         C4::Biblio::_koha_marc_update_bib_ids( $record, $frameworkcode, $biblionumber,
1188             $biblioitemnumber );
1189         C4::Biblio::EmbedItemsInMarcBiblio({
1190             marc_record  => $record,
1191             biblionumber => $biblionumber,
1192             opac         => $opac,
1193             borcat       => $borcat })
1194           if ($embeditems);
1195
1196         return $record;
1197     }
1198     else {
1199         return;
1200     }
1201 }
1202
1203 =head2 GetXmlBiblio
1204
1205   my $marcxml = GetXmlBiblio($biblionumber);
1206
1207 Returns biblio_metadata.metadata/marcxml of the biblionumber passed in parameter.
1208 The XML should only contain biblio information (item information is no longer stored in marcxml field)
1209
1210 =cut
1211
1212 sub GetXmlBiblio {
1213     my ($biblionumber) = @_;
1214     my $dbh = C4::Context->dbh;
1215     return unless $biblionumber;
1216     my ($marcxml) = $dbh->selectrow_array(
1217         q|
1218         SELECT metadata
1219         FROM biblio_metadata
1220         WHERE biblionumber=?
1221             AND format='marcxml'
1222             AND marcflavour=?
1223     |, undef, $biblionumber, C4::Context->preference('marcflavour')
1224     );
1225     return $marcxml;
1226 }
1227
1228 =head2 GetCOinSBiblio
1229
1230   my $coins = GetCOinSBiblio($record);
1231
1232 Returns the COinS (a span) which can be included in a biblio record
1233
1234 =cut
1235
1236 sub GetCOinSBiblio {
1237     my $record = shift;
1238
1239     # get the coin format
1240     if ( ! $record ) {
1241         carp 'GetCOinSBiblio called with undefined record';
1242         return;
1243     }
1244     my $pos7 = substr $record->leader(), 7, 1;
1245     my $pos6 = substr $record->leader(), 6, 1;
1246     my $mtx;
1247     my $genre;
1248     my ( $aulast, $aufirst ) = ( '', '' );
1249     my $oauthors  = '';
1250     my $title     = '';
1251     my $subtitle  = '';
1252     my $pubyear   = '';
1253     my $isbn      = '';
1254     my $issn      = '';
1255     my $publisher = '';
1256     my $pages     = '';
1257     my $titletype = 'b';
1258
1259     # For the purposes of generating COinS metadata, LDR/06-07 can be
1260     # considered the same for UNIMARC and MARC21
1261     my $fmts6;
1262     my $fmts7;
1263     %$fmts6 = (
1264                 'a' => 'book',
1265                 'b' => 'manuscript',
1266                 'c' => 'book',
1267                 'd' => 'manuscript',
1268                 'e' => 'map',
1269                 'f' => 'map',
1270                 'g' => 'film',
1271                 'i' => 'audioRecording',
1272                 'j' => 'audioRecording',
1273                 'k' => 'artwork',
1274                 'l' => 'document',
1275                 'm' => 'computerProgram',
1276                 'o' => 'document',
1277                 'r' => 'document',
1278             );
1279     %$fmts7 = (
1280                     'a' => 'journalArticle',
1281                     's' => 'journal',
1282               );
1283
1284     $genre = $fmts6->{$pos6} ? $fmts6->{$pos6} : 'book';
1285
1286     if ( $genre eq 'book' ) {
1287             $genre = $fmts7->{$pos7} if $fmts7->{$pos7};
1288     }
1289
1290     ##### We must transform mtx to a valable mtx and document type ####
1291     if ( $genre eq 'book' ) {
1292             $mtx = 'book';
1293     } elsif ( $genre eq 'journal' ) {
1294             $mtx = 'journal';
1295             $titletype = 'j';
1296     } elsif ( $genre eq 'journalArticle' ) {
1297             $mtx   = 'journal';
1298             $genre = 'article';
1299             $titletype = 'a';
1300     } else {
1301             $mtx = 'dc';
1302     }
1303
1304     $genre = ( $mtx eq 'dc' ) ? "&amp;rft.type=$genre" : "&amp;rft.genre=$genre";
1305
1306     if ( C4::Context->preference("marcflavour") eq "UNIMARC" ) {
1307
1308         # Setting datas
1309         $aulast  = $record->subfield( '700', 'a' ) || '';
1310         $aufirst = $record->subfield( '700', 'b' ) || '';
1311         $oauthors = "&amp;rft.au=$aufirst $aulast";
1312
1313         # others authors
1314         if ( $record->field('200') ) {
1315             for my $au ( $record->field('200')->subfield('g') ) {
1316                 $oauthors .= "&amp;rft.au=$au";
1317             }
1318         }
1319         $title =
1320           ( $mtx eq 'dc' )
1321           ? "&amp;rft.title=" . $record->subfield( '200', 'a' )
1322           : "&amp;rft.title=" . $record->subfield( '200', 'a' ) . "&amp;rft.btitle=" . $record->subfield( '200', 'a' );
1323         $pubyear   = $record->subfield( '210', 'd' ) || '';
1324         $publisher = $record->subfield( '210', 'c' ) || '';
1325         $isbn      = $record->subfield( '010', 'a' ) || '';
1326         $issn      = $record->subfield( '011', 'a' ) || '';
1327     } else {
1328
1329         # MARC21 need some improve
1330
1331         # Setting datas
1332         if ( $record->field('100') ) {
1333             $oauthors .= "&amp;rft.au=" . $record->subfield( '100', 'a' );
1334         }
1335
1336         # others authors
1337         if ( $record->field('700') ) {
1338             for my $au ( $record->field('700')->subfield('a') ) {
1339                 $oauthors .= "&amp;rft.au=$au";
1340             }
1341         }
1342         $title = "&amp;rft." . $titletype . "title=" . $record->subfield( '245', 'a' );
1343         $subtitle = $record->subfield( '245', 'b' ) || '';
1344         $title .= $subtitle;
1345         if ($titletype eq 'a') {
1346             $pubyear   = $record->field('008') || '';
1347             $pubyear   = substr($pubyear->data(), 7, 4) if $pubyear;
1348             $isbn      = $record->subfield( '773', 'z' ) || '';
1349             $issn      = $record->subfield( '773', 'x' ) || '';
1350             if ($mtx eq 'journal') {
1351                 $title    .= "&amp;rft.title=" . ( $record->subfield( '773', 't' ) || $record->subfield( '773', 'a') || q{} );
1352             } else {
1353                 $title    .= "&amp;rft.btitle=" . ( $record->subfield( '773', 't' ) || $record->subfield( '773', 'a') || q{} );
1354             }
1355             foreach my $rel ($record->subfield( '773', 'g' )) {
1356                 if ($pages) {
1357                     $pages .= ', ';
1358                 }
1359                 $pages .= $rel;
1360             }
1361         } else {
1362             $pubyear   = $record->subfield( '260', 'c' ) || '';
1363             $publisher = $record->subfield( '260', 'b' ) || '';
1364             $isbn      = $record->subfield( '020', 'a' ) || '';
1365             $issn      = $record->subfield( '022', 'a' ) || '';
1366         }
1367
1368     }
1369     my $coins_value =
1370 "ctx_ver=Z39.88-2004&amp;rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3A$mtx$genre$title&amp;rft.isbn=$isbn&amp;rft.issn=$issn&amp;rft.aulast=$aulast&amp;rft.aufirst=$aufirst$oauthors&amp;rft.pub=$publisher&amp;rft.date=$pubyear&amp;rft.pages=$pages";
1371     $coins_value =~ s/(\ |&[^a])/\+/g;
1372     $coins_value =~ s/\"/\&quot\;/g;
1373
1374 #<!-- TMPL_VAR NAME="ocoins_format" -->&amp;rft.au=<!-- TMPL_VAR NAME="author" -->&amp;rft.btitle=<!-- TMPL_VAR NAME="title" -->&amp;rft.date=<!-- TMPL_VAR NAME="publicationyear" -->&amp;rft.pages=<!-- TMPL_VAR NAME="pages" -->&amp;rft.isbn=<!-- TMPL_VAR NAME=amazonisbn -->&amp;rft.aucorp=&amp;rft.place=<!-- TMPL_VAR NAME="place" -->&amp;rft.pub=<!-- TMPL_VAR NAME="publishercode" -->&amp;rft.edition=<!-- TMPL_VAR NAME="edition" -->&amp;rft.series=<!-- TMPL_VAR NAME="series" -->&amp;rft.genre="
1375
1376     return $coins_value;
1377 }
1378
1379
1380 =head2 GetMarcPrice
1381
1382 return the prices in accordance with the Marc format.
1383
1384 returns 0 if no price found
1385 returns undef if called without a marc record or with
1386 an unrecognized marc format
1387
1388 =cut
1389
1390 sub GetMarcPrice {
1391     my ( $record, $marcflavour ) = @_;
1392     if (!$record) {
1393         carp 'GetMarcPrice called on undefined record';
1394         return;
1395     }
1396
1397     my @listtags;
1398     my $subfield;
1399
1400     if ( $marcflavour eq "MARC21" || $marcflavour eq "NORMARC" ) {
1401         @listtags = ('345', '020');
1402         $subfield="c";
1403     } elsif ( $marcflavour eq "UNIMARC" ) {
1404         @listtags = ('345', '010');
1405         $subfield="d";
1406     } else {
1407         return;
1408     }
1409
1410     for my $field ( $record->field(@listtags) ) {
1411         for my $subfield_value  ($field->subfield($subfield)){
1412             #check value
1413             $subfield_value = MungeMarcPrice( $subfield_value );
1414             return $subfield_value if ($subfield_value);
1415         }
1416     }
1417     return 0; # no price found
1418 }
1419
1420 =head2 MungeMarcPrice
1421
1422 Return the best guess at what the actual price is from a price field.
1423
1424 =cut
1425
1426 sub MungeMarcPrice {
1427     my ( $price ) = @_;
1428     return unless ( $price =~ m/\d/ ); ## No digits means no price.
1429     # Look for the currency symbol and the normalized code of the active currency, if it's there,
1430     my $active_currency = Koha::Acquisition::Currencies->get_active;
1431     my $symbol = $active_currency->symbol;
1432     my $isocode = $active_currency->isocode;
1433     $isocode = $active_currency->currency unless defined $isocode;
1434     my $localprice;
1435     if ( $symbol ) {
1436         my @matches =($price=~ /
1437             \s?
1438             (                          # start of capturing parenthesis
1439             (?:
1440             (?:[\p{Sc}\p{L}\/.]){1,4}  # any character from Currency signs or Letter Unicode categories or slash or dot                                              within 1 to 4 occurrences : call this whole block 'symbol block'
1441             |(?:\d+[\p{P}\s]?){1,4}    # or else at least one digit followed or not by a punctuation sign or whitespace,                                             all these within 1 to 4 occurrences : call this whole block 'digits block'
1442             )
1443             \s?\p{Sc}?\s?              # followed or not by a whitespace. \p{Sc}?\s? are for cases like '25$ USD'
1444             (?:
1445             (?:[\p{Sc}\p{L}\/.]){1,4}  # followed by same block as symbol block
1446             |(?:\d+[\p{P}\s]?){1,4}    # or by same block as digits block
1447             )
1448             \s?\p{L}{0,4}\s?           # followed or not by a whitespace. \p{L}{0,4}\s? are for cases like '$9.50 USD'
1449             )                          # end of capturing parenthesis
1450             (?:\p{P}|\z)               # followed by a punctuation sign or by the end of the string
1451             /gx);
1452
1453         if ( @matches ) {
1454             foreach ( @matches ) {
1455                 $localprice = $_ and last if index($_, $isocode)>=0;
1456             }
1457             if ( !$localprice ) {
1458                 foreach ( @matches ) {
1459                     $localprice = $_ and last if $_=~ /(^|[^\p{Sc}\p{L}\/])\Q$symbol\E([^\p{Sc}\p{L}\/]+\z|\z)/;
1460                 }
1461             }
1462         }
1463     }
1464     if ( $localprice ) {
1465         $price = $localprice;
1466     } else {
1467         ## Grab the first number in the string ( can use commas or periods for thousands separator and/or decimal separator )
1468         ( $price ) = $price =~ m/([\d\,\.]+[[\,\.]\d\d]?)/;
1469     }
1470     # eliminate symbol/isocode, space and any final dot from the string
1471     $price =~ s/[\p{Sc}\p{L}\/ ]|\.$//g;
1472     # remove comma,dot when used as separators from hundreds
1473     $price =~s/[\,\.](\d{3})/$1/g;
1474     # convert comma to dot to ensure correct display of decimals if existing
1475     $price =~s/,/./;
1476     return $price;
1477 }
1478
1479
1480 =head2 GetMarcQuantity
1481
1482 return the quantity of a book. Used in acquisition only, when importing a file an iso2709 from a bookseller
1483 Warning : this is not really in the marc standard. In Unimarc, Electre (the most widely used bookseller) use the 969$a
1484
1485 returns 0 if no quantity found
1486 returns undef if called without a marc record or with
1487 an unrecognized marc format
1488
1489 =cut
1490
1491 sub GetMarcQuantity {
1492     my ( $record, $marcflavour ) = @_;
1493     if (!$record) {
1494         carp 'GetMarcQuantity called on undefined record';
1495         return;
1496     }
1497
1498     my @listtags;
1499     my $subfield;
1500
1501     if ( $marcflavour eq "MARC21" ) {
1502         return 0
1503     } elsif ( $marcflavour eq "UNIMARC" ) {
1504         @listtags = ('969');
1505         $subfield="a";
1506     } else {
1507         return;
1508     }
1509
1510     for my $field ( $record->field(@listtags) ) {
1511         for my $subfield_value  ($field->subfield($subfield)){
1512             #check value
1513             if ($subfield_value) {
1514                  # in France, the cents separator is the , but sometimes, ppl use a .
1515                  # in this case, the price will be x100 when unformatted ! Replace the . by a , to get a proper price calculation
1516                 $subfield_value =~ s/\./,/ if C4::Context->preference("CurrencyFormat") eq "FR";
1517                 return $subfield_value;
1518             }
1519         }
1520     }
1521     return 0; # no price found
1522 }
1523
1524
1525 =head2 GetAuthorisedValueDesc
1526
1527   my $subfieldvalue =get_authorised_value_desc(
1528     $tag, $subf[$i][0],$subf[$i][1], '', $taglib, $category, $opac);
1529
1530 Retrieve the complete description for a given authorised value.
1531
1532 Now takes $category and $value pair too.
1533
1534   my $auth_value_desc =GetAuthorisedValueDesc(
1535     '','', 'DVD' ,'','','CCODE');
1536
1537 If the optional $opac parameter is set to a true value, displays OPAC
1538 descriptions rather than normal ones when they exist.
1539
1540 =cut
1541
1542 sub GetAuthorisedValueDesc {
1543     my ( $tag, $subfield, $value, $framework, $tagslib, $category, $opac ) = @_;
1544
1545     if ( !$category ) {
1546
1547         return $value unless defined $tagslib->{$tag}->{$subfield}->{'authorised_value'};
1548
1549         #---- branch
1550         if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
1551             return Koha::Libraries->find($value)->branchname;
1552         }
1553
1554         #---- itemtypes
1555         if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "itemtypes" ) {
1556             my $itemtype = Koha::ItemTypes->find( $value );
1557             return $itemtype ? $itemtype->translated_description : q||;
1558         }
1559
1560         #---- "true" authorized value
1561         $category = $tagslib->{$tag}->{$subfield}->{'authorised_value'};
1562     }
1563
1564     my $dbh = C4::Context->dbh;
1565     if ( $category ne "" ) {
1566         my $sth = $dbh->prepare( "SELECT lib, lib_opac FROM authorised_values WHERE category = ? AND authorised_value = ?" );
1567         $sth->execute( $category, $value );
1568         my $data = $sth->fetchrow_hashref;
1569         return ( $opac && $data->{'lib_opac'} ) ? $data->{'lib_opac'} : $data->{'lib'};
1570     } else {
1571         return $value;    # if nothing is found return the original value
1572     }
1573 }
1574
1575 =head2 GetMarcControlnumber
1576
1577   $marccontrolnumber = GetMarcControlnumber($record,$marcflavour);
1578
1579 Get the control number / record Identifier from the MARC record and return it.
1580
1581 =cut
1582
1583 sub GetMarcControlnumber {
1584     my ( $record, $marcflavour ) = @_;
1585     if (!$record) {
1586         carp 'GetMarcControlnumber called on undefined record';
1587         return;
1588     }
1589     my $controlnumber = "";
1590     # Control number or Record identifier are the same field in MARC21, UNIMARC and NORMARC
1591     # Keep $marcflavour for possible later use
1592     if ($marcflavour eq "MARC21" || $marcflavour eq "UNIMARC" || $marcflavour eq "NORMARC") {
1593         my $controlnumberField = $record->field('001');
1594         if ($controlnumberField) {
1595             $controlnumber = $controlnumberField->data();
1596         }
1597     }
1598     return $controlnumber;
1599 }
1600
1601 =head2 GetMarcISBN
1602
1603   $marcisbnsarray = GetMarcISBN( $record, $marcflavour );
1604
1605 Get all ISBNs from the MARC record and returns them in an array.
1606 ISBNs stored in different fields depending on MARC flavour
1607
1608 =cut
1609
1610 sub GetMarcISBN {
1611     my ( $record, $marcflavour ) = @_;
1612     if (!$record) {
1613         carp 'GetMarcISBN called on undefined record';
1614         return;
1615     }
1616     my $scope;
1617     if ( $marcflavour eq "UNIMARC" ) {
1618         $scope = '010';
1619     } else {    # assume marc21 if not unimarc
1620         $scope = '020';
1621     }
1622
1623     my @marcisbns;
1624     foreach my $field ( $record->field($scope) ) {
1625         my $isbn = $field->subfield( 'a' );
1626         if ( $isbn ne "" ) {
1627             push @marcisbns, $isbn;
1628         }
1629     }
1630
1631     return \@marcisbns;
1632 }    # end GetMarcISBN
1633
1634
1635 =head2 GetMarcISSN
1636
1637   $marcissnsarray = GetMarcISSN( $record, $marcflavour );
1638
1639 Get all valid ISSNs from the MARC record and returns them in an array.
1640 ISSNs are stored in different fields depending on MARC flavour
1641
1642 =cut
1643
1644 sub GetMarcISSN {
1645     my ( $record, $marcflavour ) = @_;
1646     if (!$record) {
1647         carp 'GetMarcISSN called on undefined record';
1648         return;
1649     }
1650     my $scope;
1651     if ( $marcflavour eq "UNIMARC" ) {
1652         $scope = '011';
1653     }
1654     else {    # assume MARC21 or NORMARC
1655         $scope = '022';
1656     }
1657     my @marcissns;
1658     foreach my $field ( $record->field($scope) ) {
1659         push @marcissns, $field->subfield( 'a' )
1660             if ( $field->subfield( 'a' ) ne "" );
1661     }
1662     return \@marcissns;
1663 }    # end GetMarcISSN
1664
1665 =head2 GetMarcNotes
1666
1667     $marcnotesarray = GetMarcNotes( $record, $marcflavour );
1668
1669     Get all notes from the MARC record and returns them in an array.
1670     The notes are stored in different fields depending on MARC flavour.
1671     MARC21 5XX $u subfields receive special attention as they are URIs.
1672
1673 =cut
1674
1675 sub GetMarcNotes {
1676     my ( $record, $marcflavour ) = @_;
1677     if (!$record) {
1678         carp 'GetMarcNotes called on undefined record';
1679         return;
1680     }
1681
1682     my $scope = $marcflavour eq "UNIMARC"? '3..': '5..';
1683     my @marcnotes;
1684     my %blacklist = map { $_ => 1 }
1685         split( /,/, C4::Context->preference('NotesBlacklist'));
1686     foreach my $field ( $record->field($scope) ) {
1687         my $tag = $field->tag();
1688         next if $blacklist{ $tag };
1689         if( $marcflavour ne 'UNIMARC' && $field->subfield('u') ) {
1690             # Field 5XX$u always contains URI
1691             # Examples: 505u, 506u, 510u, 514u, 520u, 530u, 538u, 540u, 542u, 552u, 555u, 561u, 563u, 583u
1692             # We first push the other subfields, then all $u's separately
1693             # Leave further actions to the template (see e.g. opac-detail)
1694             my $othersub =
1695                 join '', ( 'a' .. 't', 'v' .. 'z', '0' .. '9' ); # excl 'u'
1696             push @marcnotes, { marcnote => $field->as_string($othersub) };
1697             foreach my $sub ( $field->subfield('u') ) {
1698                 $sub =~ s/^\s+|\s+$//g; # trim
1699                 push @marcnotes, { marcnote => $sub };
1700             }
1701         } else {
1702             push @marcnotes, { marcnote => $field->as_string() };
1703         }
1704     }
1705     return \@marcnotes;
1706 }
1707
1708 =head2 GetMarcSubjects
1709
1710   $marcsubjcts = GetMarcSubjects($record,$marcflavour);
1711
1712 Get all subjects from the MARC record and returns them in an array.
1713 The subjects are stored in different fields depending on MARC flavour
1714
1715 =cut
1716
1717 sub GetMarcSubjects {
1718     my ( $record, $marcflavour ) = @_;
1719     if (!$record) {
1720         carp 'GetMarcSubjects called on undefined record';
1721         return;
1722     }
1723     my ( $mintag, $maxtag, $fields_filter );
1724     if ( $marcflavour eq "UNIMARC" ) {
1725         $mintag = "600";
1726         $maxtag = "611";
1727         $fields_filter = '6..';
1728     } else { # marc21/normarc
1729         $mintag = "600";
1730         $maxtag = "699";
1731         $fields_filter = '6..';
1732     }
1733
1734     my @marcsubjects;
1735
1736     my $subject_limit = C4::Context->preference("TraceCompleteSubfields") ? 'su,complete-subfield' : 'su';
1737     my $AuthoritySeparator = C4::Context->preference('AuthoritySeparator');
1738
1739     foreach my $field ( $record->field($fields_filter) ) {
1740         next unless ($field->tag() >= $mintag && $field->tag() <= $maxtag);
1741         my @subfields_loop;
1742         my @subfields = $field->subfields();
1743         my @link_loop;
1744
1745         # if there is an authority link, build the links with an= subfield9
1746         my $subfield9 = $field->subfield('9');
1747         my $authoritylink;
1748         if ($subfield9) {
1749             my $linkvalue = $subfield9;
1750             $linkvalue =~ s/(\(|\))//g;
1751             @link_loop = ( { limit => 'an', 'link' => $linkvalue } );
1752             $authoritylink = $linkvalue
1753         }
1754
1755         # other subfields
1756         for my $subject_subfield (@subfields) {
1757             next if ( $subject_subfield->[0] eq '9' );
1758
1759             # don't load unimarc subfields 3,4,5
1760             next if ( ( $marcflavour eq "UNIMARC" ) and ( $subject_subfield->[0] =~ /2|3|4|5/ ) );
1761             # don't load MARC21 subfields 2 (FIXME: any more subfields??)
1762             next if ( ( $marcflavour eq "MARC21" ) and ( $subject_subfield->[0] =~ /2/ ) );
1763
1764             my $code      = $subject_subfield->[0];
1765             my $value     = $subject_subfield->[1];
1766             my $linkvalue = $value;
1767             $linkvalue =~ s/(\(|\))//g;
1768             # if no authority link, build a search query
1769             unless ($subfield9) {
1770                 push @link_loop, {
1771                     limit    => $subject_limit,
1772                     'link'   => $linkvalue,
1773                     operator => (scalar @link_loop) ? ' and ' : undef
1774                 };
1775             }
1776             my @this_link_loop = @link_loop;
1777             # do not display $0
1778             unless ( $code eq '0' ) {
1779                 push @subfields_loop, {
1780                     code      => $code,
1781                     value     => $value,
1782                     link_loop => \@this_link_loop,
1783                     separator => (scalar @subfields_loop) ? $AuthoritySeparator : ''
1784                 };
1785             }
1786         }
1787
1788         push @marcsubjects, {
1789             MARCSUBJECT_SUBFIELDS_LOOP => \@subfields_loop,
1790             authoritylink => $authoritylink,
1791         } if $authoritylink || @subfields_loop;
1792
1793     }
1794     return \@marcsubjects;
1795 }    #end getMARCsubjects
1796
1797 =head2 GetMarcAuthors
1798
1799   authors = GetMarcAuthors($record,$marcflavour);
1800
1801 Get all authors from the MARC record and returns them in an array.
1802 The authors are stored in different fields depending on MARC flavour
1803
1804 =cut
1805
1806 sub GetMarcAuthors {
1807     my ( $record, $marcflavour ) = @_;
1808     if (!$record) {
1809         carp 'GetMarcAuthors called on undefined record';
1810         return;
1811     }
1812     my ( $mintag, $maxtag, $fields_filter );
1813
1814     # tagslib useful only for UNIMARC author responsibilities
1815     my $tagslib;
1816     if ( $marcflavour eq "UNIMARC" ) {
1817         # FIXME : we don't have the framework available, we take the default framework. May be buggy on some setups, will be usually correct.
1818         $tagslib = GetMarcStructure( 1, '', { unsafe => 1 });
1819         $mintag = "700";
1820         $maxtag = "712";
1821         $fields_filter = '7..';
1822     } else { # marc21/normarc
1823         $mintag = "700";
1824         $maxtag = "720";
1825         $fields_filter = '7..';
1826     }
1827
1828     my @marcauthors;
1829     my $AuthoritySeparator = C4::Context->preference('AuthoritySeparator');
1830
1831     foreach my $field ( $record->field($fields_filter) ) {
1832         next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
1833         my @subfields_loop;
1834         my @link_loop;
1835         my @subfields  = $field->subfields();
1836         my $count_auth = 0;
1837
1838         # if there is an authority link, build the link with Koha-Auth-Number: subfield9
1839         my $subfield9 = $field->subfield('9');
1840         if ($subfield9) {
1841             my $linkvalue = $subfield9;
1842             $linkvalue =~ s/(\(|\))//g;
1843             @link_loop = ( { 'limit' => 'an', 'link' => $linkvalue } );
1844         }
1845
1846         # other subfields
1847         my $unimarc3;
1848         for my $authors_subfield (@subfields) {
1849             next if ( $authors_subfield->[0] eq '9' );
1850
1851             # unimarc3 contains the $3 of the author for UNIMARC.
1852             # For french academic libraries, it's the "ppn", and it's required for idref webservice
1853             $unimarc3 = $authors_subfield->[1] if $marcflavour eq 'UNIMARC' and $authors_subfield->[0] =~ /3/;
1854
1855             # don't load unimarc subfields 3, 5
1856             next if ( $marcflavour eq 'UNIMARC' and ( $authors_subfield->[0] =~ /3|5/ ) );
1857
1858             my $code = $authors_subfield->[0];
1859             my $value        = $authors_subfield->[1];
1860             my $linkvalue    = $value;
1861             $linkvalue =~ s/(\(|\))//g;
1862             # UNIMARC author responsibility
1863             if ( $marcflavour eq 'UNIMARC' and $code eq '4' ) {
1864                 $value = GetAuthorisedValueDesc( $field->tag(), $code, $value, '', $tagslib );
1865                 $linkvalue = "($value)";
1866             }
1867             # if no authority link, build a search query
1868             unless ($subfield9) {
1869                 push @link_loop, {
1870                     limit    => 'au',
1871                     'link'   => $linkvalue,
1872                     operator => (scalar @link_loop) ? ' and ' : undef
1873                 };
1874             }
1875             my @this_link_loop = @link_loop;
1876             # do not display $0
1877             unless ( $code eq '0') {
1878                 push @subfields_loop, {
1879                     tag       => $field->tag(),
1880                     code      => $code,
1881                     value     => $value,
1882                     link_loop => \@this_link_loop,
1883                     separator => (scalar @subfields_loop) ? $AuthoritySeparator : ''
1884                 };
1885             }
1886         }
1887         push @marcauthors, {
1888             MARCAUTHOR_SUBFIELDS_LOOP => \@subfields_loop,
1889             authoritylink => $subfield9,
1890             unimarc3 => $unimarc3
1891         };
1892     }
1893     return \@marcauthors;
1894 }
1895
1896 =head2 GetMarcUrls
1897
1898   $marcurls = GetMarcUrls($record,$marcflavour);
1899
1900 Returns arrayref of URLs from MARC data, suitable to pass to tmpl loop.
1901 Assumes web resources (not uncommon in MARC21 to omit resource type ind)
1902
1903 =cut
1904
1905 sub GetMarcUrls {
1906     my ( $record, $marcflavour ) = @_;
1907     if (!$record) {
1908         carp 'GetMarcUrls called on undefined record';
1909         return;
1910     }
1911
1912     my @marcurls;
1913     for my $field ( $record->field('856') ) {
1914         my @notes;
1915         for my $note ( $field->subfield('z') ) {
1916             push @notes, { note => $note };
1917         }
1918         my @urls = $field->subfield('u');
1919         foreach my $url (@urls) {
1920             $url =~ s/^\s+|\s+$//g; # trim
1921             my $marcurl;
1922             if ( $marcflavour eq 'MARC21' ) {
1923                 my $s3   = $field->subfield('3');
1924                 my $link = $field->subfield('y');
1925                 unless ( $url =~ /^\w+:/ ) {
1926                     if ( $field->indicator(1) eq '7' ) {
1927                         $url = $field->subfield('2') . "://" . $url;
1928                     } elsif ( $field->indicator(1) eq '1' ) {
1929                         $url = 'ftp://' . $url;
1930                     } else {
1931
1932                         #  properly, this should be if ind1=4,
1933                         #  however we will assume http protocol since we're building a link.
1934                         $url = 'http://' . $url;
1935                     }
1936                 }
1937
1938                 # TODO handle ind 2 (relationship)
1939                 $marcurl = {
1940                     MARCURL => $url,
1941                     notes   => \@notes,
1942                 };
1943                 $marcurl->{'linktext'} = $link || $s3 || C4::Context->preference('URLLinkText') || $url;
1944                 $marcurl->{'part'} = $s3 if ($link);
1945                 $marcurl->{'toc'} = 1 if ( defined($s3) && $s3 =~ /^[Tt]able/ );
1946             } else {
1947                 $marcurl->{'linktext'} = $field->subfield('2') || C4::Context->preference('URLLinkText') || $url;
1948                 $marcurl->{'MARCURL'} = $url;
1949             }
1950             push @marcurls, $marcurl;
1951         }
1952     }
1953     return \@marcurls;
1954 }
1955
1956 =head2 GetMarcSeries
1957
1958   $marcseriesarray = GetMarcSeries($record,$marcflavour);
1959
1960 Get all series from the MARC record and returns them in an array.
1961 The series are stored in different fields depending on MARC flavour
1962
1963 =cut
1964
1965 sub GetMarcSeries {
1966     my ( $record, $marcflavour ) = @_;
1967     if (!$record) {
1968         carp 'GetMarcSeries called on undefined record';
1969         return;
1970     }
1971
1972     my ( $mintag, $maxtag, $fields_filter );
1973     if ( $marcflavour eq "UNIMARC" ) {
1974         $mintag = "225";
1975         $maxtag = "225";
1976         $fields_filter = '2..';
1977     } else {    # marc21/normarc
1978         $mintag = "440";
1979         $maxtag = "490";
1980         $fields_filter = '4..';
1981     }
1982
1983     my @marcseries;
1984     my $AuthoritySeparator = C4::Context->preference('AuthoritySeparator');
1985
1986     foreach my $field ( $record->field($fields_filter) ) {
1987         next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
1988         my @subfields_loop;
1989         my @subfields = $field->subfields();
1990         my @link_loop;
1991
1992         for my $series_subfield (@subfields) {
1993
1994             # ignore $9, used for authority link
1995             next if ( $series_subfield->[0] eq '9' );
1996
1997             my $volume_number;
1998             my $code      = $series_subfield->[0];
1999             my $value     = $series_subfield->[1];
2000             my $linkvalue = $value;
2001             $linkvalue =~ s/(\(|\))//g;
2002
2003             # see if this is an instance of a volume
2004             if ( $code eq 'v' ) {
2005                 $volume_number = 1;
2006             }
2007
2008             push @link_loop, {
2009                 'link' => $linkvalue,
2010                 operator => (scalar @link_loop) ? ' and ' : undef
2011             };
2012
2013             if ($volume_number) {
2014                 push @subfields_loop, { volumenum => $value };
2015             } else {
2016                 push @subfields_loop, {
2017                     code      => $code,
2018                     value     => $value,
2019                     link_loop => \@link_loop,
2020                     separator => (scalar @subfields_loop) ? $AuthoritySeparator : '',
2021                     volumenum => $volume_number,
2022                 }
2023             }
2024         }
2025         push @marcseries, { MARCSERIES_SUBFIELDS_LOOP => \@subfields_loop };
2026
2027     }
2028     return \@marcseries;
2029 }    #end getMARCseriess
2030
2031 =head2 GetMarcHosts
2032
2033   $marchostsarray = GetMarcHosts($record,$marcflavour);
2034
2035 Get all host records (773s MARC21, 461 UNIMARC) from the MARC record and returns them in an array.
2036
2037 =cut
2038
2039 sub GetMarcHosts {
2040     my ( $record, $marcflavour ) = @_;
2041     if (!$record) {
2042         carp 'GetMarcHosts called on undefined record';
2043         return;
2044     }
2045
2046     my ( $tag,$title_subf,$bibnumber_subf,$itemnumber_subf);
2047     $marcflavour ||="MARC21";
2048     if ( $marcflavour eq "MARC21" || $marcflavour eq "NORMARC" ) {
2049         $tag = "773";
2050         $title_subf = "t";
2051         $bibnumber_subf ="0";
2052         $itemnumber_subf='9';
2053     }
2054     elsif ($marcflavour eq "UNIMARC") {
2055         $tag = "461";
2056         $title_subf = "t";
2057         $bibnumber_subf ="0";
2058         $itemnumber_subf='9';
2059     };
2060
2061     my @marchosts;
2062
2063     foreach my $field ( $record->field($tag)) {
2064
2065         my @fields_loop;
2066
2067         my $hostbiblionumber = $field->subfield("$bibnumber_subf");
2068         my $hosttitle = $field->subfield($title_subf);
2069         my $hostitemnumber=$field->subfield($itemnumber_subf);
2070         push @fields_loop, { hostbiblionumber => $hostbiblionumber, hosttitle => $hosttitle, hostitemnumber => $hostitemnumber};
2071         push @marchosts, { MARCHOSTS_FIELDS_LOOP => \@fields_loop };
2072
2073         }
2074     my $marchostsarray = \@marchosts;
2075     return $marchostsarray;
2076 }
2077
2078 =head2 UpsertMarcSubfield
2079
2080     my $record = C4::Biblio::UpsertMarcSubfield($MARC::Record, $fieldTag, $subfieldCode, $subfieldContent);
2081
2082 =cut
2083
2084 sub UpsertMarcSubfield {
2085     my ($record, $tag, $code, $content) = @_;
2086     my $f = $record->field($tag);
2087
2088     if ($f) {
2089         $f->update( $code => $content );
2090     }
2091     else {
2092         my $f = MARC::Field->new( $tag, '', '', $code => $content);
2093         $record->insert_fields_ordered( $f );
2094     }
2095 }
2096
2097 =head2 UpsertMarcControlField
2098
2099     my $record = C4::Biblio::UpsertMarcControlField($MARC::Record, $fieldTag, $content);
2100
2101 =cut
2102
2103 sub UpsertMarcControlField {
2104     my ($record, $tag, $content) = @_;
2105     die "UpsertMarcControlField() \$tag '$tag' is not a control field\n" unless 0+$tag < 10;
2106     my $f = $record->field($tag);
2107
2108     if ($f) {
2109         $f->update( $content );
2110     }
2111     else {
2112         my $f = MARC::Field->new($tag, $content);
2113         $record->insert_fields_ordered( $f );
2114     }
2115 }
2116
2117 =head2 GetFrameworkCode
2118
2119   $frameworkcode = GetFrameworkCode( $biblionumber )
2120
2121 =cut
2122
2123 sub GetFrameworkCode {
2124     my ($biblionumber) = @_;
2125     my $dbh            = C4::Context->dbh;
2126     my $sth            = $dbh->prepare("SELECT frameworkcode FROM biblio WHERE biblionumber=?");
2127     $sth->execute($biblionumber);
2128     my ($frameworkcode) = $sth->fetchrow;
2129     return $frameworkcode;
2130 }
2131
2132 =head2 TransformKohaToMarc
2133
2134     $record = TransformKohaToMarc( $hash [, $params ]  )
2135
2136 This function builds a (partial) MARC::Record from a hash.
2137 Hash entries can be from biblio, biblioitems or items.
2138 The params hash includes the parameter no_split used in C4::Items.
2139
2140 This function is called in acquisition module, to create a basic catalogue
2141 entry from user entry.
2142
2143 =cut
2144
2145
2146 sub TransformKohaToMarc {
2147     my ( $hash, $params ) = @_;
2148     my $record = MARC::Record->new();
2149     SetMarcUnicodeFlag( $record, C4::Context->preference("marcflavour") );
2150
2151     # In the next call we use the Default framework, since it is considered
2152     # authoritative for Koha to Marc mappings.
2153     my $mss = GetMarcSubfieldStructure( '', { unsafe => 1 } ); # do not change framewok
2154     my $tag_hr = {};
2155     while ( my ($kohafield, $value) = each %$hash ) {
2156         foreach my $fld ( @{ $mss->{$kohafield} } ) {
2157             my $tagfield    = $fld->{tagfield};
2158             my $tagsubfield = $fld->{tagsubfield};
2159             next if !$tagfield;
2160             my @values = $params->{no_split}
2161                 ? ( $value )
2162                 : split(/\s?\|\s?/, $value, -1);
2163             foreach my $value ( @values ) {
2164                 next if $value eq '';
2165                 $tag_hr->{$tagfield} //= [];
2166                 push @{$tag_hr->{$tagfield}}, [($tagsubfield, $value)];
2167             }
2168         }
2169     }
2170     foreach my $tag (sort keys %$tag_hr) {
2171         my @sfl = @{$tag_hr->{$tag}};
2172         @sfl = sort { $a->[0] cmp $b->[0]; } @sfl;
2173         @sfl = map { @{$_}; } @sfl;
2174         # Special care for control fields: remove the subfield indication @
2175         # and do not insert indicators.
2176         my @ind = $tag < 10 ? () : ( " ", " " );
2177         @sfl = grep { $_ ne '@' } @sfl if $tag < 10;
2178         $record->insert_fields_ordered( MARC::Field->new($tag, @ind, @sfl) );
2179     }
2180     return $record;
2181 }
2182
2183 =head2 PrepHostMarcField
2184
2185     $hostfield = PrepHostMarcField ( $hostbiblionumber,$hostitemnumber,$marcflavour )
2186
2187 This function returns a host field populated with data from the host record, the field can then be added to an analytical record
2188
2189 =cut
2190
2191 sub PrepHostMarcField {
2192     my ($hostbiblionumber,$hostitemnumber, $marcflavour) = @_;
2193     $marcflavour ||="MARC21";
2194
2195     require C4::Items;
2196     my $hostrecord = GetMarcBiblio({ biblionumber => $hostbiblionumber });
2197         my $item = C4::Items::GetItem($hostitemnumber);
2198
2199         my $hostmarcfield;
2200     if ( $marcflavour eq "MARC21" || $marcflavour eq "NORMARC" ) {
2201
2202         #main entry
2203         my $mainentry;
2204         if ($hostrecord->subfield('100','a')){
2205             $mainentry = $hostrecord->subfield('100','a');
2206         } elsif ($hostrecord->subfield('110','a')){
2207             $mainentry = $hostrecord->subfield('110','a');
2208         } else {
2209             $mainentry = $hostrecord->subfield('111','a');
2210         }
2211
2212         # qualification info
2213         my $qualinfo;
2214         if (my $field260 = $hostrecord->field('260')){
2215             $qualinfo =  $field260->as_string( 'abc' );
2216         }
2217
2218
2219         #other fields
2220         my $ed = $hostrecord->subfield('250','a');
2221         my $barcode = $item->{'barcode'};
2222         my $title = $hostrecord->subfield('245','a');
2223
2224         # record control number, 001 with 003 and prefix
2225         my $recctrlno;
2226         if ($hostrecord->field('001')){
2227             $recctrlno = $hostrecord->field('001')->data();
2228             if ($hostrecord->field('003')){
2229                 $recctrlno = '('.$hostrecord->field('003')->data().')'.$recctrlno;
2230             }
2231         }
2232
2233         # issn/isbn
2234         my $issn = $hostrecord->subfield('022','a');
2235         my $isbn = $hostrecord->subfield('020','a');
2236
2237
2238         $hostmarcfield = MARC::Field->new(
2239                 773, '0', '',
2240                 '0' => $hostbiblionumber,
2241                 '9' => $hostitemnumber,
2242                 'a' => $mainentry,
2243                 'b' => $ed,
2244                 'd' => $qualinfo,
2245                 'o' => $barcode,
2246                 't' => $title,
2247                 'w' => $recctrlno,
2248                 'x' => $issn,
2249                 'z' => $isbn
2250                 );
2251     } elsif ($marcflavour eq "UNIMARC") {
2252         $hostmarcfield = MARC::Field->new(
2253             461, '', '',
2254             '0' => $hostbiblionumber,
2255             't' => $hostrecord->subfield('200','a'),
2256             '9' => $hostitemnumber
2257         );
2258     };
2259
2260     return $hostmarcfield;
2261 }
2262
2263 =head2 TransformHtmlToXml
2264
2265   $xml = TransformHtmlToXml( $tags, $subfields, $values, $indicator,
2266                              $ind_tag, $auth_type )
2267
2268 $auth_type contains :
2269
2270 =over
2271
2272 =item - nothing : rebuild a biblio. In UNIMARC the encoding is in 100$a pos 26/27
2273
2274 =item - UNIMARCAUTH : rebuild an authority. In UNIMARC, the encoding is in 100$a pos 13/14
2275
2276 =item - ITEM : rebuild an item : in UNIMARC, 100$a, it's in the biblio ! (otherwise, we would get 2 100 fields !)
2277
2278 =back
2279
2280 =cut
2281
2282 sub TransformHtmlToXml {
2283     my ( $tags, $subfields, $values, $indicator, $ind_tag, $auth_type ) = @_;
2284     # NOTE: The parameter $ind_tag is NOT USED -- BZ 11247
2285
2286     my $xml = MARC::File::XML::header('UTF-8');
2287     $xml .= "<record>\n";
2288     $auth_type = C4::Context->preference('marcflavour') unless $auth_type;
2289     MARC::File::XML->default_record_format($auth_type);
2290
2291     # in UNIMARC, field 100 contains the encoding
2292     # check that there is one, otherwise the
2293     # MARC::Record->new_from_xml will fail (and Koha will die)
2294     my $unimarc_and_100_exist = 0;
2295     $unimarc_and_100_exist = 1 if $auth_type eq 'ITEM';    # if we rebuild an item, no need of a 100 field
2296     my $prevvalue;
2297     my $prevtag = -1;
2298     my $first   = 1;
2299     my $j       = -1;
2300     my $close_last_tag;
2301     for ( my $i = 0 ; $i < @$tags ; $i++ ) {
2302
2303         if ( C4::Context->preference('marcflavour') eq 'UNIMARC' and @$tags[$i] eq "100" and @$subfields[$i] eq "a" ) {
2304
2305             # if we have a 100 field and it's values are not correct, skip them.
2306             # if we don't have any valid 100 field, we will create a default one at the end
2307             my $enc = substr( @$values[$i], 26, 2 );
2308             if ( $enc eq '01' or $enc eq '50' or $enc eq '03' ) {
2309                 $unimarc_and_100_exist = 1;
2310             } else {
2311                 next;
2312             }
2313         }
2314         @$values[$i] =~ s/&/&amp;/g;
2315         @$values[$i] =~ s/</&lt;/g;
2316         @$values[$i] =~ s/>/&gt;/g;
2317         @$values[$i] =~ s/"/&quot;/g;
2318         @$values[$i] =~ s/'/&apos;/g;
2319
2320         if ( ( @$tags[$i] ne $prevtag ) ) {
2321             $close_last_tag = 0;
2322             $j++ unless ( @$tags[$i] eq "" );
2323             my $indicator1 = eval { substr( @$indicator[$j], 0, 1 ) };
2324             my $indicator2 = eval { substr( @$indicator[$j], 1, 1 ) };
2325             my $ind1       = _default_ind_to_space($indicator1);
2326             my $ind2;
2327             if ( @$indicator[$j] ) {
2328                 $ind2 = _default_ind_to_space($indicator2);
2329             } else {
2330                 warn "Indicator in @$tags[$i] is empty";
2331                 $ind2 = " ";
2332             }
2333             if ( !$first ) {
2334                 $xml .= "</datafield>\n";
2335                 if (   ( @$tags[$i] && @$tags[$i] > 10 )
2336                     && ( @$values[$i] ne "" ) ) {
2337                     $xml .= "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
2338                     $xml .= "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
2339                     $first = 0;
2340                     $close_last_tag = 1;
2341                 } else {
2342                     $first = 1;
2343                 }
2344             } else {
2345                 if ( @$values[$i] ne "" ) {
2346
2347                     # leader
2348                     if ( @$tags[$i] eq "000" ) {
2349                         $xml .= "<leader>@$values[$i]</leader>\n";
2350                         $first = 1;
2351
2352                         # rest of the fixed fields
2353                     } elsif ( @$tags[$i] < 10 ) {
2354                         $xml .= "<controlfield tag=\"@$tags[$i]\">@$values[$i]</controlfield>\n";
2355                         $first = 1;
2356                     } else {
2357                         $xml .= "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
2358                         $xml .= "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
2359                         $first = 0;
2360                         $close_last_tag = 1;
2361                     }
2362                 }
2363             }
2364         } else {    # @$tags[$i] eq $prevtag
2365             my $indicator1 = eval { substr( @$indicator[$j], 0, 1 ) };
2366             my $indicator2 = eval { substr( @$indicator[$j], 1, 1 ) };
2367             my $ind1       = _default_ind_to_space($indicator1);
2368             my $ind2;
2369             if ( @$indicator[$j] ) {
2370                 $ind2 = _default_ind_to_space($indicator2);
2371             } else {
2372                 warn "Indicator in @$tags[$i] is empty";
2373                 $ind2 = " ";
2374             }
2375             if ( @$values[$i] eq "" ) {
2376             } else {
2377                 if ($first) {
2378                     $xml .= "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
2379                     $first = 0;
2380                     $close_last_tag = 1;
2381                 }
2382                 $xml .= "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
2383             }
2384         }
2385         $prevtag = @$tags[$i];
2386     }
2387     $xml .= "</datafield>\n" if $close_last_tag;
2388     if ( C4::Context->preference('marcflavour') eq 'UNIMARC' and !$unimarc_and_100_exist ) {
2389
2390         #     warn "SETTING 100 for $auth_type";
2391         my $string = strftime( "%Y%m%d", localtime(time) );
2392
2393         # set 50 to position 26 is biblios, 13 if authorities
2394         my $pos = 26;
2395         $pos = 13 if $auth_type eq 'UNIMARCAUTH';
2396         $string = sprintf( "%-*s", 35, $string );
2397         substr( $string, $pos, 6, "50" );
2398         $xml .= "<datafield tag=\"100\" ind1=\"\" ind2=\"\">\n";
2399         $xml .= "<subfield code=\"a\">$string</subfield>\n";
2400         $xml .= "</datafield>\n";
2401     }
2402     $xml .= "</record>\n";
2403     $xml .= MARC::File::XML::footer();
2404     return $xml;
2405 }
2406
2407 =head2 _default_ind_to_space
2408
2409 Passed what should be an indicator returns a space
2410 if its undefined or zero length
2411
2412 =cut
2413
2414 sub _default_ind_to_space {
2415     my $s = shift;
2416     if ( !defined $s || $s eq q{} ) {
2417         return ' ';
2418     }
2419     return $s;
2420 }
2421
2422 =head2 TransformHtmlToMarc
2423
2424     L<$record> = TransformHtmlToMarc(L<$cgi>)
2425     L<$cgi> is the CGI object which contains the values for subfields
2426     {
2427         'tag_010_indicator1_531951' ,
2428         'tag_010_indicator2_531951' ,
2429         'tag_010_code_a_531951_145735' ,
2430         'tag_010_subfield_a_531951_145735' ,
2431         'tag_200_indicator1_873510' ,
2432         'tag_200_indicator2_873510' ,
2433         'tag_200_code_a_873510_673465' ,
2434         'tag_200_subfield_a_873510_673465' ,
2435         'tag_200_code_b_873510_704318' ,
2436         'tag_200_subfield_b_873510_704318' ,
2437         'tag_200_code_e_873510_280822' ,
2438         'tag_200_subfield_e_873510_280822' ,
2439         'tag_200_code_f_873510_110730' ,
2440         'tag_200_subfield_f_873510_110730' ,
2441     }
2442     L<$record> is the MARC::Record object.
2443
2444 =cut
2445
2446 sub TransformHtmlToMarc {
2447     my ($cgi, $isbiblio) = @_;
2448
2449     my @params = $cgi->multi_param();
2450
2451     # explicitly turn on the UTF-8 flag for all
2452     # 'tag_' parameters to avoid incorrect character
2453     # conversion later on
2454     my $cgi_params = $cgi->Vars;
2455     foreach my $param_name ( keys %$cgi_params ) {
2456         if ( $param_name =~ /^tag_/ ) {
2457             my $param_value = $cgi_params->{$param_name};
2458             unless ( Encode::is_utf8( $param_value ) ) {
2459                 $cgi_params->{$param_name} = Encode::decode('UTF-8', $param_value );
2460             }
2461         }
2462     }
2463
2464     # creating a new record
2465     my $record = MARC::Record->new();
2466     my @fields;
2467     my ($biblionumbertagfield, $biblionumbertagsubfield) = (-1, -1);
2468     ($biblionumbertagfield, $biblionumbertagsubfield) =
2469         &GetMarcFromKohaField( "biblio.biblionumber", '' ) if $isbiblio;
2470 #FIXME This code assumes that the CGI params will be in the same order as the fields in the template; this is no absolute guarantee!
2471     for (my $i = 0; $params[$i]; $i++ ) {    # browse all CGI params
2472         my $param    = $params[$i];
2473         my $newfield = 0;
2474
2475         # if we are on biblionumber, store it in the MARC::Record (it may not be in the edited fields)
2476         if ( $param eq 'biblionumber' ) {
2477             if ( $biblionumbertagfield < 10 ) {
2478                 $newfield = MARC::Field->new( $biblionumbertagfield, scalar $cgi->param($param), );
2479             } else {
2480                 $newfield = MARC::Field->new( $biblionumbertagfield, '', '', "$biblionumbertagsubfield" => scalar $cgi->param($param), );
2481             }
2482             push @fields, $newfield if ($newfield);
2483         } elsif ( $param =~ /^tag_(\d*)_indicator1_/ ) {    # new field start when having 'input name="..._indicator1_..."
2484             my $tag = $1;
2485
2486             my $ind1 = _default_ind_to_space( substr( $cgi->param($param), 0, 1 ) );
2487             my $ind2 = _default_ind_to_space( substr( $cgi->param( $params[ $i + 1 ] ), 0, 1 ) );
2488             $newfield = 0;
2489             my $j = $i + 2;
2490
2491             if ( $tag < 10 ) {                              # no code for theses fields
2492                                                             # in MARC editor, 000 contains the leader.
2493                 next if $tag == $biblionumbertagfield;
2494                 my $fval= $cgi->param($params[$j+1]);
2495                 if ( $tag eq '000' ) {
2496                     # Force a fake leader even if not provided to avoid crashing
2497                     # during decoding MARC record containing UTF-8 characters
2498                     $record->leader(
2499                         length( $fval ) == 24
2500                         ? $fval
2501                         : '     nam a22        4500'
2502                         )
2503                     ;
2504                     # between 001 and 009 (included)
2505                 } elsif ( $fval ne '' ) {
2506                     $newfield = MARC::Field->new( $tag, $fval, );
2507                 }
2508
2509                 # > 009, deal with subfields
2510             } else {
2511                 # browse subfields for this tag (reason for _code_ match)
2512                 while(defined $params[$j] && $params[$j] =~ /_code_/) {
2513                     last unless defined $params[$j+1];
2514                     $j += 2 and next
2515                         if $tag == $biblionumbertagfield and
2516                            $cgi->param($params[$j]) eq $biblionumbertagsubfield;
2517                     #if next param ne subfield, then it was probably empty
2518                     #try next param by incrementing j
2519                     if($params[$j+1]!~/_subfield_/) {$j++; next; }
2520                     my $fkey= $cgi->param($params[$j]);
2521                     my $fval= $cgi->param($params[$j+1]);
2522                     #check if subfield value not empty and field exists
2523                     if($fval ne '' && $newfield) {
2524                         $newfield->add_subfields( $fkey => $fval);
2525                     }
2526                     elsif($fval ne '') {
2527                         $newfield = MARC::Field->new( $tag, $ind1, $ind2, $fkey => $fval );
2528                     }
2529                     $j += 2;
2530                 } #end-of-while
2531                 $i= $j-1; #update i for outer loop accordingly
2532             }
2533             push @fields, $newfield if ($newfield);
2534         }
2535     }
2536
2537     $record->append_fields(@fields);
2538     return $record;
2539 }
2540
2541 =head2 TransformMarcToKoha
2542
2543     $result = TransformMarcToKoha( $record, undef, $limit )
2544
2545 Extract data from a MARC bib record into a hashref representing
2546 Koha biblio, biblioitems, and items fields.
2547
2548 If passed an undefined record will log the error and return an empty
2549 hash_ref.
2550
2551 =cut
2552
2553 sub TransformMarcToKoha {
2554     my ( $record, $frameworkcode, $limit_table ) = @_;
2555     # FIXME  Parameter $frameworkcode is obsolete and will be removed
2556     $limit_table //= q{};
2557
2558     my $result = {};
2559     if (!defined $record) {
2560         carp('TransformMarcToKoha called with undefined record');
2561         return $result;
2562     }
2563
2564     my %tables = ( biblio => 1, biblioitems => 1, items => 1 );
2565     if( $limit_table eq 'items' ) {
2566         %tables = ( items => 1 );
2567     }
2568
2569     # The next call acknowledges Default as the authoritative framework
2570     # for Koha to MARC mappings.
2571     my $mss = GetMarcSubfieldStructure( '', { unsafe => 1 } ); # Do not change framework
2572     foreach my $kohafield ( keys %{ $mss } ) {
2573         my ( $table, $column ) = split /[.]/, $kohafield, 2;
2574         next unless $tables{$table};
2575         my $val = TransformMarcToKohaOneField( $kohafield, $record );
2576         next if !defined $val;
2577         my $key = _disambiguate( $table, $column );
2578         $result->{$key} = $val;
2579     }
2580     return $result;
2581 }
2582
2583 =head2 _disambiguate
2584
2585   $newkey = _disambiguate($table, $field);
2586
2587 This is a temporary hack to distinguish between the
2588 following sets of columns when using TransformMarcToKoha.
2589
2590   items.cn_source & biblioitems.cn_source
2591   items.cn_sort & biblioitems.cn_sort
2592
2593 Columns that are currently NOT distinguished (FIXME
2594 due to lack of time to fully test) are:
2595
2596   biblio.notes and biblioitems.notes
2597   biblionumber
2598   timestamp
2599   biblioitemnumber
2600
2601 FIXME - this is necessary because prefixing each column
2602 name with the table name would require changing lots
2603 of code and templates, and exposing more of the DB
2604 structure than is good to the UI templates, particularly
2605 since biblio and bibloitems may well merge in a future
2606 version.  In the future, it would also be good to
2607 separate DB access and UI presentation field names
2608 more.
2609
2610 =cut
2611
2612 sub _disambiguate {
2613     my ( $table, $column ) = @_;
2614     if ( $column eq "cn_sort" or $column eq "cn_source" ) {
2615         return $table . '.' . $column;
2616     } else {
2617         return $column;
2618     }
2619
2620 }
2621
2622 =head2 TransformMarcToKohaOneField
2623
2624     $val = TransformMarcToKohaOneField( 'biblio.title', $marc );
2625
2626     Note: The authoritative Default framework is used implicitly.
2627
2628 =cut
2629
2630 sub TransformMarcToKohaOneField {
2631     my ( $kohafield, $marc ) = @_;
2632
2633     my ( @rv, $retval );
2634     my @mss = GetMarcSubfieldStructureFromKohaField($kohafield);
2635     foreach my $fldhash ( @mss ) {
2636         my $tag = $fldhash->{tagfield};
2637         my $sub = $fldhash->{tagsubfield};
2638         foreach my $fld ( $marc->field($tag) ) {
2639             if( $sub eq '@' || $fld->is_control_field ) {
2640                 push @rv, $fld->data if $fld->data;
2641             } else {
2642                 push @rv, grep { $_ } $fld->subfield($sub);
2643             }
2644         }
2645     }
2646     return unless @rv;
2647     $retval = join ' | ', uniq(@rv);
2648
2649     # Additional polishing for individual kohafields
2650     if( $kohafield =~ /copyrightdate|publicationyear/ ) {
2651         $retval = _adjust_pubyear( $retval );
2652     }
2653
2654     return $retval;
2655 }
2656
2657 =head2 _adjust_pubyear
2658
2659     Helper routine for TransformMarcToKohaOneField
2660
2661 =cut
2662
2663 sub _adjust_pubyear {
2664     my $retval = shift;
2665     # modify return value to keep only the 1st year found
2666     if( $retval =~ m/c(\d\d\d\d)/ and $1 > 0 ) { # search cYYYY first
2667         $retval = $1;
2668     } elsif( $retval =~ m/(\d\d\d\d)/ && $1 > 0 ) {
2669         $retval = $1;
2670     } elsif( $retval =~ m/
2671              (?<year>\d)[-]?[.Xx?]{3}
2672             |(?<year>\d{2})[.Xx?]{2}
2673             |(?<year>\d{3})[.Xx?]
2674             |(?<year>\d)[-]{3}\?
2675             |(?<year>\d\d)[-]{2}\?
2676             |(?<year>\d{3})[-]\?
2677     /xms ) { # the form 198-? occurred in Dutch ISBD rules
2678         my $digits = $+{year};
2679         $retval = $digits * ( 10 ** ( 4 - length($digits) ));
2680     }
2681     return $retval;
2682 }
2683
2684 =head2 CountItemsIssued
2685
2686     my $count = CountItemsIssued( $biblionumber );
2687
2688 =cut
2689
2690 sub CountItemsIssued {
2691     my ($biblionumber) = @_;
2692     my $dbh            = C4::Context->dbh;
2693     my $sth            = $dbh->prepare('SELECT COUNT(*) as issuedCount FROM items, issues WHERE items.itemnumber = issues.itemnumber AND items.biblionumber = ?');
2694     $sth->execute($biblionumber);
2695     my $row = $sth->fetchrow_hashref();
2696     return $row->{'issuedCount'};
2697 }
2698
2699 =head2 ModZebra
2700
2701   ModZebra( $biblionumber, $op, $server, $record );
2702
2703 $biblionumber is the biblionumber we want to index
2704
2705 $op is specialUpdate or recordDelete, and is used to know what we want to do
2706
2707 $server is the server that we want to update
2708
2709 $record is the update MARC record if it's available. If it's not supplied
2710 and is needed, it'll be loaded from the database.
2711
2712 =cut
2713
2714 sub ModZebra {
2715 ###Accepts a $server variable thus we can use it for biblios authorities or other zebra dbs
2716     my ( $biblionumber, $op, $server, $record ) = @_;
2717     $debug && warn "ModZebra: update requested for: $biblionumber $op $server\n";
2718     if ( C4::Context->preference('SearchEngine') eq 'Elasticsearch' ) {
2719
2720         # TODO abstract to a standard API that'll work for whatever
2721         require Koha::SearchEngine::Elasticsearch::Indexer;
2722         my $indexer = Koha::SearchEngine::Elasticsearch::Indexer->new(
2723             {
2724                 index => $server eq 'biblioserver'
2725                 ? $Koha::SearchEngine::BIBLIOS_INDEX
2726                 : $Koha::SearchEngine::AUTHORITIES_INDEX
2727             }
2728         );
2729         if ( $op eq 'specialUpdate' ) {
2730             unless ($record) {
2731                 $record = GetMarcBiblio({
2732                     biblionumber => $biblionumber,
2733                     embed_items  => 1 });
2734             }
2735             my $records = [$record];
2736             $indexer->update_index_background( [$biblionumber], [$record] );
2737         }
2738         elsif ( $op eq 'recordDelete' ) {
2739             $indexer->delete_index_background( [$biblionumber] );
2740         }
2741         else {
2742             croak "ModZebra called with unknown operation: $op";
2743         }
2744     }
2745
2746     my $dbh = C4::Context->dbh;
2747
2748     # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
2749     # at the same time
2750     # replaced by a zebraqueue table, that is filled with ModZebra to run.
2751     # the table is emptied by rebuild_zebra.pl script (using the -z switch)
2752     my $check_sql = "SELECT COUNT(*) FROM zebraqueue
2753     WHERE server = ?
2754         AND   biblio_auth_number = ?
2755         AND   operation = ?
2756         AND   done = 0";
2757     my $check_sth = $dbh->prepare_cached($check_sql);
2758     $check_sth->execute( $server, $biblionumber, $op );
2759     my ($count) = $check_sth->fetchrow_array;
2760     $check_sth->finish();
2761     if ( $count == 0 ) {
2762         my $sth = $dbh->prepare("INSERT INTO zebraqueue  (biblio_auth_number,server,operation) VALUES(?,?,?)");
2763         $sth->execute( $biblionumber, $server, $op );
2764         $sth->finish;
2765     }
2766 }
2767
2768
2769 =head2 EmbedItemsInMarcBiblio
2770
2771     EmbedItemsInMarcBiblio({
2772         marc_record  => $marc,
2773         biblionumber => $biblionumber,
2774         item_numbers => $itemnumbers,
2775         opac         => $opac });
2776
2777 Given a MARC::Record object containing a bib record,
2778 modify it to include the items attached to it as 9XX
2779 per the bib's MARC framework.
2780 if $itemnumbers is defined, only specified itemnumbers are embedded.
2781
2782 If $opac is true, then opac-relevant suppressions are included.
2783
2784 If opac filtering will be done, borcat should be passed to properly
2785 override if necessary.
2786
2787 =cut
2788
2789 sub EmbedItemsInMarcBiblio {
2790     my ($params) = @_;
2791     my ($marc, $biblionumber, $itemnumbers, $opac, $borcat);
2792     $marc = $params->{marc_record};
2793     if ( !$marc ) {
2794         carp 'EmbedItemsInMarcBiblio: No MARC record passed';
2795         return;
2796     }
2797     $biblionumber = $params->{biblionumber};
2798     $itemnumbers = $params->{item_numbers};
2799     $opac = $params->{opac};
2800     $borcat = $params->{borcat} // q{};
2801
2802     $itemnumbers = [] unless defined $itemnumbers;
2803
2804     my $frameworkcode = GetFrameworkCode($biblionumber);
2805     _strip_item_fields($marc, $frameworkcode);
2806
2807     # ... and embed the current items
2808     my $dbh = C4::Context->dbh;
2809     my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber = ?");
2810     $sth->execute($biblionumber);
2811     my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
2812
2813     my @item_fields; # Array holding the actual MARC data for items to be included.
2814     my @items;       # Array holding items which are both in the list (sitenumbers)
2815                      # and on this biblionumber
2816
2817     # Flag indicating if there is potential hiding.
2818     my $opachiddenitems = $opac
2819       && ( C4::Context->preference('OpacHiddenItems') !~ /^\s*$/ );
2820
2821     require C4::Items;
2822     while ( my ($itemnumber) = $sth->fetchrow_array ) {
2823         next if @$itemnumbers and not grep { $_ == $itemnumber } @$itemnumbers;
2824         my $i = $opachiddenitems ? C4::Items::GetItem($itemnumber) : undef;
2825         push @items, { itemnumber => $itemnumber, item => $i };
2826     }
2827     my @items2pass = map { $_->{item} } @items;
2828     my @hiddenitems =
2829       $opachiddenitems
2830       ? C4::Items::GetHiddenItemnumbers({
2831             items  => \@items2pass,
2832             borcat => $borcat })
2833       : ();
2834     # Convert to a hash for quick searching
2835     my %hiddenitems = map { $_ => 1 } @hiddenitems;
2836     foreach my $itemnumber ( map { $_->{itemnumber} } @items ) {
2837         next if $hiddenitems{$itemnumber};
2838         my $item_marc = C4::Items::GetMarcItem( $biblionumber, $itemnumber );
2839         push @item_fields, $item_marc->field($itemtag);
2840     }
2841     $marc->append_fields(@item_fields);
2842 }
2843
2844 =head1 INTERNAL FUNCTIONS
2845
2846 =head2 _koha_marc_update_bib_ids
2847
2848
2849   _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
2850
2851 Internal function to add or update biblionumber and biblioitemnumber to
2852 the MARC XML.
2853
2854 =cut
2855
2856 sub _koha_marc_update_bib_ids {
2857     my ( $record, $frameworkcode, $biblionumber, $biblioitemnumber ) = @_;
2858
2859     my ( $biblio_tag,     $biblio_subfield )     = GetMarcFromKohaField( "biblio.biblionumber",          $frameworkcode );
2860     die qq{No biblionumber tag for framework "$frameworkcode"} unless $biblio_tag;
2861     my ( $biblioitem_tag, $biblioitem_subfield ) = GetMarcFromKohaField( "biblioitems.biblioitemnumber", $frameworkcode );
2862     die qq{No biblioitemnumber tag for framework "$frameworkcode"} unless $biblioitem_tag;
2863
2864     if ( $biblio_tag < 10 ) {
2865         C4::Biblio::UpsertMarcControlField( $record, $biblio_tag, $biblionumber );
2866     } else {
2867         C4::Biblio::UpsertMarcSubfield($record, $biblio_tag, $biblio_subfield, $biblionumber);
2868     }
2869     if ( $biblioitem_tag < 10 ) {
2870         C4::Biblio::UpsertMarcControlField( $record, $biblioitem_tag, $biblioitemnumber );
2871     } else {
2872         C4::Biblio::UpsertMarcSubfield($record, $biblioitem_tag, $biblioitem_subfield, $biblioitemnumber);
2873     }
2874 }
2875
2876 =head2 _koha_marc_update_biblioitem_cn_sort
2877
2878   _koha_marc_update_biblioitem_cn_sort($marc, $biblioitem, $frameworkcode);
2879
2880 Given a MARC bib record and the biblioitem hash, update the
2881 subfield that contains a copy of the value of biblioitems.cn_sort.
2882
2883 =cut
2884
2885 sub _koha_marc_update_biblioitem_cn_sort {
2886     my $marc          = shift;
2887     my $biblioitem    = shift;
2888     my $frameworkcode = shift;
2889
2890     my ( $biblioitem_tag, $biblioitem_subfield ) = GetMarcFromKohaField( "biblioitems.cn_sort", $frameworkcode );
2891     return unless $biblioitem_tag;
2892
2893     my ($cn_sort) = GetClassSort( $biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
2894
2895     if ( my $field = $marc->field($biblioitem_tag) ) {
2896         $field->delete_subfield( code => $biblioitem_subfield );
2897         if ( $cn_sort ne '' ) {
2898             $field->add_subfields( $biblioitem_subfield => $cn_sort );
2899         }
2900     } else {
2901
2902         # if we get here, no biblioitem tag is present in the MARC record, so
2903         # we'll create it if $cn_sort is not empty -- this would be
2904         # an odd combination of events, however
2905         if ($cn_sort) {
2906             $marc->insert_grouped_field( MARC::Field->new( $biblioitem_tag, ' ', ' ', $biblioitem_subfield => $cn_sort ) );
2907         }
2908     }
2909 }
2910
2911 =head2 _koha_add_biblio
2912
2913   my ($biblionumber,$error) = _koha_add_biblio($dbh,$biblioitem);
2914
2915 Internal function to add a biblio ($biblio is a hash with the values)
2916
2917 =cut
2918
2919 sub _koha_add_biblio {
2920     my ( $dbh, $biblio, $frameworkcode ) = @_;
2921
2922     my $error;
2923
2924     # set the series flag
2925     unless (defined $biblio->{'serial'}){
2926         $biblio->{'serial'} = 0;
2927         if ( $biblio->{'seriestitle'} ) { $biblio->{'serial'} = 1 }
2928     }
2929
2930     my $query = "INSERT INTO biblio
2931         SET frameworkcode = ?,
2932             author = ?,
2933             title = ?,
2934             unititle =?,
2935             notes = ?,
2936             serial = ?,
2937             seriestitle = ?,
2938             copyrightdate = ?,
2939             datecreated=NOW(),
2940             abstract = ?
2941         ";
2942     my $sth = $dbh->prepare($query);
2943     $sth->execute(
2944         $frameworkcode, $biblio->{'author'},      $biblio->{'title'},         $biblio->{'unititle'}, $biblio->{'notes'},
2945         $biblio->{'serial'},        $biblio->{'seriestitle'}, $biblio->{'copyrightdate'}, $biblio->{'abstract'}
2946     );
2947
2948     my $biblionumber = $dbh->{'mysql_insertid'};
2949     if ( $dbh->errstr ) {
2950         $error .= "ERROR in _koha_add_biblio $query" . $dbh->errstr;
2951         warn $error;
2952     }
2953
2954     $sth->finish();
2955
2956     #warn "LEAVING _koha_add_biblio: ".$biblionumber."\n";
2957     return ( $biblionumber, $error );
2958 }
2959
2960 =head2 _koha_modify_biblio
2961
2962   my ($biblionumber,$error) == _koha_modify_biblio($dbh,$biblio,$frameworkcode);
2963
2964 Internal function for updating the biblio table
2965
2966 =cut
2967
2968 sub _koha_modify_biblio {
2969     my ( $dbh, $biblio, $frameworkcode ) = @_;
2970     my $error;
2971
2972     my $query = "
2973         UPDATE biblio
2974         SET    frameworkcode = ?,
2975                author = ?,
2976                title = ?,
2977                unititle = ?,
2978                notes = ?,
2979                serial = ?,
2980                seriestitle = ?,
2981                copyrightdate = ?,
2982                abstract = ?
2983         WHERE  biblionumber = ?
2984         "
2985       ;
2986     my $sth = $dbh->prepare($query);
2987
2988     $sth->execute(
2989         $frameworkcode,      $biblio->{'author'},      $biblio->{'title'},         $biblio->{'unititle'}, $biblio->{'notes'},
2990         $biblio->{'serial'}, $biblio->{'seriestitle'}, $biblio->{'copyrightdate'}, $biblio->{'abstract'}, $biblio->{'biblionumber'}
2991     ) if $biblio->{'biblionumber'};
2992
2993     if ( $dbh->errstr || !$biblio->{'biblionumber'} ) {
2994         $error .= "ERROR in _koha_modify_biblio $query" . $dbh->errstr;
2995         warn $error;
2996     }
2997     return ( $biblio->{'biblionumber'}, $error );
2998 }
2999
3000 =head2 _koha_modify_biblioitem_nonmarc
3001
3002   my ($biblioitemnumber,$error) = _koha_modify_biblioitem_nonmarc( $dbh, $biblioitem );
3003
3004 =cut
3005
3006 sub _koha_modify_biblioitem_nonmarc {
3007     my ( $dbh, $biblioitem ) = @_;
3008     my $error;
3009
3010     # re-calculate the cn_sort, it may have changed
3011     my ($cn_sort) = GetClassSort( $biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
3012
3013     my $query = "UPDATE biblioitems
3014     SET biblionumber    = ?,
3015         volume          = ?,
3016         number          = ?,
3017         itemtype        = ?,
3018         isbn            = ?,
3019         issn            = ?,
3020         publicationyear = ?,
3021         publishercode   = ?,
3022         volumedate      = ?,
3023         volumedesc      = ?,
3024         collectiontitle = ?,
3025         collectionissn  = ?,
3026         collectionvolume= ?,
3027         editionstatement= ?,
3028         editionresponsibility = ?,
3029         illus           = ?,
3030         pages           = ?,
3031         notes           = ?,
3032         size            = ?,
3033         place           = ?,
3034         lccn            = ?,
3035         url             = ?,
3036         cn_source       = ?,
3037         cn_class        = ?,
3038         cn_item         = ?,
3039         cn_suffix       = ?,
3040         cn_sort         = ?,
3041         totalissues     = ?,
3042         ean             = ?,
3043         agerestriction  = ?
3044         where biblioitemnumber = ?
3045         ";
3046     my $sth = $dbh->prepare($query);
3047     $sth->execute(
3048         $biblioitem->{'biblionumber'},     $biblioitem->{'volume'},           $biblioitem->{'number'},                $biblioitem->{'itemtype'},
3049         $biblioitem->{'isbn'},             $biblioitem->{'issn'},             $biblioitem->{'publicationyear'},       $biblioitem->{'publishercode'},
3050         $biblioitem->{'volumedate'},       $biblioitem->{'volumedesc'},       $biblioitem->{'collectiontitle'},       $biblioitem->{'collectionissn'},
3051         $biblioitem->{'collectionvolume'}, $biblioitem->{'editionstatement'}, $biblioitem->{'editionresponsibility'}, $biblioitem->{'illus'},
3052         $biblioitem->{'pages'},            $biblioitem->{'bnotes'},           $biblioitem->{'size'},                  $biblioitem->{'place'},
3053         $biblioitem->{'lccn'},             $biblioitem->{'url'},              $biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'},
3054         $biblioitem->{'cn_item'},          $biblioitem->{'cn_suffix'},        $cn_sort,                               $biblioitem->{'totalissues'},
3055         $biblioitem->{'ean'},              $biblioitem->{'agerestriction'},   $biblioitem->{'biblioitemnumber'}
3056     );
3057     if ( $dbh->errstr ) {
3058         $error .= "ERROR in _koha_modify_biblioitem_nonmarc $query" . $dbh->errstr;
3059         warn $error;
3060     }
3061     return ( $biblioitem->{'biblioitemnumber'}, $error );
3062 }
3063
3064 =head2 _koha_add_biblioitem
3065
3066   my ($biblioitemnumber,$error) = _koha_add_biblioitem( $dbh, $biblioitem );
3067
3068 Internal function to add a biblioitem
3069
3070 =cut
3071
3072 sub _koha_add_biblioitem {
3073     my ( $dbh, $biblioitem ) = @_;
3074     my $error;
3075
3076     my ($cn_sort) = GetClassSort( $biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
3077     my $query = "INSERT INTO biblioitems SET
3078         biblionumber    = ?,
3079         volume          = ?,
3080         number          = ?,
3081         itemtype        = ?,
3082         isbn            = ?,
3083         issn            = ?,
3084         publicationyear = ?,
3085         publishercode   = ?,
3086         volumedate      = ?,
3087         volumedesc      = ?,
3088         collectiontitle = ?,
3089         collectionissn  = ?,
3090         collectionvolume= ?,
3091         editionstatement= ?,
3092         editionresponsibility = ?,
3093         illus           = ?,
3094         pages           = ?,
3095         notes           = ?,
3096         size            = ?,
3097         place           = ?,
3098         lccn            = ?,
3099         url             = ?,
3100         cn_source       = ?,
3101         cn_class        = ?,
3102         cn_item         = ?,
3103         cn_suffix       = ?,
3104         cn_sort         = ?,
3105         totalissues     = ?,
3106         ean             = ?,
3107         agerestriction  = ?
3108         ";
3109     my $sth = $dbh->prepare($query);
3110     $sth->execute(
3111         $biblioitem->{'biblionumber'},     $biblioitem->{'volume'},           $biblioitem->{'number'},                $biblioitem->{'itemtype'},
3112         $biblioitem->{'isbn'},             $biblioitem->{'issn'},             $biblioitem->{'publicationyear'},       $biblioitem->{'publishercode'},
3113         $biblioitem->{'volumedate'},       $biblioitem->{'volumedesc'},       $biblioitem->{'collectiontitle'},       $biblioitem->{'collectionissn'},
3114         $biblioitem->{'collectionvolume'}, $biblioitem->{'editionstatement'}, $biblioitem->{'editionresponsibility'}, $biblioitem->{'illus'},
3115         $biblioitem->{'pages'},            $biblioitem->{'bnotes'},           $biblioitem->{'size'},                  $biblioitem->{'place'},
3116         $biblioitem->{'lccn'},             $biblioitem->{'url'},                   $biblioitem->{'biblioitems.cn_source'},
3117         $biblioitem->{'cn_class'},         $biblioitem->{'cn_item'},          $biblioitem->{'cn_suffix'},             $cn_sort,
3118         $biblioitem->{'totalissues'},      $biblioitem->{'ean'},              $biblioitem->{'agerestriction'}
3119     );
3120     my $bibitemnum = $dbh->{'mysql_insertid'};
3121
3122     if ( $dbh->errstr ) {
3123         $error .= "ERROR in _koha_add_biblioitem $query" . $dbh->errstr;
3124         warn $error;
3125     }
3126     $sth->finish();
3127     return ( $bibitemnum, $error );
3128 }
3129
3130 =head2 _koha_delete_biblio
3131
3132   $error = _koha_delete_biblio($dbh,$biblionumber);
3133
3134 Internal sub for deleting from biblio table -- also saves to deletedbiblio
3135
3136 C<$dbh> - the database handle
3137
3138 C<$biblionumber> - the biblionumber of the biblio to be deleted
3139
3140 =cut
3141
3142 # FIXME: add error handling
3143
3144 sub _koha_delete_biblio {
3145     my ( $dbh, $biblionumber ) = @_;
3146
3147     # get all the data for this biblio
3148     my $sth = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber=?");
3149     $sth->execute($biblionumber);
3150
3151     # FIXME There is a transaction in _koha_delete_biblio_metadata
3152     # But actually all the following should be done inside a single transaction
3153     if ( my $data = $sth->fetchrow_hashref ) {
3154
3155         # save the record in deletedbiblio
3156         # find the fields to save
3157         my $query = "INSERT INTO deletedbiblio SET ";
3158         my @bind  = ();
3159         foreach my $temp ( keys %$data ) {
3160             $query .= "$temp = ?,";
3161             push( @bind, $data->{$temp} );
3162         }
3163
3164         # replace the last , by ",?)"
3165         $query =~ s/\,$//;
3166         my $bkup_sth = $dbh->prepare($query);
3167         $bkup_sth->execute(@bind);
3168         $bkup_sth->finish;
3169
3170         _koha_delete_biblio_metadata( $biblionumber );
3171
3172         # delete the biblio
3173         my $sth2 = $dbh->prepare("DELETE FROM biblio WHERE biblionumber=?");
3174         $sth2->execute($biblionumber);
3175         # update the timestamp (Bugzilla 7146)
3176         $sth2= $dbh->prepare("UPDATE deletedbiblio SET timestamp=NOW() WHERE biblionumber=?");
3177         $sth2->execute($biblionumber);
3178         $sth2->finish;
3179     }
3180     $sth->finish;
3181     return;
3182 }
3183
3184 =head2 _koha_delete_biblioitems
3185
3186   $error = _koha_delete_biblioitems($dbh,$biblioitemnumber);
3187
3188 Internal sub for deleting from biblioitems table -- also saves to deletedbiblioitems
3189
3190 C<$dbh> - the database handle
3191 C<$biblionumber> - the biblioitemnumber of the biblioitem to be deleted
3192
3193 =cut
3194
3195 # FIXME: add error handling
3196
3197 sub _koha_delete_biblioitems {
3198     my ( $dbh, $biblioitemnumber ) = @_;
3199
3200     # get all the data for this biblioitem
3201     my $sth = $dbh->prepare("SELECT * FROM biblioitems WHERE biblioitemnumber=?");
3202     $sth->execute($biblioitemnumber);
3203
3204     if ( my $data = $sth->fetchrow_hashref ) {
3205
3206         # save the record in deletedbiblioitems
3207         # find the fields to save
3208         my $query = "INSERT INTO deletedbiblioitems SET ";
3209         my @bind  = ();
3210         foreach my $temp ( keys %$data ) {
3211             $query .= "$temp = ?,";
3212             push( @bind, $data->{$temp} );
3213         }
3214
3215         # replace the last , by ",?)"
3216         $query =~ s/\,$//;
3217         my $bkup_sth = $dbh->prepare($query);
3218         $bkup_sth->execute(@bind);
3219         $bkup_sth->finish;
3220
3221         # delete the biblioitem
3222         my $sth2 = $dbh->prepare("DELETE FROM biblioitems WHERE biblioitemnumber=?");
3223         $sth2->execute($biblioitemnumber);
3224         # update the timestamp (Bugzilla 7146)
3225         $sth2= $dbh->prepare("UPDATE deletedbiblioitems SET timestamp=NOW() WHERE biblioitemnumber=?");
3226         $sth2->execute($biblioitemnumber);
3227         $sth2->finish;
3228     }
3229     $sth->finish;
3230     return;
3231 }
3232
3233 =head2 _koha_delete_biblio_metadata
3234
3235   $error = _koha_delete_biblio_metadata($biblionumber);
3236
3237 C<$biblionumber> - the biblionumber of the biblio metadata to be deleted
3238
3239 =cut
3240
3241 sub _koha_delete_biblio_metadata {
3242     my ($biblionumber) = @_;
3243
3244     my $dbh    = C4::Context->dbh;
3245     my $schema = Koha::Database->new->schema;
3246     $schema->txn_do(
3247         sub {
3248             $dbh->do( q|
3249                 INSERT INTO deletedbiblio_metadata (biblionumber, format, marcflavour, metadata)
3250                 SELECT biblionumber, format, marcflavour, metadata FROM biblio_metadata WHERE biblionumber=?
3251             |,  undef, $biblionumber );
3252             $dbh->do( q|DELETE FROM biblio_metadata WHERE biblionumber=?|,
3253                 undef, $biblionumber );
3254         }
3255     );
3256 }
3257
3258 =head1 UNEXPORTED FUNCTIONS
3259
3260 =head2 ModBiblioMarc
3261
3262   &ModBiblioMarc($newrec,$biblionumber,$frameworkcode);
3263
3264 Add MARC XML data for a biblio to koha
3265
3266 Function exported, but should NOT be used, unless you really know what you're doing
3267
3268 =cut
3269
3270 sub ModBiblioMarc {
3271     # pass the MARC::Record to this function, and it will create the records in
3272     # the marcxml field
3273     my ( $record, $biblionumber, $frameworkcode ) = @_;
3274     if ( !$record ) {
3275         carp 'ModBiblioMarc passed an undefined record';
3276         return;
3277     }
3278
3279     # Clone record as it gets modified
3280     $record = $record->clone();
3281     my $dbh    = C4::Context->dbh;
3282     my @fields = $record->fields();
3283     if ( !$frameworkcode ) {
3284         $frameworkcode = "";
3285     }
3286     my $sth = $dbh->prepare("UPDATE biblio SET frameworkcode=? WHERE biblionumber=?");
3287     $sth->execute( $frameworkcode, $biblionumber );
3288     $sth->finish;
3289     my $encoding = C4::Context->preference("marcflavour");
3290
3291     # deal with UNIMARC field 100 (encoding) : create it if needed & set encoding to unicode
3292     if ( $encoding eq "UNIMARC" ) {
3293         my $defaultlanguage = C4::Context->preference("UNIMARCField100Language");
3294         $defaultlanguage = "fre" if (!$defaultlanguage || length($defaultlanguage) != 3);
3295         my $string = $record->subfield( 100, "a" );
3296         if ( ($string) && ( length( $record->subfield( 100, "a" ) ) == 36 ) ) {
3297             my $f100 = $record->field(100);
3298             $record->delete_field($f100);
3299         } else {
3300             $string = POSIX::strftime( "%Y%m%d", localtime );
3301             $string =~ s/\-//g;
3302             $string = sprintf( "%-*s", 35, $string );
3303             substr ( $string, 22, 3, $defaultlanguage);
3304         }
3305         substr( $string, 25, 3, "y50" );
3306         unless ( $record->subfield( 100, "a" ) ) {
3307             $record->insert_fields_ordered( MARC::Field->new( 100, "", "", "a" => $string ) );
3308         }
3309     }
3310
3311     #enhancement 5374: update transaction date (005) for marc21/unimarc
3312     if($encoding =~ /MARC21|UNIMARC/) {
3313       my @a= (localtime) [5,4,3,2,1,0]; $a[0]+=1900; $a[1]++;
3314         # YY MM DD HH MM SS (update year and month)
3315       my $f005= $record->field('005');
3316       $f005->update(sprintf("%4d%02d%02d%02d%02d%04.1f",@a)) if $f005;
3317     }
3318
3319     my $metadata = {
3320         biblionumber => $biblionumber,
3321         format       => 'marcxml',
3322         marcflavour  => C4::Context->preference('marcflavour'),
3323     };
3324     $record->as_usmarc; # Bug 20126/10455 This triggers field length calculation
3325
3326     # FIXME To replace with ->find_or_create?
3327     if ( my $m_rs = Koha::Biblio::Metadatas->find($metadata) ) {
3328         $m_rs->metadata( $record->as_xml_record($encoding) );
3329         $m_rs->store;
3330     } else {
3331         my $m_rs = Koha::Biblio::Metadata->new($metadata);
3332         $m_rs->metadata( $record->as_xml_record($encoding) );
3333         $m_rs->store;
3334     }
3335     ModZebra( $biblionumber, "specialUpdate", "biblioserver", $record );
3336     return $biblionumber;
3337 }
3338
3339 =head2 CountBiblioInOrders
3340
3341     $count = &CountBiblioInOrders( $biblionumber);
3342
3343 This function return count of biblios in orders with $biblionumber
3344
3345 =cut
3346
3347 sub CountBiblioInOrders {
3348  my ($biblionumber) = @_;
3349     my $dbh            = C4::Context->dbh;
3350     my $query          = "SELECT count(*)
3351           FROM  aqorders
3352           WHERE biblionumber=? AND (datecancellationprinted IS NULL OR datecancellationprinted='0000-00-00')";
3353     my $sth = $dbh->prepare($query);
3354     $sth->execute($biblionumber);
3355     my $count = $sth->fetchrow;
3356     return ($count);
3357 }
3358
3359 =head2 prepare_host_field
3360
3361 $marcfield = prepare_host_field( $hostbiblioitem, $marcflavour );
3362 Generate the host item entry for an analytic child entry
3363
3364 =cut
3365
3366 sub prepare_host_field {
3367     my ( $hostbiblio, $marcflavour ) = @_;
3368     $marcflavour ||= C4::Context->preference('marcflavour');
3369     my $host = GetMarcBiblio({ biblionumber => $hostbiblio });
3370     # unfortunately as_string does not 'do the right thing'
3371     # if field returns undef
3372     my %sfd;
3373     my $field;
3374     my $host_field;
3375     if ( $marcflavour eq 'MARC21' || $marcflavour eq 'NORMARC' ) {
3376         if ( $field = $host->field('100') || $host->field('110') || $host->field('11') ) {
3377             my $s = $field->as_string('ab');
3378             if ($s) {
3379                 $sfd{a} = $s;
3380             }
3381         }
3382         if ( $field = $host->field('245') ) {
3383             my $s = $field->as_string('a');
3384             if ($s) {
3385                 $sfd{t} = $s;
3386             }
3387         }
3388         if ( $field = $host->field('260') ) {
3389             my $s = $field->as_string('abc');
3390             if ($s) {
3391                 $sfd{d} = $s;
3392             }
3393         }
3394         if ( $field = $host->field('240') ) {
3395             my $s = $field->as_string();
3396             if ($s) {
3397                 $sfd{b} = $s;
3398             }
3399         }
3400         if ( $field = $host->field('022') ) {
3401             my $s = $field->as_string('a');
3402             if ($s) {
3403                 $sfd{x} = $s;
3404             }
3405         }
3406         if ( $field = $host->field('020') ) {
3407             my $s = $field->as_string('a');
3408             if ($s) {
3409                 $sfd{z} = $s;
3410             }
3411         }
3412         if ( $field = $host->field('001') ) {
3413             $sfd{w} = $field->data(),;
3414         }
3415         $host_field = MARC::Field->new( 773, '0', ' ', %sfd );
3416         return $host_field;
3417     }
3418     elsif ( $marcflavour eq 'UNIMARC' ) {
3419         #author
3420         if ( $field = $host->field('700') || $host->field('710') || $host->field('720') ) {
3421             my $s = $field->as_string('ab');
3422             if ($s) {
3423                 $sfd{a} = $s;
3424             }
3425         }
3426         #title
3427         if ( $field = $host->field('200') ) {
3428             my $s = $field->as_string('a');
3429             if ($s) {
3430                 $sfd{t} = $s;
3431             }
3432         }
3433         #place of publicaton
3434         if ( $field = $host->field('210') ) {
3435             my $s = $field->as_string('a');
3436             if ($s) {
3437                 $sfd{c} = $s;
3438             }
3439         }
3440         #date of publication
3441         if ( $field = $host->field('210') ) {
3442             my $s = $field->as_string('d');
3443             if ($s) {
3444                 $sfd{d} = $s;
3445             }
3446         }
3447         #edition statement
3448         if ( $field = $host->field('205') ) {
3449             my $s = $field->as_string();
3450             if ($s) {
3451                 $sfd{e} = $s;
3452             }
3453         }
3454         #URL
3455         if ( $field = $host->field('856') ) {
3456             my $s = $field->as_string('u');
3457             if ($s) {
3458                 $sfd{u} = $s;
3459             }
3460         }
3461         #ISSN
3462         if ( $field = $host->field('011') ) {
3463             my $s = $field->as_string('a');
3464             if ($s) {
3465                 $sfd{x} = $s;
3466             }
3467         }
3468         #ISBN
3469         if ( $field = $host->field('010') ) {
3470             my $s = $field->as_string('a');
3471             if ($s) {
3472                 $sfd{y} = $s;
3473             }
3474         }
3475         if ( $field = $host->field('001') ) {
3476             $sfd{0} = $field->data(),;
3477         }
3478         $host_field = MARC::Field->new( 461, '0', ' ', %sfd );
3479         return $host_field;
3480     }
3481     return;
3482 }
3483
3484
3485 =head2 UpdateTotalIssues
3486
3487   UpdateTotalIssues($biblionumber, $increase, [$value])
3488
3489 Update the total issue count for a particular bib record.
3490
3491 =over 4
3492
3493 =item C<$biblionumber> is the biblionumber of the bib to update
3494
3495 =item C<$increase> is the amount to increase (or decrease) the total issues count by
3496
3497 =item C<$value> is the absolute value that total issues count should be set to. If provided, C<$increase> is ignored.
3498
3499 =back
3500
3501 =cut
3502
3503 sub UpdateTotalIssues {
3504     my ($biblionumber, $increase, $value) = @_;
3505     my $totalissues;
3506
3507     my $record = GetMarcBiblio({ biblionumber => $biblionumber });
3508     unless ($record) {
3509         carp "UpdateTotalIssues could not get biblio record";
3510         return;
3511     }
3512     my $biblio = Koha::Biblios->find( $biblionumber );
3513     unless ($biblio) {
3514         carp "UpdateTotalIssues could not get datas of biblio";
3515         return;
3516     }
3517     my $biblioitem = $biblio->biblioitem;
3518     my ($totalissuestag, $totalissuessubfield) = GetMarcFromKohaField('biblioitems.totalissues', $biblio->frameworkcode);
3519     unless ($totalissuestag) {
3520         return 1; # There is nothing to do
3521     }
3522
3523     if (defined $value) {
3524         $totalissues = $value;
3525     } else {
3526         $totalissues = $biblioitem->totalissues + $increase;
3527     }
3528
3529      my $field = $record->field($totalissuestag);
3530      if (defined $field) {
3531          $field->update( $totalissuessubfield => $totalissues );
3532      } else {
3533          $field = MARC::Field->new($totalissuestag, '0', '0',
3534                  $totalissuessubfield => $totalissues);
3535          $record->insert_grouped_field($field);
3536      }
3537
3538      return ModBiblio($record, $biblionumber, $biblio->frameworkcode);
3539 }
3540
3541 =head2 RemoveAllNsb
3542
3543     &RemoveAllNsb($record);
3544
3545 Removes all nsb/nse chars from a record
3546
3547 =cut
3548
3549 sub RemoveAllNsb {
3550     my $record = shift;
3551     if (!$record) {
3552         carp 'RemoveAllNsb called with undefined record';
3553         return;
3554     }
3555
3556     SetUTF8Flag($record);
3557
3558     foreach my $field ($record->fields()) {
3559         if ($field->is_control_field()) {
3560             $field->update(nsb_clean($field->data()));
3561         } else {
3562             my @subfields = $field->subfields();
3563             my @new_subfields;
3564             foreach my $subfield (@subfields) {
3565                 push @new_subfields, $subfield->[0] => nsb_clean($subfield->[1]);
3566             }
3567             if (scalar(@new_subfields) > 0) {
3568                 my $new_field;
3569                 eval {
3570                     $new_field = MARC::Field->new(
3571                         $field->tag(),
3572                         $field->indicator(1),
3573                         $field->indicator(2),
3574                         @new_subfields
3575                     );
3576                 };
3577                 if ($@) {
3578                     warn "error in RemoveAllNsb : $@";
3579                 } else {
3580                     $field->replace_with($new_field);
3581                 }
3582             }
3583         }
3584     }
3585
3586     return $record;
3587 }
3588
3589 1;
3590
3591
3592 __END__
3593
3594 =head1 AUTHOR
3595
3596 Koha Development Team <http://koha-community.org/>
3597
3598 Paul POULAIN paul.poulain@free.fr
3599
3600 Joshua Ferraro jmf@liblime.com
3601
3602 =cut