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