C4/Biblio.pm

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