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