C4/Items.pm

   1 package C4::Items;
   2
   3 # Copyright 2007 LibLime, Inc.
   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 with
  17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  18 # Suite 330, Boston, MA  02111-1307 USA
  19
  20 use strict;
  21
  22 use C4::Context;
  23 use C4::Koha;
  24 use C4::Biblio;
  25 use C4::Dates qw/format_date format_date_in_iso/;
  26 use MARC::Record;
  27 use C4::ClassSource;
  28 use C4::Log;
  29 use C4::Branch;
  30 require C4::Reserves;
  31 use C4::Charset;
  32
  33 use vars qw($VERSION @ISA @EXPORT);
  34
  35 BEGIN {
  36     $VERSION = 3.01;
  37
  38         require Exporter;
  39     @ISA = qw( Exporter );
  40
  41     # function exports
  42     @EXPORT = qw(
  43         GetItem
  44         AddItemFromMarc
  45         AddItem
  46         AddItemBatchFromMarc
  47         ModItemFromMarc
  48         ModItem
  49         ModDateLastSeen
  50         ModItemTransfer
  51         DelItem
  52
  53         CheckItemPreSave
  54
  55         GetItemStatus
  56         GetItemLocation
  57         GetLostItems
  58         GetItemsForInventory
  59         GetItemsCount
  60         GetItemInfosOf
  61         GetItemsByBiblioitemnumber
  62         GetItemsInfo
  63         get_itemnumbers_of
  64         GetItemnumberFromBarcode
  65     );
  66 }
  67
  68 =head1 NAME
  69
  70 C4::Items - item management functions
  71
  72 =head1 DESCRIPTION
  73
  74 This module contains an API for manipulating item
  75 records in Koha, and is used by cataloguing, circulation,
  76 acquisitions, and serials management.
  77
  78 A Koha item record is stored in two places: the
  79 items table and embedded in a MARC tag in the XML
  80 version of the associated bib record in C<biblioitems.marcxml>.
  81 This is done to allow the item information to be readily
  82 indexed (e.g., by Zebra), but means that each item
  83 modification transaction must keep the items table
  84 and the MARC XML in sync at all times.
  85
  86 Consequently, all code that creates, modifies, or deletes
  87 item records B<must> use an appropriate function from
  88 C<C4::Items>.  If no existing function is suitable, it is
  89 better to add one to C<C4::Items> than to use add
  90 one-off SQL statements to add or modify items.
  91
  92 The items table will be considered authoritative.  In other
  93 words, if there is ever a discrepancy between the items
  94 table and the MARC XML, the items table should be considered
  95 accurate.
  96
  97 =head1 HISTORICAL NOTE
  98
  99 Most of the functions in C<C4::Items> were originally in
 100 the C<C4::Biblio> module.
 101
 102 =head1 CORE EXPORTED FUNCTIONS
 103
 104 The following functions are meant for use by users
 105 of C<C4::Items>
 106
 107 =cut
 108
 109 =head2 GetItem
 110
 111 =over 4
 112
 113 $item = GetItem($itemnumber,$barcode,$serial);
 114
 115 =back
 116
 117 Return item information, for a given itemnumber or barcode.
 118 The return value is a hashref mapping item column
 119 names to values.  If C<$serial> is true, include serial publication data.
 120
 121 =cut
 122
 123 sub GetItem {
 124     my ($itemnumber,$barcode, $serial) = @_;
 125     my $dbh = C4::Context->dbh;
 126         my $data;
 127     if ($itemnumber) {
 128         my $sth = $dbh->prepare("
 129             SELECT * FROM items
 130             WHERE itemnumber = ?");
 131         $sth->execute($itemnumber);
 132         $data = $sth->fetchrow_hashref;
 133     } else {
 134         my $sth = $dbh->prepare("
 135             SELECT * FROM items
 136             WHERE barcode = ?"
 137             );
 138         $sth->execute($barcode);
 139         $data = $sth->fetchrow_hashref;
 140     }
 141     if ( $serial) {
 142     my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=?");
 143         $ssth->execute($data->{'itemnumber'}) ;
 144         ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
 145                 warn $data->{'serialseq'} , $data->{'publisheddate'};
 146     }
 147         #if we don't have an items.itype, use biblioitems.itemtype.
 148         if( ! $data->{'itype'} ) {
 149                 my $sth = $dbh->prepare("SELECT itemtype FROM biblioitems  WHERE biblionumber = ?");
 150                 $sth->execute($data->{'biblionumber'});
 151                 ($data->{'itype'}) = $sth->fetchrow_array;
 152         }
 153     return $data;
 154 }    # sub GetItem
 155
 156 =head2 AddItemFromMarc
 157
 158 =over 4
 159
 160 my ($biblionumber, $biblioitemnumber, $itemnumber)
 161     = AddItemFromMarc($source_item_marc, $biblionumber);
 162
 163 =back
 164
 165 Given a MARC::Record object containing an embedded item
 166 record and a biblionumber, create a new item record.
 167
 168 =cut
 169
 170 sub AddItemFromMarc {
 171     my ( $source_item_marc, $biblionumber ) = @_;
 172     my $dbh = C4::Context->dbh;
 173
 174     # parse item hash from MARC
 175     my $frameworkcode = GetFrameworkCode( $biblionumber );
 176     my $item = &TransformMarcToKoha( $dbh, $source_item_marc, $frameworkcode );
 177     my $unlinked_item_subfields = _get_unlinked_item_subfields($source_item_marc, $frameworkcode);
 178     return AddItem($item, $biblionumber, $dbh, $frameworkcode, $unlinked_item_subfields);
 179 }
 180
 181 =head2 AddItem
 182
 183 =over 4
 184
 185 my ($biblionumber, $biblioitemnumber, $itemnumber)
 186     = AddItem($item, $biblionumber[, $dbh, $frameworkcode, $unlinked_item_subfields]);
 187
 188 =back
 189
 190 Given a hash containing item column names as keys,
 191 create a new Koha item record.
 192
 193 The first two optional parameters (C<$dbh> and C<$frameworkcode>)
 194 do not need to be supplied for general use; they exist
 195 simply to allow them to be picked up from AddItemFromMarc.
 196
 197 The final optional parameter, C<$unlinked_item_subfields>, contains
 198 an arrayref containing subfields present in the original MARC
 199 representation of the item (e.g., from the item editor) that are
 200 not mapped to C<items> columns directly but should instead
 201 be stored in C<items.more_subfields_xml> and included in
 202 the biblio items tag for display and indexing.
 203
 204 =cut
 205
 206 sub AddItem {
 207     my $item = shift;
 208     my $biblionumber = shift;
 209
 210     my $dbh           = @_ ? shift : C4::Context->dbh;
 211     my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
 212     my $unlinked_item_subfields;
 213     if (@_) {
 214         $unlinked_item_subfields = shift
 215     };
 216
 217     # needs old biblionumber and biblioitemnumber
 218     $item->{'biblionumber'} = $biblionumber;
 219     my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
 220     $sth->execute( $item->{'biblionumber'} );
 221     ($item->{'biblioitemnumber'}) = $sth->fetchrow;
 222
 223     _set_defaults_for_add($item);
 224     _set_derived_columns_for_add($item);
 225     $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
 226     # FIXME - checks here
 227     unless ( $item->{itype} ) {  # default to biblioitem.itemtype if no itype
 228         my $itype_sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
 229         $itype_sth->execute( $item->{'biblionumber'} );
 230         ( $item->{'itype'} ) = $itype_sth->fetchrow_array;
 231     }
 232
 233         my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
 234     $item->{'itemnumber'} = $itemnumber;
 235
 236     # create MARC tag representing item and add to bib
 237     my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
 238     _add_item_field_to_biblio($new_item_marc, $item->{'biblionumber'}, $frameworkcode );
 239
 240     logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
 241
 242     return ($item->{biblionumber}, $item->{biblioitemnumber}, $itemnumber);
 243 }
 244
 245 =head2 AddItemBatchFromMarc
 246
 247 =over 4
 248
 249 ($itemnumber_ref, $error_ref) = AddItemBatchFromMarc($record, $biblionumber, $biblioitemnumber, $frameworkcode);
 250
 251 =back
 252
 253 Efficiently create item records from a MARC biblio record with
 254 embedded item fields.  This routine is suitable for batch jobs.
 255
 256 This API assumes that the bib record has already been
 257 saved to the C<biblio> and C<biblioitems> tables.  It does
 258 not expect that C<biblioitems.marc> and C<biblioitems.marcxml>
 259 are populated, but it will do so via a call to ModBibiloMarc.
 260
 261 The goal of this API is to have a similar effect to using AddBiblio
 262 and AddItems in succession, but without inefficient repeated
 263 parsing of the MARC XML bib record.
 264
 265 This function returns an arrayref of new itemsnumbers and an arrayref of item
 266 errors encountered during the processing.  Each entry in the errors
 267 list is a hashref containing the following keys:
 268
 269 =over 2
 270
 271 =item item_sequence
 272
 273 Sequence number of original item tag in the MARC record.
 274
 275 =item item_barcode
 276
 277 Item barcode, provide to assist in the construction of
 278 useful error messages.
 279
 280 =item error_condition
 281
 282 Code representing the error condition.  Can be 'duplicate_barcode',
 283 'invalid_homebranch', or 'invalid_holdingbranch'.
 284
 285 =item error_information
 286
 287 Additional information appropriate to the error condition.
 288
 289 =back
 290
 291 =cut
 292
 293 sub AddItemBatchFromMarc {
 294     my ($record, $biblionumber, $biblioitemnumber, $frameworkcode) = @_;
 295     my $error;
 296     my @itemnumbers = ();
 297     my @errors = ();
 298     my $dbh = C4::Context->dbh;
 299
 300     # loop through the item tags and start creating items
 301     my @bad_item_fields = ();
 302     my ($itemtag, $itemsubfield) = &GetMarcFromKohaField("items.itemnumber",'');
 303     my $item_sequence_num = 0;
 304     ITEMFIELD: foreach my $item_field ($record->field($itemtag)) {
 305         $item_sequence_num++;
 306         # we take the item field and stick it into a new
 307         # MARC record -- this is required so far because (FIXME)
 308         # TransformMarcToKoha requires a MARC::Record, not a MARC::Field
 309         # and there is no TransformMarcFieldToKoha
 310         my $temp_item_marc = MARC::Record->new();
 311         $temp_item_marc->append_fields($item_field);
 312
 313         # add biblionumber and biblioitemnumber
 314         my $item = TransformMarcToKoha( $dbh, $temp_item_marc, $frameworkcode, 'items' );
 315         my $unlinked_item_subfields = _get_unlinked_item_subfields($temp_item_marc, $frameworkcode);
 316         $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
 317         $item->{'biblionumber'} = $biblionumber;
 318         $item->{'biblioitemnumber'} = $biblioitemnumber;
 319
 320         # check for duplicate barcode
 321         my %item_errors = CheckItemPreSave($item);
 322         if (%item_errors) {
 323             push @errors, _repack_item_errors($item_sequence_num, $item, \%item_errors);
 324             push @bad_item_fields, $item_field;
 325             next ITEMFIELD;
 326         }
 327
 328         _set_defaults_for_add($item);
 329         _set_derived_columns_for_add($item);
 330         my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
 331         warn $error if $error;
 332         push @itemnumbers, $itemnumber; # FIXME not checking error
 333         $item->{'itemnumber'} = $itemnumber;
 334
 335         logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
 336
 337         my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
 338         $item_field->replace_with($new_item_marc->field($itemtag));
 339     }
 340
 341     # remove any MARC item fields for rejected items
 342     foreach my $item_field (@bad_item_fields) {
 343         $record->delete_field($item_field);
 344     }
 345
 346     # update the MARC biblio
 347     $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode );
 348
 349     return (\@itemnumbers, \@errors);
 350 }
 351
 352 =head2 ModItemFromMarc
 353
 354 =over 4
 355
 356 ModItemFromMarc($item_marc, $biblionumber, $itemnumber);
 357
 358 =back
 359
 360 This function updates an item record based on a supplied
 361 C<MARC::Record> object containing an embedded item field.
 362 This API is meant for the use of C<additem.pl>; for
 363 other purposes, C<ModItem> should be used.
 364
 365 This function uses the hash %default_values_for_mod_from_marc,
 366 which contains default values for item fields to
 367 apply when modifying an item.  This is needed beccause
 368 if an item field's value is cleared, TransformMarcToKoha
 369 does not include the column in the
 370 hash that's passed to ModItem, which without
 371 use of this hash makes it impossible to clear
 372 an item field's value.  See bug 2466.
 373
 374 Note that only columns that can be directly
 375 changed from the cataloging and serials
 376 item editors are included in this hash.
 377
 378 =cut
 379
 380 my %default_values_for_mod_from_marc = (
 381     barcode              => undef,
 382     booksellerid         => undef,
 383     ccode                => undef,
 384     'items.cn_source'    => undef,
 385     copynumber           => undef,
 386     damaged              => 0,
 387     dateaccessioned      => undef,
 388     enumchron            => undef,
 389     holdingbranch        => undef,
 390     homebranch           => undef,
 391     itemcallnumber       => undef,
 392     itemlost             => 0,
 393     itemnotes            => undef,
 394     itype                => undef,
 395     location             => undef,
 396     materials            => undef,
 397     notforloan           => 0,
 398     paidfor              => undef,
 399     price                => undef,
 400     replacementprice     => undef,
 401     replacementpricedate => undef,
 402     restricted           => undef,
 403     stack                => undef,
 404     uri                  => undef,
 405     wthdrawn             => 0,
 406 );
 407
 408 sub ModItemFromMarc {
 409     my $item_marc = shift;
 410     my $biblionumber = shift;
 411     my $itemnumber = shift;
 412
 413     my $dbh = C4::Context->dbh;
 414     my $frameworkcode = GetFrameworkCode( $biblionumber );
 415     my $item = &TransformMarcToKoha( $dbh, $item_marc, $frameworkcode );
 416     foreach my $item_field (keys %default_values_for_mod_from_marc) {
 417         $item->{$item_field} = $default_values_for_mod_from_marc{$item_field} unless exists $item->{$item_field};
 418     }
 419     my $unlinked_item_subfields = _get_unlinked_item_subfields($item_marc, $frameworkcode);
 420
 421     return ModItem($item, $biblionumber, $itemnumber, $dbh, $frameworkcode, $unlinked_item_subfields);
 422 }
 423
 424 =head2 ModItem
 425
 426 =over 4
 427
 428 ModItem({ column => $newvalue }, $biblionumber, $itemnumber[, $original_item_marc]);
 429
 430 =back
 431
 432 Change one or more columns in an item record and update
 433 the MARC representation of the item.
 434
 435 The first argument is a hashref mapping from item column
 436 names to the new values.  The second and third arguments
 437 are the biblionumber and itemnumber, respectively.
 438
 439 The fourth, optional parameter, C<$unlinked_item_subfields>, contains
 440 an arrayref containing subfields present in the original MARC
 441 representation of the item (e.g., from the item editor) that are
 442 not mapped to C<items> columns directly but should instead
 443 be stored in C<items.more_subfields_xml> and included in
 444 the biblio items tag for display and indexing.
 445
 446 If one of the changed columns is used to calculate
 447 the derived value of a column such as C<items.cn_sort>,
 448 this routine will perform the necessary calculation
 449 and set the value.
 450
 451 =cut
 452
 453 sub ModItem {
 454     my $item = shift;
 455     my $biblionumber = shift;
 456     my $itemnumber = shift;
 457
 458     # if $biblionumber is undefined, get it from the current item
 459     unless (defined $biblionumber) {
 460         $biblionumber = _get_single_item_column('biblionumber', $itemnumber);
 461     }
 462
 463     my $dbh           = @_ ? shift : C4::Context->dbh;
 464     my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
 465
 466     my $unlinked_item_subfields;
 467     if (@_) {
 468         $unlinked_item_subfields = shift;
 469         $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
 470     };
 471
 472     $item->{'itemnumber'} = $itemnumber or return undef;
 473     _set_derived_columns_for_mod($item);
 474     _do_column_fixes_for_mod($item);
 475     # FIXME add checks
 476     # duplicate barcode
 477     # attempt to change itemnumber
 478     # attempt to change biblionumber (if we want
 479     # an API to relink an item to a different bib,
 480     # it should be a separate function)
 481
 482     # update items table
 483     _koha_modify_item($item);
 484
 485     # update biblio MARC XML
 486     my $whole_item = GetItem($itemnumber) or die "FAILED GetItem($itemnumber)";
 487
 488     unless (defined $unlinked_item_subfields) {
 489         $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'});
 490     }
 491     my $new_item_marc = _marc_from_item_hash($whole_item, $frameworkcode, $unlinked_item_subfields)
 492         or die "FAILED _marc_from_item_hash($whole_item, $frameworkcode)";
 493
 494     _replace_item_field_in_biblio($new_item_marc, $biblionumber, $itemnumber, $frameworkcode);
 495         ($new_item_marc       eq '0') and die "$new_item_marc is '0', not hashref";  # logaction line would crash anyway
 496     logaction("CATALOGUING", "MODIFY", $itemnumber, $new_item_marc->as_formatted) if C4::Context->preference("CataloguingLog");
 497 }
 498
 499 =head2 ModItemTransfer
 500
 501 =over 4
 502
 503 ModItemTransfer($itenumber, $frombranch, $tobranch);
 504
 505 =back
 506
 507 Marks an item as being transferred from one branch
 508 to another.
 509
 510 =cut
 511
 512 sub ModItemTransfer {
 513     my ( $itemnumber, $frombranch, $tobranch ) = @_;
 514
 515     my $dbh = C4::Context->dbh;
 516
 517     #new entry in branchtransfers....
 518     my $sth = $dbh->prepare(
 519         "INSERT INTO branchtransfers (itemnumber, frombranch, datesent, tobranch)
 520         VALUES (?, ?, NOW(), ?)");
 521     $sth->execute($itemnumber, $frombranch, $tobranch);
 522
 523     ModItem({ holdingbranch => $tobranch }, undef, $itemnumber);
 524     ModDateLastSeen($itemnumber);
 525     return;
 526 }
 527
 528 =head2 ModDateLastSeen
 529
 530 =over 4
 531
 532 ModDateLastSeen($itemnum);
 533
 534 =back
 535
 536 Mark item as seen. Is called when an item is issued, returned or manually marked during inventory/stocktaking.
 537 C<$itemnum> is the item number
 538
 539 =cut
 540
 541 sub ModDateLastSeen {
 542     my ($itemnumber) = @_;
 543
 544     my $today = C4::Dates->new();
 545     ModItem({ itemlost => 0, datelastseen => $today->output("iso") }, undef, $itemnumber);
 546 }
 547
 548 =head2 DelItem
 549
 550 =over 4
 551
 552 DelItem($biblionumber, $itemnumber);
 553
 554 =back
 555
 556 Exported function (core API) for deleting an item record in Koha.
 557
 558 =cut
 559
 560 sub DelItem {
 561     my ( $dbh, $biblionumber, $itemnumber ) = @_;
 562
 563     # FIXME check the item has no current issues
 564
 565     _koha_delete_item( $dbh, $itemnumber );
 566
 567     # get the MARC record
 568     my $record = GetMarcBiblio($biblionumber);
 569     my $frameworkcode = GetFrameworkCode($biblionumber);
 570
 571     # backup the record
 572     my $copy2deleted = $dbh->prepare("UPDATE deleteditems SET marc=? WHERE itemnumber=?");
 573     $copy2deleted->execute( $record->as_usmarc(), $itemnumber );
 574
 575     #search item field code
 576     my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
 577     my @fields = $record->field($itemtag);
 578
 579     # delete the item specified
 580     foreach my $field (@fields) {
 581         if ( $field->subfield($itemsubfield) eq $itemnumber ) {
 582             $record->delete_field($field);
 583         }
 584     }
 585     &ModBiblioMarc( $record, $biblionumber, $frameworkcode );
 586     logaction("CATALOGUING", "DELETE", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
 587 }
 588
 589 =head2 CheckItemPreSave
 590
 591 =over 4
 592
 593     my $item_ref = TransformMarcToKoha($marc, 'items');
 594     # do stuff
 595     my %errors = CheckItemPreSave($item_ref);
 596     if (exists $errors{'duplicate_barcode'}) {
 597         print "item has duplicate barcode: ", $errors{'duplicate_barcode'}, "\n";
 598     } elsif (exists $errors{'invalid_homebranch'}) {
 599         print "item has invalid home branch: ", $errors{'invalid_homebranch'}, "\n";
 600     } elsif (exists $errors{'invalid_holdingbranch'}) {
 601         print "item has invalid holding branch: ", $errors{'invalid_holdingbranch'}, "\n";
 602     } else {
 603         print "item is OK";
 604     }
 605
 606 =back
 607
 608 Given a hashref containing item fields, determine if it can be
 609 inserted or updated in the database.  Specifically, checks for
 610 database integrity issues, and returns a hash containing any
 611 of the following keys, if applicable.
 612
 613 =over 2
 614
 615 =item duplicate_barcode
 616
 617 Barcode, if it duplicates one already found in the database.
 618
 619 =item invalid_homebranch
 620
 621 Home branch, if not defined in branches table.
 622
 623 =item invalid_holdingbranch
 624
 625 Holding branch, if not defined in branches table.
 626
 627 =back
 628
 629 This function does NOT implement any policy-related checks,
 630 e.g., whether current operator is allowed to save an
 631 item that has a given branch code.
 632
 633 =cut
 634
 635 sub CheckItemPreSave {
 636     my $item_ref = shift;
 637
 638     my %errors = ();
 639
 640     # check for duplicate barcode
 641     if (exists $item_ref->{'barcode'} and defined $item_ref->{'barcode'}) {
 642         my $existing_itemnumber = GetItemnumberFromBarcode($item_ref->{'barcode'});
 643         if ($existing_itemnumber) {
 644             if (!exists $item_ref->{'itemnumber'}                       # new item
 645                 or $item_ref->{'itemnumber'} != $existing_itemnumber) { # existing item
 646                 $errors{'duplicate_barcode'} = $item_ref->{'barcode'};
 647             }
 648         }
 649     }
 650
 651     # check for valid home branch
 652     if (exists $item_ref->{'homebranch'} and defined $item_ref->{'homebranch'}) {
 653         my $branch_name = GetBranchName($item_ref->{'homebranch'});
 654         unless (defined $branch_name) {
 655             # relies on fact that branches.branchname is a non-NULL column,
 656             # so GetBranchName returns undef only if branch does not exist
 657             $errors{'invalid_homebranch'} = $item_ref->{'homebranch'};
 658         }
 659     }
 660
 661     # check for valid holding branch
 662     if (exists $item_ref->{'holdingbranch'} and defined $item_ref->{'holdingbranch'}) {
 663         my $branch_name = GetBranchName($item_ref->{'holdingbranch'});
 664         unless (defined $branch_name) {
 665             # relies on fact that branches.branchname is a non-NULL column,
 666             # so GetBranchName returns undef only if branch does not exist
 667             $errors{'invalid_holdingbranch'} = $item_ref->{'holdingbranch'};
 668         }
 669     }
 670
 671     return %errors;
 672
 673 }
 674
 675 =head1 EXPORTED SPECIAL ACCESSOR FUNCTIONS
 676
 677 The following functions provide various ways of
 678 getting an item record, a set of item records, or
 679 lists of authorized values for certain item fields.
 680
 681 Some of the functions in this group are candidates
 682 for refactoring -- for example, some of the code
 683 in C<GetItemsByBiblioitemnumber> and C<GetItemsInfo>
 684 has copy-and-paste work.
 685
 686 =cut
 687
 688 =head2 GetItemStatus
 689
 690 =over 4
 691
 692 $itemstatushash = GetItemStatus($fwkcode);
 693
 694 =back
 695
 696 Returns a list of valid values for the
 697 C<items.notforloan> field.
 698
 699 NOTE: does B<not> return an individual item's
 700 status.
 701
 702 Can be MARC dependant.
 703 fwkcode is optional.
 704 But basically could be can be loan or not
 705 Create a status selector with the following code
 706
 707 =head3 in PERL SCRIPT
 708
 709 =over 4
 710
 711 my $itemstatushash = getitemstatus;
 712 my @itemstatusloop;
 713 foreach my $thisstatus (keys %$itemstatushash) {
 714     my %row =(value => $thisstatus,
 715                 statusname => $itemstatushash->{$thisstatus}->{'statusname'},
 716             );
 717     push @itemstatusloop, \%row;
 718 }
 719 $template->param(statusloop=>\@itemstatusloop);
 720
 721 =back
 722
 723 =head3 in TEMPLATE
 724
 725 =over 4
 726
 727 <select name="statusloop">
 728     <option value="">Default</option>
 729 <!-- TMPL_LOOP name="statusloop" -->
 730     <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="statusname" --></option>
 731 <!-- /TMPL_LOOP -->
 732 </select>
 733
 734 =back
 735
 736 =cut
 737
 738 sub GetItemStatus {
 739
 740     # returns a reference to a hash of references to status...
 741     my ($fwk) = @_;
 742     my %itemstatus;
 743     my $dbh = C4::Context->dbh;
 744     my $sth;
 745     $fwk = '' unless ($fwk);
 746     my ( $tag, $subfield ) =
 747       GetMarcFromKohaField( "items.notforloan", $fwk );
 748     if ( $tag and $subfield ) {
 749         my $sth =
 750           $dbh->prepare(
 751             "SELECT authorised_value
 752             FROM marc_subfield_structure
 753             WHERE tagfield=?
 754                 AND tagsubfield=?
 755                 AND frameworkcode=?
 756             "
 757           );
 758         $sth->execute( $tag, $subfield, $fwk );
 759         if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
 760             my $authvalsth =
 761               $dbh->prepare(
 762                 "SELECT authorised_value,lib
 763                 FROM authorised_values
 764                 WHERE category=?
 765                 ORDER BY lib
 766                 "
 767               );
 768             $authvalsth->execute($authorisedvaluecat);
 769             while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
 770                 $itemstatus{$authorisedvalue} = $lib;
 771             }
 772             $authvalsth->finish;
 773             return \%itemstatus;
 774             exit 1;
 775         }
 776         else {
 777
 778             #No authvalue list
 779             # build default
 780         }
 781         $sth->finish;
 782     }
 783
 784     #No authvalue list
 785     #build default
 786     $itemstatus{"1"} = "Not For Loan";
 787     return \%itemstatus;
 788 }
 789
 790 =head2 GetItemLocation
 791
 792 =over 4
 793
 794 $itemlochash = GetItemLocation($fwk);
 795
 796 =back
 797
 798 Returns a list of valid values for the
 799 C<items.location> field.
 800
 801 NOTE: does B<not> return an individual item's
 802 location.
 803
 804 where fwk stands for an optional framework code.
 805 Create a location selector with the following code
 806
 807 =head3 in PERL SCRIPT
 808
 809 =over 4
 810
 811 my $itemlochash = getitemlocation;
 812 my @itemlocloop;
 813 foreach my $thisloc (keys %$itemlochash) {
 814     my $selected = 1 if $thisbranch eq $branch;
 815     my %row =(locval => $thisloc,
 816                 selected => $selected,
 817                 locname => $itemlochash->{$thisloc},
 818             );
 819     push @itemlocloop, \%row;
 820 }
 821 $template->param(itemlocationloop => \@itemlocloop);
 822
 823 =back
 824
 825 =head3 in TEMPLATE
 826
 827 =over 4
 828
 829 <select name="location">
 830     <option value="">Default</option>
 831 <!-- TMPL_LOOP name="itemlocationloop" -->
 832     <option value="<!-- TMPL_VAR name="locval" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="locname" --></option>
 833 <!-- /TMPL_LOOP -->
 834 </select>
 835
 836 =back
 837
 838 =cut
 839
 840 sub GetItemLocation {
 841
 842     # returns a reference to a hash of references to location...
 843     my ($fwk) = @_;
 844     my %itemlocation;
 845     my $dbh = C4::Context->dbh;
 846     my $sth;
 847     $fwk = '' unless ($fwk);
 848     my ( $tag, $subfield ) =
 849       GetMarcFromKohaField( "items.location", $fwk );
 850     if ( $tag and $subfield ) {
 851         my $sth =
 852           $dbh->prepare(
 853             "SELECT authorised_value
 854             FROM marc_subfield_structure
 855             WHERE tagfield=?
 856                 AND tagsubfield=?
 857                 AND frameworkcode=?"
 858           );
 859         $sth->execute( $tag, $subfield, $fwk );
 860         if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
 861             my $authvalsth =
 862               $dbh->prepare(
 863                 "SELECT authorised_value,lib
 864                 FROM authorised_values
 865                 WHERE category=?
 866                 ORDER BY lib"
 867               );
 868             $authvalsth->execute($authorisedvaluecat);
 869             while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
 870                 $itemlocation{$authorisedvalue} = $lib;
 871             }
 872             $authvalsth->finish;
 873             return \%itemlocation;
 874             exit 1;
 875         }
 876         else {
 877
 878             #No authvalue list
 879             # build default
 880         }
 881         $sth->finish;
 882     }
 883
 884     #No authvalue list
 885     #build default
 886     $itemlocation{"1"} = "Not For Loan";
 887     return \%itemlocation;
 888 }
 889
 890 =head2 GetLostItems
 891
 892 =over 4
 893
 894 $items = GetLostItems( $where, $orderby );
 895
 896 =back
 897
 898 This function gets a list of lost items.
 899
 900 =over 2
 901
 902 =item input:
 903
 904 C<$where> is a hashref. it containts a field of the items table as key
 905 and the value to match as value. For example:
 906
 907 { barcode    => 'abc123',
 908   homebranch => 'CPL',    }
 909
 910 C<$orderby> is a field of the items table by which the resultset
 911 should be orderd.
 912
 913 =item return:
 914
 915 C<$items> is a reference to an array full of hashrefs with columns
 916 from the "items" table as keys.
 917
 918 =item usage in the perl script:
 919
 920 my $where = { barcode => '0001548' };
 921 my $items = GetLostItems( $where, "homebranch" );
 922 $template->param( itemsloop => $items );
 923
 924 =back
 925
 926 =cut
 927
 928 sub GetLostItems {
 929     # Getting input args.
 930     my $where   = shift;
 931     my $orderby = shift;
 932     my $dbh     = C4::Context->dbh;
 933
 934     my $query   = "
 935         SELECT *
 936         FROM   items
 937             LEFT JOIN biblio ON (items.biblionumber = biblio.biblionumber)
 938             LEFT JOIN biblioitems ON (items.biblionumber = biblioitems.biblionumber)
 939             LEFT JOIN authorised_values ON (items.itemlost = authorised_values.authorised_value)
 940         WHERE
 941                 authorised_values.category = 'LOST'
 942                 AND itemlost IS NOT NULL
 943                 AND itemlost <> 0
 944     ";
 945     my @query_parameters;
 946     foreach my $key (keys %$where) {
 947         $query .= " AND $key LIKE ?";
 948         push @query_parameters, "%$where->{$key}%";
 949     }
 950     my @ordervalues = qw/title author homebranch itype barcode price replacementprice lib datelastseen location/;
 951
 952     if ( defined $orderby && grep($orderby, @ordervalues)) {
 953         $query .= ' ORDER BY '.$orderby;
 954     }
 955
 956     my $sth = $dbh->prepare($query);
 957     $sth->execute( @query_parameters );
 958     my $items = [];
 959     while ( my $row = $sth->fetchrow_hashref ){
 960         push @$items, $row;
 961     }
 962     return $items;
 963 }
 964
 965 =head2 GetItemsForInventory
 966
 967 =over 4
 968
 969 $itemlist = GetItemsForInventory($minlocation, $maxlocation, $location, $itemtype $datelastseen, $branch, $offset, $size);
 970
 971 =back
 972
 973 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
 974
 975 The sub returns a reference to a list of hashes, each containing
 976 itemnumber, author, title, barcode, item callnumber, and date last
 977 seen. It is ordered by callnumber then title.
 978
 979 The required minlocation & maxlocation parameters are used to specify a range of item callnumbers
 980 the datelastseen can be used to specify that you want to see items not seen since a past date only.
 981 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
 982
 983 =cut
 984
 985 sub GetItemsForInventory {
 986     my ( $minlocation, $maxlocation,$location, $itemtype, $ignoreissued, $datelastseen, $branch, $offset, $size ) = @_;
 987     my $dbh = C4::Context->dbh;
 988     my ( @bind_params, @where_strings );
 989
 990     my $query = <<'END_SQL';
 991 SELECT items.itemnumber, barcode, itemcallnumber, title, author, biblio.biblionumber, datelastseen
 992 FROM items
 993   LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
 994   LEFT JOIN biblioitems on items.biblionumber = biblioitems.biblionumber
 995 END_SQL
 996
 997     if ($minlocation) {
 998         push @where_strings, 'itemcallnumber >= ?';
 999         push @bind_params, $minlocation;
1000     }
1001
1002     if ($maxlocation) {
1003         push @where_strings, 'itemcallnumber <= ?';
1004         push @bind_params, $maxlocation;
1005     }
1006
1007     if ($datelastseen) {
1008         $datelastseen = format_date_in_iso($datelastseen);
1009         push @where_strings, '(datelastseen < ? OR datelastseen IS NULL)';
1010         push @bind_params, $datelastseen;
1011     }
1012
1013     if ( $location ) {
1014         push @where_strings, 'items.location = ?';
1015         push @bind_params, $location;
1016     }
1017
1018     if ( $branch ) {
1019         push @where_strings, 'items.homebranch = ?';
1020         push @bind_params, $branch;
1021     }
1022
1023     if ( $itemtype ) {
1024         push @where_strings, 'biblioitems.itemtype = ?';
1025         push @bind_params, $itemtype;
1026     }
1027
1028     if ( $ignoreissued) {
1029         $query .= "LEFT JOIN issues ON items.itemnumber = issues.itemnumber ";
1030         push @where_strings, 'issues.date_due IS NULL';
1031     }
1032
1033     if ( @where_strings ) {
1034         $query .= 'WHERE ';
1035         $query .= join ' AND ', @where_strings;
1036     }
1037     $query .= ' ORDER BY itemcallnumber, title';
1038     my $sth = $dbh->prepare($query);
1039     $sth->execute( @bind_params );
1040
1041     my @results;
1042     $size--;
1043     while ( my $row = $sth->fetchrow_hashref ) {
1044         $offset-- if ($offset);
1045         $row->{datelastseen}=format_date($row->{datelastseen});
1046         if ( ( !$offset ) && $size ) {
1047             push @results, $row;
1048             $size--;
1049         }
1050     }
1051     return \@results;
1052 }
1053
1054 =head2 GetItemsCount
1055
1056 =over 4
1057 $count = &GetItemsCount( $biblionumber);
1058
1059 =back
1060
1061 This function return count of item with $biblionumber
1062
1063 =cut
1064
1065 sub GetItemsCount {
1066     my ( $biblionumber ) = @_;
1067     my $dbh = C4::Context->dbh;
1068     my $query = "SELECT count(*)
1069           FROM  items
1070           WHERE biblionumber=?";
1071     my $sth = $dbh->prepare($query);
1072     $sth->execute($biblionumber);
1073     my $count = $sth->fetchrow;
1074     $sth->finish;
1075     return ($count);
1076 }
1077
1078 =head2 GetItemInfosOf
1079
1080 =over 4
1081
1082 GetItemInfosOf(@itemnumbers);
1083
1084 =back
1085
1086 =cut
1087
1088 sub GetItemInfosOf {
1089     my @itemnumbers = @_;
1090
1091     my $query = '
1092         SELECT *
1093         FROM items
1094         WHERE itemnumber IN (' . join( ',', @itemnumbers ) . ')
1095     ';
1096     return get_infos_of( $query, 'itemnumber' );
1097 }
1098
1099 =head2 GetItemsByBiblioitemnumber
1100
1101 =over 4
1102
1103 GetItemsByBiblioitemnumber($biblioitemnumber);
1104
1105 =back
1106
1107 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1108 Called by C<C4::XISBN>
1109
1110 =cut
1111
1112 sub GetItemsByBiblioitemnumber {
1113     my ( $bibitem ) = @_;
1114     my $dbh = C4::Context->dbh;
1115     my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1116     # Get all items attached to a biblioitem
1117     my $i = 0;
1118     my @results;
1119     $sth->execute($bibitem) || die $sth->errstr;
1120     while ( my $data = $sth->fetchrow_hashref ) {
1121         # Foreach item, get circulation information
1122         my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1123                                    WHERE itemnumber = ?
1124                                    AND issues.borrowernumber = borrowers.borrowernumber"
1125         );
1126         $sth2->execute( $data->{'itemnumber'} );
1127         if ( my $data2 = $sth2->fetchrow_hashref ) {
1128             # if item is out, set the due date and who it is out too
1129             $data->{'date_due'}   = $data2->{'date_due'};
1130             $data->{'cardnumber'} = $data2->{'cardnumber'};
1131             $data->{'borrowernumber'}   = $data2->{'borrowernumber'};
1132         }
1133         else {
1134             # set date_due to blank, so in the template we check itemlost, and wthdrawn
1135             $data->{'date_due'} = '';
1136         }    # else
1137         $sth2->finish;
1138         # Find the last 3 people who borrowed this item.
1139         my $query2 = "SELECT * FROM old_issues, borrowers WHERE itemnumber = ?
1140                       AND old_issues.borrowernumber = borrowers.borrowernumber
1141                       ORDER BY returndate desc,timestamp desc LIMIT 3";
1142         $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1143         $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1144         my $i2 = 0;
1145         while ( my $data2 = $sth2->fetchrow_hashref ) {
1146             $data->{"timestamp$i2"} = $data2->{'timestamp'};
1147             $data->{"card$i2"}      = $data2->{'cardnumber'};
1148             $data->{"borrower$i2"}  = $data2->{'borrowernumber'};
1149             $i2++;
1150         }
1151         $sth2->finish;
1152         push(@results,$data);
1153     }
1154     $sth->finish;
1155     return (\@results);
1156 }
1157
1158 =head2 GetItemsInfo
1159
1160 =over 4
1161
1162 @results = GetItemsInfo($biblionumber, $type);
1163
1164 =back
1165
1166 Returns information about books with the given biblionumber.
1167
1168 C<$type> may be either C<intra> or anything else. If it is not set to
1169 C<intra>, then the search will exclude lost, very overdue, and
1170 withdrawn items.
1171
1172 C<GetItemsInfo> returns a list of references-to-hash. Each element
1173 contains a number of keys. Most of them are table items from the
1174 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
1175 Koha database. Other keys include:
1176
1177 =over 2
1178
1179 =item C<$data-E<gt>{branchname}>
1180
1181 The name (not the code) of the branch to which the book belongs.
1182
1183 =item C<$data-E<gt>{datelastseen}>
1184
1185 This is simply C<items.datelastseen>, except that while the date is
1186 stored in YYYY-MM-DD format in the database, here it is converted to
1187 DD/MM/YYYY format. A NULL date is returned as C<//>.
1188
1189 =item C<$data-E<gt>{datedue}>
1190
1191 =item C<$data-E<gt>{class}>
1192
1193 This is the concatenation of C<biblioitems.classification>, the book's
1194 Dewey code, and C<biblioitems.subclass>.
1195
1196 =item C<$data-E<gt>{ocount}>
1197
1198 I think this is the number of copies of the book available.
1199
1200 =item C<$data-E<gt>{order}>
1201
1202 If this is set, it is set to C<One Order>.
1203
1204 =back
1205
1206 =cut
1207
1208 sub GetItemsInfo {
1209     my ( $biblionumber, $type ) = @_;
1210     my $dbh   = C4::Context->dbh;
1211     # note biblioitems.* must be avoided to prevent large marc and marcxml fields from killing performance.
1212     my $query = "
1213     SELECT items.*,
1214            biblio.*,
1215            biblioitems.volume,
1216            biblioitems.number,
1217            biblioitems.itemtype,
1218            biblioitems.isbn,
1219            biblioitems.issn,
1220            biblioitems.publicationyear,
1221            biblioitems.publishercode,
1222            biblioitems.volumedate,
1223            biblioitems.volumedesc,
1224            biblioitems.lccn,
1225            biblioitems.url,
1226            items.notforloan as itemnotforloan,
1227            itemtypes.description
1228      FROM items
1229      LEFT JOIN biblio      ON      biblio.biblionumber     = items.biblionumber
1230      LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1231      LEFT JOIN itemtypes   ON   itemtypes.itemtype         = "
1232      . (C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype');
1233     $query .= " WHERE items.biblionumber = ? ORDER BY items.dateaccessioned desc" ;
1234     my $sth = $dbh->prepare($query);
1235     $sth->execute($biblionumber);
1236     my $i = 0;
1237     my @results;
1238     my ( $date_due, $count_reserves, $serial );
1239
1240     my $isth    = $dbh->prepare(
1241         "SELECT issues.*,borrowers.cardnumber,borrowers.surname,borrowers.firstname,borrowers.branchcode as bcode
1242         FROM   issues LEFT JOIN borrowers ON issues.borrowernumber=borrowers.borrowernumber
1243         WHERE  itemnumber = ?"
1244        );
1245         my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=? ");
1246         while ( my $data = $sth->fetchrow_hashref ) {
1247         my $datedue = '';
1248         $isth->execute( $data->{'itemnumber'} );
1249         if ( my $idata = $isth->fetchrow_hashref ) {
1250             $data->{borrowernumber} = $idata->{borrowernumber};
1251             $data->{cardnumber}     = $idata->{cardnumber};
1252             $data->{surname}     = $idata->{surname};
1253             $data->{firstname}     = $idata->{firstname};
1254             $datedue                = $idata->{'date_due'};
1255         if (C4::Context->preference("IndependantBranches")){
1256         my $userenv = C4::Context->userenv;
1257         if ( ($userenv) && ( $userenv->{flags} != 1 ) ) {
1258             $data->{'NOTSAMEBRANCH'} = 1 if ($idata->{'bcode'} ne $userenv->{branch});
1259         }
1260         }
1261         }
1262                 if ( $data->{'serial'}) {
1263                         $ssth->execute($data->{'itemnumber'}) ;
1264                         ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
1265                         $serial = 1;
1266         }
1267                 if ( $datedue eq '' ) {
1268             my ( $restype, $reserves ) =
1269               C4::Reserves::CheckReserves( $data->{'itemnumber'} );
1270             if ($restype) {
1271                 $count_reserves = $restype;
1272             }
1273         }
1274         $isth->finish;
1275         $ssth->finish;
1276         #get branch information.....
1277         my $bsth = $dbh->prepare(
1278             "SELECT * FROM branches WHERE branchcode = ?
1279         "
1280         );
1281         $bsth->execute( $data->{'holdingbranch'} );
1282         if ( my $bdata = $bsth->fetchrow_hashref ) {
1283             $data->{'branchname'} = $bdata->{'branchname'};
1284         }
1285         $data->{'datedue'}        = $datedue;
1286         $data->{'count_reserves'} = $count_reserves;
1287
1288         # get notforloan complete status if applicable
1289         my $sthnflstatus = $dbh->prepare(
1290             'SELECT authorised_value
1291             FROM   marc_subfield_structure
1292             WHERE  kohafield="items.notforloan"
1293         '
1294         );
1295
1296         $sthnflstatus->execute;
1297         my ($authorised_valuecode) = $sthnflstatus->fetchrow;
1298         if ($authorised_valuecode) {
1299             $sthnflstatus = $dbh->prepare(
1300                 "SELECT lib FROM authorised_values
1301                  WHERE  category=?
1302                  AND authorised_value=?"
1303             );
1304             $sthnflstatus->execute( $authorised_valuecode,
1305                 $data->{itemnotforloan} );
1306             my ($lib) = $sthnflstatus->fetchrow;
1307             $data->{notforloanvalue} = $lib;
1308         }
1309                 $data->{itypenotforloan} = $data->{notforloan} if (C4::Context->preference('item-level_itypes'));
1310
1311         # my stack procedures
1312         my $stackstatus = $dbh->prepare(
1313             'SELECT authorised_value
1314              FROM   marc_subfield_structure
1315              WHERE  kohafield="items.stack"
1316         '
1317         );
1318         $stackstatus->execute;
1319
1320         ($authorised_valuecode) = $stackstatus->fetchrow;
1321         if ($authorised_valuecode) {
1322             $stackstatus = $dbh->prepare(
1323                 "SELECT lib
1324                  FROM   authorised_values
1325                  WHERE  category=?
1326                  AND    authorised_value=?
1327             "
1328             );
1329             $stackstatus->execute( $authorised_valuecode, $data->{stack} );
1330             my ($lib) = $stackstatus->fetchrow;
1331             $data->{stack} = $lib;
1332         }
1333         # Find the last 3 people who borrowed this item.
1334         my $sth2 = $dbh->prepare("SELECT * FROM old_issues,borrowers
1335                                     WHERE itemnumber = ?
1336                                     AND old_issues.borrowernumber = borrowers.borrowernumber
1337                                     ORDER BY returndate DESC
1338                                     LIMIT 3");
1339         $sth2->execute($data->{'itemnumber'});
1340         my $ii = 0;
1341         while (my $data2 = $sth2->fetchrow_hashref()) {
1342             $data->{"timestamp$ii"} = $data2->{'timestamp'} if $data2->{'timestamp'};
1343             $data->{"card$ii"}      = $data2->{'cardnumber'} if $data2->{'cardnumber'};
1344             $data->{"borrower$ii"}  = $data2->{'borrowernumber'} if $data2->{'borrowernumber'};
1345             $ii++;
1346         }
1347
1348         $results[$i] = $data;
1349         $i++;
1350     }
1351         if($serial) {
1352                 return( sort { ($b->{'publisheddate'} || $b->{'enumchron'}) cmp ($a->{'publisheddate'} || $a->{'enumchron'}) } @results );
1353         } else {
1354         return (@results);
1355         }
1356 }
1357
1358 =head2 get_itemnumbers_of
1359
1360 =over 4
1361
1362 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1363
1364 =back
1365
1366 Given a list of biblionumbers, return the list of corresponding itemnumbers
1367 for each biblionumber.
1368
1369 Return a reference on a hash where keys are biblionumbers and values are
1370 references on array of itemnumbers.
1371
1372 =cut
1373
1374 sub get_itemnumbers_of {
1375     my @biblionumbers = @_;
1376
1377     my $dbh = C4::Context->dbh;
1378
1379     my $query = '
1380         SELECT itemnumber,
1381             biblionumber
1382         FROM items
1383         WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1384     ';
1385     my $sth = $dbh->prepare($query);
1386     $sth->execute(@biblionumbers);
1387
1388     my %itemnumbers_of;
1389
1390     while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1391         push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1392     }
1393
1394     return \%itemnumbers_of;
1395 }
1396
1397 =head2 GetItemnumberFromBarcode
1398
1399 =over 4
1400
1401 $result = GetItemnumberFromBarcode($barcode);
1402
1403 =back
1404
1405 =cut
1406
1407 sub GetItemnumberFromBarcode {
1408     my ($barcode) = @_;
1409     my $dbh = C4::Context->dbh;
1410
1411     my $rq =
1412       $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1413     $rq->execute($barcode);
1414     my ($result) = $rq->fetchrow;
1415     return ($result);
1416 }
1417
1418 =head3 get_item_authorised_values
1419
1420   find the types and values for all authorised values assigned to this item.
1421
1422   parameters:
1423     itemnumber
1424
1425   returns: a hashref malling the authorised value to the value set for this itemnumber
1426
1427     $authorised_values = {
1428              'CCODE'      => undef,
1429              'DAMAGED'    => '0',
1430              'LOC'        => '3',
1431              'LOST'       => '0'
1432              'NOT_LOAN'   => '0',
1433              'RESTRICTED' => undef,
1434              'STACK'      => undef,
1435              'WITHDRAWN'  => '0',
1436              'branches'   => 'CPL',
1437              'cn_source'  => undef,
1438              'itemtypes'  => 'SER',
1439            };
1440
1441    Notes: see C4::Biblio::get_biblio_authorised_values for a similar method at the biblio level.
1442
1443 =cut
1444
1445 sub get_item_authorised_values {
1446     my $itemnumber = shift;
1447
1448     # assume that these entries in the authorised_value table are item level.
1449     my $query = q(SELECT distinct authorised_value, kohafield
1450                     FROM marc_subfield_structure
1451                     WHERE kohafield like 'item%'
1452                       AND authorised_value != '' );
1453
1454     my $itemlevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
1455     my $iteminfo = GetItem( $itemnumber );
1456     # warn( Data::Dumper->Dump( [ $itemlevel_authorised_values ], [ 'itemlevel_authorised_values' ] ) );
1457     my $return;
1458     foreach my $this_authorised_value ( keys %$itemlevel_authorised_values ) {
1459         my $field = $itemlevel_authorised_values->{ $this_authorised_value }->{'kohafield'};
1460         $field =~ s/^items\.//;
1461         if ( exists $iteminfo->{ $field } ) {
1462             $return->{ $this_authorised_value } = $iteminfo->{ $field };
1463         }
1464     }
1465     # warn( Data::Dumper->Dump( [ $return ], [ 'return' ] ) );
1466     return $return;
1467 }
1468
1469 =head3 get_authorised_value_images
1470
1471   find a list of icons that are appropriate for display based on the
1472   authorised values for a biblio.
1473
1474   parameters: listref of authorised values, such as comes from
1475     get_item_ahtorised_values or
1476     from C4::Biblio::get_biblio_authorised_values
1477
1478   returns: listref of hashrefs for each image. Each hashref looks like
1479     this:
1480
1481       { imageurl => '/intranet-tmpl/prog/img/itemtypeimg/npl/WEB.gif',
1482         label    => '',
1483         category => '',
1484         value    => '', }
1485
1486   Notes: Currently, I put on the full path to the images on the staff
1487   side. This should either be configurable or not done at all. Since I
1488   have to deal with 'intranet' or 'opac' in
1489   get_biblio_authorised_values, perhaps I should be passing it in.
1490
1491 =cut
1492
1493 sub get_authorised_value_images {
1494     my $authorised_values = shift;
1495
1496     my @imagelist;
1497
1498     my $authorised_value_list = GetAuthorisedValues();
1499     # warn ( Data::Dumper->Dump( [ $authorised_value_list ], [ 'authorised_value_list' ] ) );
1500     foreach my $this_authorised_value ( @$authorised_value_list ) {
1501         if ( exists $authorised_values->{ $this_authorised_value->{'category'} }
1502              && $authorised_values->{ $this_authorised_value->{'category'} } eq $this_authorised_value->{'authorised_value'} ) {
1503             # warn ( Data::Dumper->Dump( [ $this_authorised_value ], [ 'this_authorised_value' ] ) );
1504             if ( defined $this_authorised_value->{'imageurl'} ) {
1505                 push @imagelist, { imageurl => C4::Koha::getitemtypeimagelocation( 'intranet', $this_authorised_value->{'imageurl'} ),
1506                                    label    => $this_authorised_value->{'lib'},
1507                                    category => $this_authorised_value->{'category'},
1508                                    value    => $this_authorised_value->{'authorised_value'}, };
1509             }
1510         }
1511     }
1512
1513     # warn ( Data::Dumper->Dump( [ \@imagelist ], [ 'imagelist' ] ) );
1514     return \@imagelist;
1515
1516 }
1517
1518 =head1 LIMITED USE FUNCTIONS
1519
1520 The following functions, while part of the public API,
1521 are not exported.  This is generally because they are
1522 meant to be used by only one script for a specific
1523 purpose, and should not be used in any other context
1524 without careful thought.
1525
1526 =cut
1527
1528 =head2 GetMarcItem
1529
1530 =over 4
1531
1532 my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1533
1534 =back
1535
1536 Returns MARC::Record of the item passed in parameter.
1537 This function is meant for use only in C<cataloguing/additem.pl>,
1538 where it is needed to support that script's MARC-like
1539 editor.
1540
1541 =cut
1542
1543 sub GetMarcItem {
1544     my ( $biblionumber, $itemnumber ) = @_;
1545
1546     # GetMarcItem has been revised so that it does the following:
1547     #  1. Gets the item information from the items table.
1548     #  2. Converts it to a MARC field for storage in the bib record.
1549     #
1550     # The previous behavior was:
1551     #  1. Get the bib record.
1552     #  2. Return the MARC tag corresponding to the item record.
1553     #
1554     # The difference is that one treats the items row as authoritative,
1555     # while the other treats the MARC representation as authoritative
1556     # under certain circumstances.
1557
1558     my $itemrecord = GetItem($itemnumber);
1559
1560     # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1561     # Also, don't emit a subfield if the underlying field is blank.
1562     my $mungeditem = {
1563         map {
1564             defined($itemrecord->{$_}) && $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : ()
1565         } keys %{ $itemrecord }
1566     };
1567     my $itemmarc = TransformKohaToMarc($mungeditem);
1568
1569     my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1570     if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1571         my @fields = $itemmarc->fields();
1572         if ($#fields > -1) {
1573             $fields[0]->add_subfields(@$unlinked_item_subfields);
1574         }
1575     }
1576
1577     return $itemmarc;
1578
1579 }
1580
1581 =head1 PRIVATE FUNCTIONS AND VARIABLES
1582
1583 The following functions are not meant to be called
1584 directly, but are documented in order to explain
1585 the inner workings of C<C4::Items>.
1586
1587 =cut
1588
1589 =head2 %derived_columns
1590
1591 This hash keeps track of item columns that
1592 are strictly derived from other columns in
1593 the item record and are not meant to be set
1594 independently.
1595
1596 Each key in the hash should be the name of a
1597 column (as named by TransformMarcToKoha).  Each
1598 value should be hashref whose keys are the
1599 columns on which the derived column depends.  The
1600 hashref should also contain a 'BUILDER' key
1601 that is a reference to a sub that calculates
1602 the derived value.
1603
1604 =cut
1605
1606 my %derived_columns = (
1607     'items.cn_sort' => {
1608         'itemcallnumber' => 1,
1609         'items.cn_source' => 1,
1610         'BUILDER' => \&_calc_items_cn_sort,
1611     }
1612 );
1613
1614 =head2 _set_derived_columns_for_add
1615
1616 =over 4
1617
1618 _set_derived_column_for_add($item);
1619
1620 =back
1621
1622 Given an item hash representing a new item to be added,
1623 calculate any derived columns.  Currently the only
1624 such column is C<items.cn_sort>.
1625
1626 =cut
1627
1628 sub _set_derived_columns_for_add {
1629     my $item = shift;
1630
1631     foreach my $column (keys %derived_columns) {
1632         my $builder = $derived_columns{$column}->{'BUILDER'};
1633         my $source_values = {};
1634         foreach my $source_column (keys %{ $derived_columns{$column} }) {
1635             next if $source_column eq 'BUILDER';
1636             $source_values->{$source_column} = $item->{$source_column};
1637         }
1638         $builder->($item, $source_values);
1639     }
1640 }
1641
1642 =head2 _set_derived_columns_for_mod
1643
1644 =over 4
1645
1646 _set_derived_column_for_mod($item);
1647
1648 =back
1649
1650 Given an item hash representing a new item to be modified.
1651 calculate any derived columns.  Currently the only
1652 such column is C<items.cn_sort>.
1653
1654 This routine differs from C<_set_derived_columns_for_add>
1655 in that it needs to handle partial item records.  In other
1656 words, the caller of C<ModItem> may have supplied only one
1657 or two columns to be changed, so this function needs to
1658 determine whether any of the columns to be changed affect
1659 any of the derived columns.  Also, if a derived column
1660 depends on more than one column, but the caller is not
1661 changing all of then, this routine retrieves the unchanged
1662 values from the database in order to ensure a correct
1663 calculation.
1664
1665 =cut
1666
1667 sub _set_derived_columns_for_mod {
1668     my $item = shift;
1669
1670     foreach my $column (keys %derived_columns) {
1671         my $builder = $derived_columns{$column}->{'BUILDER'};
1672         my $source_values = {};
1673         my %missing_sources = ();
1674         my $must_recalc = 0;
1675         foreach my $source_column (keys %{ $derived_columns{$column} }) {
1676             next if $source_column eq 'BUILDER';
1677             if (exists $item->{$source_column}) {
1678                 $must_recalc = 1;
1679                 $source_values->{$source_column} = $item->{$source_column};
1680             } else {
1681                 $missing_sources{$source_column} = 1;
1682             }
1683         }
1684         if ($must_recalc) {
1685             foreach my $source_column (keys %missing_sources) {
1686                 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
1687             }
1688             $builder->($item, $source_values);
1689         }
1690     }
1691 }
1692
1693 =head2 _do_column_fixes_for_mod
1694
1695 =over 4
1696
1697 _do_column_fixes_for_mod($item);
1698
1699 =back
1700
1701 Given an item hashref containing one or more
1702 columns to modify, fix up certain values.
1703 Specifically, set to 0 any passed value
1704 of C<notforloan>, C<damaged>, C<itemlost>, or
1705 C<wthdrawn> that is either undefined or
1706 contains the empty string.
1707
1708 =cut
1709
1710 sub _do_column_fixes_for_mod {
1711     my $item = shift;
1712
1713     if (exists $item->{'notforloan'} and
1714         (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
1715         $item->{'notforloan'} = 0;
1716     }
1717     if (exists $item->{'damaged'} and
1718         (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
1719         $item->{'damaged'} = 0;
1720     }
1721     if (exists $item->{'itemlost'} and
1722         (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
1723         $item->{'itemlost'} = 0;
1724     }
1725     if (exists $item->{'wthdrawn'} and
1726         (not defined $item->{'wthdrawn'} or $item->{'wthdrawn'} eq '')) {
1727         $item->{'wthdrawn'} = 0;
1728     }
1729 }
1730
1731 =head2 _get_single_item_column
1732
1733 =over 4
1734
1735 _get_single_item_column($column, $itemnumber);
1736
1737 =back
1738
1739 Retrieves the value of a single column from an C<items>
1740 row specified by C<$itemnumber>.
1741
1742 =cut
1743
1744 sub _get_single_item_column {
1745     my $column = shift;
1746     my $itemnumber = shift;
1747
1748     my $dbh = C4::Context->dbh;
1749     my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
1750     $sth->execute($itemnumber);
1751     my ($value) = $sth->fetchrow();
1752     return $value;
1753 }
1754
1755 =head2 _calc_items_cn_sort
1756
1757 =over 4
1758
1759 _calc_items_cn_sort($item, $source_values);
1760
1761 =back
1762
1763 Helper routine to calculate C<items.cn_sort>.
1764
1765 =cut
1766
1767 sub _calc_items_cn_sort {
1768     my $item = shift;
1769     my $source_values = shift;
1770
1771     $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
1772 }
1773
1774 =head2 _set_defaults_for_add
1775
1776 =over 4
1777
1778 _set_defaults_for_add($item_hash);
1779
1780 =back
1781
1782 Given an item hash representing an item to be added, set
1783 correct default values for columns whose default value
1784 is not handled by the DBMS.  This includes the following
1785 columns:
1786
1787 =over 2
1788
1789 =item *
1790
1791 C<items.dateaccessioned>
1792
1793 =item *
1794
1795 C<items.notforloan>
1796
1797 =item *
1798
1799 C<items.damaged>
1800
1801 =item *
1802
1803 C<items.itemlost>
1804
1805 =item *
1806
1807 C<items.wthdrawn>
1808
1809 =back
1810
1811 =cut
1812
1813 sub _set_defaults_for_add {
1814     my $item = shift;
1815     $item->{dateaccessioned} ||= C4::Dates->new->output('iso');
1816     $item->{$_} ||= 0 for (qw( notforloan damaged itemlost wthdrawn));
1817 }
1818
1819 =head2 _koha_new_item
1820
1821 =over 4
1822
1823 my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
1824
1825 =back
1826
1827 Perform the actual insert into the C<items> table.
1828
1829 =cut
1830
1831 sub _koha_new_item {
1832     my ( $item, $barcode ) = @_;
1833     my $dbh=C4::Context->dbh;
1834     my $error;
1835     my $query =
1836            "INSERT INTO items SET
1837             biblionumber        = ?,
1838             biblioitemnumber    = ?,
1839             barcode             = ?,
1840             dateaccessioned     = ?,
1841             booksellerid        = ?,
1842             homebranch          = ?,
1843             price               = ?,
1844             replacementprice    = ?,
1845             replacementpricedate = NOW(),
1846             datelastborrowed    = ?,
1847             datelastseen        = NOW(),
1848             stack               = ?,
1849             notforloan          = ?,
1850             damaged             = ?,
1851             itemlost            = ?,
1852             wthdrawn            = ?,
1853             itemcallnumber      = ?,
1854             restricted          = ?,
1855             itemnotes           = ?,
1856             holdingbranch       = ?,
1857             paidfor             = ?,
1858             location            = ?,
1859             onloan              = ?,
1860             issues              = ?,
1861             renewals            = ?,
1862             reserves            = ?,
1863             cn_source           = ?,
1864             cn_sort             = ?,
1865             ccode               = ?,
1866             itype               = ?,
1867             materials           = ?,
1868             uri = ?,
1869             enumchron           = ?,
1870             more_subfields_xml  = ?,
1871             copynumber          = ?
1872           ";
1873     my $sth = $dbh->prepare($query);
1874    $sth->execute(
1875             $item->{'biblionumber'},
1876             $item->{'biblioitemnumber'},
1877             $barcode,
1878             $item->{'dateaccessioned'},
1879             $item->{'booksellerid'},
1880             $item->{'homebranch'},
1881             $item->{'price'},
1882             $item->{'replacementprice'},
1883             $item->{datelastborrowed},
1884             $item->{stack},
1885             $item->{'notforloan'},
1886             $item->{'damaged'},
1887             $item->{'itemlost'},
1888             $item->{'wthdrawn'},
1889             $item->{'itemcallnumber'},
1890             $item->{'restricted'},
1891             $item->{'itemnotes'},
1892             $item->{'holdingbranch'},
1893             $item->{'paidfor'},
1894             $item->{'location'},
1895             $item->{'onloan'},
1896             $item->{'issues'},
1897             $item->{'renewals'},
1898             $item->{'reserves'},
1899             $item->{'items.cn_source'},
1900             $item->{'items.cn_sort'},
1901             $item->{'ccode'},
1902             $item->{'itype'},
1903             $item->{'materials'},
1904             $item->{'uri'},
1905             $item->{'enumchron'},
1906             $item->{'more_subfields_xml'},
1907             $item->{'copynumber'},
1908     );
1909     my $itemnumber = $dbh->{'mysql_insertid'};
1910     if ( defined $sth->errstr ) {
1911         $error.="ERROR in _koha_new_item $query".$sth->errstr;
1912     }
1913     $sth->finish();
1914     return ( $itemnumber, $error );
1915 }
1916
1917 =head2 _koha_modify_item
1918
1919 =over 4
1920
1921 my ($itemnumber,$error) =_koha_modify_item( $item );
1922
1923 =back
1924
1925 Perform the actual update of the C<items> row.  Note that this
1926 routine accepts a hashref specifying the columns to update.
1927
1928 =cut
1929
1930 sub _koha_modify_item {
1931     my ( $item ) = @_;
1932     my $dbh=C4::Context->dbh;
1933     my $error;
1934
1935     my $query = "UPDATE items SET ";
1936     my @bind;
1937     for my $key ( keys %$item ) {
1938         $query.="$key=?,";
1939         push @bind, $item->{$key};
1940     }
1941     $query =~ s/,$//;
1942     $query .= " WHERE itemnumber=?";
1943     push @bind, $item->{'itemnumber'};
1944     my $sth = C4::Context->dbh->prepare($query);
1945     $sth->execute(@bind);
1946     if ( C4::Context->dbh->errstr ) {
1947         $error.="ERROR in _koha_modify_item $query".$dbh->errstr;
1948         warn $error;
1949     }
1950     $sth->finish();
1951     return ($item->{'itemnumber'},$error);
1952 }
1953
1954 =head2 _koha_delete_item
1955
1956 =over 4
1957
1958 _koha_delete_item( $dbh, $itemnum );
1959
1960 =back
1961
1962 Internal function to delete an item record from the koha tables
1963
1964 =cut
1965
1966 sub _koha_delete_item {
1967     my ( $dbh, $itemnum ) = @_;
1968
1969     # save the deleted item to deleteditems table
1970     my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
1971     $sth->execute($itemnum);
1972     my $data = $sth->fetchrow_hashref();
1973     $sth->finish();
1974     my $query = "INSERT INTO deleteditems SET ";
1975     my @bind  = ();
1976     foreach my $key ( keys %$data ) {
1977         $query .= "$key = ?,";
1978         push( @bind, $data->{$key} );
1979     }
1980     $query =~ s/\,$//;
1981     $sth = $dbh->prepare($query);
1982     $sth->execute(@bind);
1983     $sth->finish();
1984
1985     # delete from items table
1986     $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
1987     $sth->execute($itemnum);
1988     $sth->finish();
1989     return undef;
1990 }
1991
1992 =head2 _marc_from_item_hash
1993
1994 =over 4
1995
1996 my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
1997
1998 =back
1999
2000 Given an item hash representing a complete item record,
2001 create a C<MARC::Record> object containing an embedded
2002 tag representing that item.
2003
2004 The third, optional parameter C<$unlinked_item_subfields> is
2005 an arrayref of subfields (not mapped to C<items> fields per the
2006 framework) to be added to the MARC representation
2007 of the item.
2008
2009 =cut
2010
2011 sub _marc_from_item_hash {
2012     my $item = shift;
2013     my $frameworkcode = shift;
2014     my $unlinked_item_subfields;
2015     if (@_) {
2016         $unlinked_item_subfields = shift;
2017     }
2018
2019     # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
2020     # Also, don't emit a subfield if the underlying field is blank.
2021     my $mungeditem = { map {  (defined($item->{$_}) and $item->{$_} ne '') ?
2022                                 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
2023                                 : ()  } keys %{ $item } };
2024
2025     my $item_marc = MARC::Record->new();
2026     foreach my $item_field (keys %{ $mungeditem }) {
2027         my ($tag, $subfield) = GetMarcFromKohaField($item_field, $frameworkcode);
2028         next unless defined $tag and defined $subfield; # skip if not mapped to MARC field
2029         if (my $field = $item_marc->field($tag)) {
2030             $field->add_subfields($subfield => $mungeditem->{$item_field});
2031         } else {
2032             my $add_subfields = [];
2033             if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2034                 $add_subfields = $unlinked_item_subfields;
2035             }
2036             $item_marc->add_fields( $tag, " ", " ", $subfield =>  $mungeditem->{$item_field}, @$add_subfields);
2037         }
2038     }
2039
2040     return $item_marc;
2041 }
2042
2043 =head2 _add_item_field_to_biblio
2044
2045 =over 4
2046
2047 _add_item_field_to_biblio($item_marc, $biblionumber, $frameworkcode);
2048
2049 =back
2050
2051 Adds the fields from a MARC record containing the
2052 representation of a Koha item record to the MARC
2053 biblio record.  The input C<$item_marc> record
2054 is expect to contain just one field, the embedded
2055 item information field.
2056
2057 =cut
2058
2059 sub _add_item_field_to_biblio {
2060     my ($item_marc, $biblionumber, $frameworkcode) = @_;
2061
2062     my $biblio_marc = GetMarcBiblio($biblionumber);
2063     foreach my $field ($item_marc->fields()) {
2064         $biblio_marc->append_fields($field);
2065     }
2066
2067     ModBiblioMarc($biblio_marc, $biblionumber, $frameworkcode);
2068 }
2069
2070 =head2 _replace_item_field_in_biblio
2071
2072 =over
2073
2074 &_replace_item_field_in_biblio($item_marc, $biblionumber, $itemnumber, $frameworkcode)
2075
2076 =back
2077
2078 Given a MARC::Record C<$item_marc> containing one tag with the MARC
2079 representation of the item, examine the biblio MARC
2080 for the corresponding tag for that item and
2081 replace it with the tag from C<$item_marc>.
2082
2083 =cut
2084
2085 sub _replace_item_field_in_biblio {
2086     my ($ItemRecord, $biblionumber, $itemnumber, $frameworkcode) = @_;
2087     my $dbh = C4::Context->dbh;
2088
2089     # get complete MARC record & replace the item field by the new one
2090     my $completeRecord = GetMarcBiblio($biblionumber);
2091     my ($itemtag,$itemsubfield) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
2092     my $itemField = $ItemRecord->field($itemtag);
2093     my @items = $completeRecord->field($itemtag);
2094     my $found = 0;
2095     foreach (@items) {
2096         if ($_->subfield($itemsubfield) eq $itemnumber) {
2097             $_->replace_with($itemField);
2098             $found = 1;
2099         }
2100     }
2101
2102     unless ($found) {
2103         # If we haven't found the matching field,
2104         # just add it.  However, this means that
2105         # there is likely a bug.
2106         $completeRecord->append_fields($itemField);
2107     }
2108
2109     # save the record
2110     ModBiblioMarc($completeRecord, $biblionumber, $frameworkcode);
2111 }
2112
2113 =head2 _repack_item_errors
2114
2115 Add an error message hash generated by C<CheckItemPreSave>
2116 to a list of errors.
2117
2118 =cut
2119
2120 sub _repack_item_errors {
2121     my $item_sequence_num = shift;
2122     my $item_ref = shift;
2123     my $error_ref = shift;
2124
2125     my @repacked_errors = ();
2126
2127     foreach my $error_code (sort keys %{ $error_ref }) {
2128         my $repacked_error = {};
2129         $repacked_error->{'item_sequence'} = $item_sequence_num;
2130         $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
2131         $repacked_error->{'error_code'} = $error_code;
2132         $repacked_error->{'error_information'} = $error_ref->{$error_code};
2133         push @repacked_errors, $repacked_error;
2134     }
2135
2136     return @repacked_errors;
2137 }
2138
2139 =head2 _get_unlinked_item_subfields
2140
2141 =over 4
2142
2143 my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
2144
2145 =back
2146
2147 =cut
2148
2149 sub _get_unlinked_item_subfields {
2150     my $original_item_marc = shift;
2151     my $frameworkcode = shift;
2152
2153     my $marcstructure = GetMarcStructure(1, $frameworkcode);
2154
2155     # assume that this record has only one field, and that that
2156     # field contains only the item information
2157     my $subfields = [];
2158     my @fields = $original_item_marc->fields();
2159     if ($#fields > -1) {
2160         my $field = $fields[0];
2161             my $tag = $field->tag();
2162         foreach my $subfield ($field->subfields()) {
2163             if (defined $subfield->[1] and
2164                 $subfield->[1] ne '' and
2165                 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
2166                 push @$subfields, $subfield->[0] => $subfield->[1];
2167             }
2168         }
2169     }
2170     return $subfields;
2171 }
2172
2173 =head2 _get_unlinked_subfields_xml
2174
2175 =over 4
2176
2177 my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
2178
2179 =back
2180
2181 =cut
2182
2183 sub _get_unlinked_subfields_xml {
2184     my $unlinked_item_subfields = shift;
2185
2186     my $xml;
2187     if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2188         my $marc = MARC::Record->new();
2189         # use of tag 999 is arbitrary, and doesn't need to match the item tag
2190         # used in the framework
2191         $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
2192         $marc->encoding("UTF-8");
2193         $xml = $marc->as_xml("USMARC");
2194     }
2195
2196     return $xml;
2197 }
2198
2199 =head2 _parse_unlinked_item_subfields_from_xml
2200
2201 =over 4
2202
2203 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2204
2205 =back
2206
2207 =cut
2208
2209 sub  _parse_unlinked_item_subfields_from_xml {
2210     my $xml = shift;
2211
2212     return unless defined $xml and $xml ne "";
2213     my $marc = MARC::Record->new_from_xml(StripNonXmlChars($xml),'UTF-8');
2214     my $unlinked_subfields = [];
2215     my @fields = $marc->fields();
2216     if ($#fields > -1) {
2217         foreach my $subfield ($fields[0]->subfields()) {
2218             push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2219         }
2220     }
2221     return $unlinked_subfields;
2222 }
2223
2224 1;