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
 979             LEFT JOIN biblio ON (items.biblionumber = biblio.biblionumber)
 980             LEFT JOIN biblioitems ON (items.biblionumber = biblioitems.biblionumber)
 981             LEFT JOIN authorised_values ON (items.itemlost = authorised_values.authorised_value)
 982         WHERE
 983                 authorised_values.category = 'LOST'
 984                 AND itemlost IS NOT NULL
 985                 AND itemlost <> 0
 986     ";
 987     my @query_parameters;
 988     foreach my $key (keys %$where) {
 989         $query .= " AND $key LIKE ?";
 990         push @query_parameters, "%$where->{$key}%";
 991     }
 992     my @ordervalues = qw/title author homebranch itype barcode price replacementprice lib datelastseen location/;
 993
 994     if ( defined $orderby && grep($orderby, @ordervalues)) {
 995         $query .= ' ORDER BY '.$orderby;
 996     }
 997
 998     my $sth = $dbh->prepare($query);
 999     $sth->execute( @query_parameters );
1000     my $items = [];
1001     while ( my $row = $sth->fetchrow_hashref ){
1002         push @$items, $row;
1003     }
1004     return $items;
1005 }
1006
1007 =head2 GetItemsForInventory
1008
1009 =over 4
1010
1011 $itemlist = GetItemsForInventory($minlocation, $maxlocation, $location, $itemtype $datelastseen, $branch, $offset, $size);
1012
1013 =back
1014
1015 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
1016
1017 The sub returns a reference to a list of hashes, each containing
1018 itemnumber, author, title, barcode, item callnumber, and date last
1019 seen. It is ordered by callnumber then title.
1020
1021 The required minlocation & maxlocation parameters are used to specify a range of item callnumbers
1022 the datelastseen can be used to specify that you want to see items not seen since a past date only.
1023 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
1024
1025 =cut
1026
1027 sub GetItemsForInventory {
1028     my ( $minlocation, $maxlocation,$location, $itemtype, $ignoreissued, $datelastseen, $branch, $offset, $size ) = @_;
1029     my $dbh = C4::Context->dbh;
1030     my ( @bind_params, @where_strings );
1031
1032     my $query = <<'END_SQL';
1033 SELECT items.itemnumber, barcode, itemcallnumber, title, author, biblio.biblionumber, datelastseen
1034 FROM items
1035   LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
1036   LEFT JOIN biblioitems on items.biblionumber = biblioitems.biblionumber
1037 END_SQL
1038
1039     if ($minlocation) {
1040         push @where_strings, 'itemcallnumber >= ?';
1041         push @bind_params, $minlocation;
1042     }
1043
1044     if ($maxlocation) {
1045         push @where_strings, 'itemcallnumber <= ?';
1046         push @bind_params, $maxlocation;
1047     }
1048
1049     if ($datelastseen) {
1050         $datelastseen = format_date_in_iso($datelastseen);
1051         push @where_strings, '(datelastseen < ? OR datelastseen IS NULL)';
1052         push @bind_params, $datelastseen;
1053     }
1054
1055     if ( $location ) {
1056         push @where_strings, 'items.location = ?';
1057         push @bind_params, $location;
1058     }
1059
1060     if ( $branch ) {
1061         push @where_strings, 'items.homebranch = ?';
1062         push @bind_params, $branch;
1063     }
1064
1065     if ( $itemtype ) {
1066         push @where_strings, 'biblioitems.itemtype = ?';
1067         push @bind_params, $itemtype;
1068     }
1069     if ( $ignoreissued) {
1070         $query .= "LEFT JOIN issues ON items.itemnumber = issues.itemnumber ";
1071         push @where_strings, 'issues.date_due IS NULL';
1072     }
1073
1074     if ( @where_strings ) {
1075         $query .= 'WHERE ';
1076         $query .= join ' AND ', @where_strings;
1077     }
1078     $query .= ' ORDER BY itemcallnumber, title';
1079     my $sth = $dbh->prepare($query);
1080     $sth->execute( @bind_params );
1081
1082     my @results;
1083     $size--;
1084     while ( my $row = $sth->fetchrow_hashref ) {
1085         $offset-- if ($offset);
1086         $row->{datelastseen}=format_date($row->{datelastseen});
1087         if ( ( !$offset ) && $size ) {
1088             push @results, $row;
1089             $size--;
1090         }
1091     }
1092     return \@results;
1093 }
1094
1095 =head2 GetItemsCount
1096
1097 =over 4
1098 $count = &GetItemsCount( $biblionumber);
1099
1100 =back
1101
1102 This function return count of item with $biblionumber
1103
1104 =cut
1105
1106 sub GetItemsCount {
1107     my ( $biblionumber ) = @_;
1108     my $dbh = C4::Context->dbh;
1109     my $query = "SELECT count(*)
1110           FROM  items
1111           WHERE biblionumber=?";
1112     my $sth = $dbh->prepare($query);
1113     $sth->execute($biblionumber);
1114     my $count = $sth->fetchrow;
1115     $sth->finish;
1116     return ($count);
1117 }
1118
1119 =head2 GetItemInfosOf
1120
1121 =over 4
1122
1123 GetItemInfosOf(@itemnumbers);
1124
1125 =back
1126
1127 =cut
1128
1129 sub GetItemInfosOf {
1130     my @itemnumbers = @_;
1131
1132     my $query = '
1133         SELECT *
1134         FROM items
1135         WHERE itemnumber IN (' . join( ',', @itemnumbers ) . ')
1136     ';
1137     return get_infos_of( $query, 'itemnumber' );
1138 }
1139
1140 =head2 GetItemsByBiblioitemnumber
1141
1142 =over 4
1143
1144 GetItemsByBiblioitemnumber($biblioitemnumber);
1145
1146 =back
1147
1148 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1149 Called by C<C4::XISBN>
1150
1151 =cut
1152
1153 sub GetItemsByBiblioitemnumber {
1154     my ( $bibitem ) = @_;
1155     my $dbh = C4::Context->dbh;
1156     my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1157     # Get all items attached to a biblioitem
1158     my $i = 0;
1159     my @results;
1160     $sth->execute($bibitem) || die $sth->errstr;
1161     while ( my $data = $sth->fetchrow_hashref ) {
1162         # Foreach item, get circulation information
1163         my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1164                                    WHERE itemnumber = ?
1165                                    AND issues.borrowernumber = borrowers.borrowernumber"
1166         );
1167         $sth2->execute( $data->{'itemnumber'} );
1168         if ( my $data2 = $sth2->fetchrow_hashref ) {
1169             # if item is out, set the due date and who it is out too
1170             $data->{'date_due'}   = $data2->{'date_due'};
1171             $data->{'cardnumber'} = $data2->{'cardnumber'};
1172             $data->{'borrowernumber'}   = $data2->{'borrowernumber'};
1173         }
1174         else {
1175             # set date_due to blank, so in the template we check itemlost, and wthdrawn
1176             $data->{'date_due'} = '';
1177         }    # else
1178         $sth2->finish;
1179         # Find the last 3 people who borrowed this item.
1180         my $query2 = "SELECT * FROM old_issues, borrowers WHERE itemnumber = ?
1181                       AND old_issues.borrowernumber = borrowers.borrowernumber
1182                       ORDER BY returndate desc,timestamp desc LIMIT 3";
1183         $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1184         $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1185         my $i2 = 0;
1186         while ( my $data2 = $sth2->fetchrow_hashref ) {
1187             $data->{"timestamp$i2"} = $data2->{'timestamp'};
1188             $data->{"card$i2"}      = $data2->{'cardnumber'};
1189             $data->{"borrower$i2"}  = $data2->{'borrowernumber'};
1190             $i2++;
1191         }
1192         $sth2->finish;
1193         push(@results,$data);
1194     }
1195     $sth->finish;
1196     return (\@results);
1197 }
1198
1199 =head2 GetItemsInfo
1200
1201 =over 4
1202
1203 @results = GetItemsInfo($biblionumber, $type);
1204
1205 =back
1206
1207 Returns information about books with the given biblionumber.
1208
1209 C<$type> may be either C<intra> or anything else. If it is not set to
1210 C<intra>, then the search will exclude lost, very overdue, and
1211 withdrawn items.
1212
1213 C<GetItemsInfo> returns a list of references-to-hash. Each element
1214 contains a number of keys. Most of them are table items from the
1215 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
1216 Koha database. Other keys include:
1217
1218 =over 2
1219
1220 =item C<$data-E<gt>{branchname}>
1221
1222 The name (not the code) of the branch to which the book belongs.
1223
1224 =item C<$data-E<gt>{datelastseen}>
1225
1226 This is simply C<items.datelastseen>, except that while the date is
1227 stored in YYYY-MM-DD format in the database, here it is converted to
1228 DD/MM/YYYY format. A NULL date is returned as C<//>.
1229
1230 =item C<$data-E<gt>{datedue}>
1231
1232 =item C<$data-E<gt>{class}>
1233
1234 This is the concatenation of C<biblioitems.classification>, the book's
1235 Dewey code, and C<biblioitems.subclass>.
1236
1237 =item C<$data-E<gt>{ocount}>
1238
1239 I think this is the number of copies of the book available.
1240
1241 =item C<$data-E<gt>{order}>
1242
1243 If this is set, it is set to C<One Order>.
1244
1245 =back
1246
1247 =cut
1248
1249 sub GetItemsInfo {
1250     my ( $biblionumber, $type ) = @_;
1251     my $dbh   = C4::Context->dbh;
1252     # note biblioitems.* must be avoided to prevent large marc and marcxml fields from killing performance.
1253     my $query = "
1254     SELECT items.*,
1255            biblio.*,
1256            biblioitems.volume,
1257            biblioitems.number,
1258            biblioitems.itemtype,
1259            biblioitems.isbn,
1260            biblioitems.issn,
1261            biblioitems.publicationyear,
1262            biblioitems.publishercode,
1263            biblioitems.volumedate,
1264            biblioitems.volumedesc,
1265            biblioitems.lccn,
1266            biblioitems.url,
1267            items.notforloan as itemnotforloan,
1268            itemtypes.description
1269      FROM items
1270      LEFT JOIN biblio      ON      biblio.biblionumber     = items.biblionumber
1271      LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1272      LEFT JOIN itemtypes   ON   itemtypes.itemtype         = "
1273      . (C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype');
1274     $query .= " WHERE items.biblionumber = ? ORDER BY items.dateaccessioned desc" ;
1275     my $sth = $dbh->prepare($query);
1276     $sth->execute($biblionumber);
1277     my $i = 0;
1278     my @results;
1279     my ( $date_due, $count_reserves, $serial );
1280
1281     my $isth    = $dbh->prepare(
1282         "SELECT issues.*,borrowers.cardnumber,borrowers.surname,borrowers.firstname,borrowers.branchcode as bcode
1283         FROM   issues LEFT JOIN borrowers ON issues.borrowernumber=borrowers.borrowernumber
1284         WHERE  itemnumber = ?"
1285        );
1286         my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=? ");
1287         while ( my $data = $sth->fetchrow_hashref ) {
1288         my $datedue = '';
1289         $isth->execute( $data->{'itemnumber'} );
1290         if ( my $idata = $isth->fetchrow_hashref ) {
1291             $data->{borrowernumber} = $idata->{borrowernumber};
1292             $data->{cardnumber}     = $idata->{cardnumber};
1293             $data->{surname}     = $idata->{surname};
1294             $data->{firstname}     = $idata->{firstname};
1295             $datedue                = $idata->{'date_due'};
1296         if (C4::Context->preference("IndependantBranches")){
1297         my $userenv = C4::Context->userenv;
1298         if ( ($userenv) && ( $userenv->{flags} != 1 ) ) {
1299             $data->{'NOTSAMEBRANCH'} = 1 if ($idata->{'bcode'} ne $userenv->{branch});
1300         }
1301         }
1302         }
1303                 if ( $data->{'serial'}) {
1304                         $ssth->execute($data->{'itemnumber'}) ;
1305                         ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
1306                         $serial = 1;
1307         }
1308                 if ( $datedue eq '' ) {
1309             my ( $restype, $reserves ) =
1310               C4::Reserves::CheckReserves( $data->{'itemnumber'} );
1311             if ($restype) {
1312                 $count_reserves = $restype;
1313             }
1314         }
1315         $isth->finish;
1316         $ssth->finish;
1317         #get branch information.....
1318         my $bsth = $dbh->prepare(
1319             "SELECT * FROM branches WHERE branchcode = ?
1320         "
1321         );
1322         $bsth->execute( $data->{'holdingbranch'} );
1323         if ( my $bdata = $bsth->fetchrow_hashref ) {
1324             $data->{'branchname'} = $bdata->{'branchname'};
1325         }
1326         $data->{'datedue'}        = $datedue;
1327         $data->{'count_reserves'} = $count_reserves;
1328
1329         # get notforloan complete status if applicable
1330         my $sthnflstatus = $dbh->prepare(
1331             'SELECT authorised_value
1332             FROM   marc_subfield_structure
1333             WHERE  kohafield="items.notforloan"
1334         '
1335         );
1336
1337         $sthnflstatus->execute;
1338         my ($authorised_valuecode) = $sthnflstatus->fetchrow;
1339         if ($authorised_valuecode) {
1340             $sthnflstatus = $dbh->prepare(
1341                 "SELECT lib FROM authorised_values
1342                  WHERE  category=?
1343                  AND authorised_value=?"
1344             );
1345             $sthnflstatus->execute( $authorised_valuecode,
1346                 $data->{itemnotforloan} );
1347             my ($lib) = $sthnflstatus->fetchrow;
1348             $data->{notforloanvalue} = $lib;
1349         }
1350                 $data->{itypenotforloan} = $data->{notforloan} if (C4::Context->preference('item-level_itypes'));
1351
1352         # my stack procedures
1353         my $stackstatus = $dbh->prepare(
1354             'SELECT authorised_value
1355              FROM   marc_subfield_structure
1356              WHERE  kohafield="items.stack"
1357         '
1358         );
1359         $stackstatus->execute;
1360
1361         ($authorised_valuecode) = $stackstatus->fetchrow;
1362         if ($authorised_valuecode) {
1363             $stackstatus = $dbh->prepare(
1364                 "SELECT lib
1365                  FROM   authorised_values
1366                  WHERE  category=?
1367                  AND    authorised_value=?
1368             "
1369             );
1370             $stackstatus->execute( $authorised_valuecode, $data->{stack} );
1371             my ($lib) = $stackstatus->fetchrow;
1372             $data->{stack} = $lib;
1373         }
1374         # Find the last 3 people who borrowed this item.
1375         my $sth2 = $dbh->prepare("SELECT * FROM old_issues,borrowers
1376                                     WHERE itemnumber = ?
1377                                     AND old_issues.borrowernumber = borrowers.borrowernumber
1378                                     ORDER BY returndate DESC
1379                                     LIMIT 3");
1380         $sth2->execute($data->{'itemnumber'});
1381         my $ii = 0;
1382         while (my $data2 = $sth2->fetchrow_hashref()) {
1383             $data->{"timestamp$ii"} = $data2->{'timestamp'} if $data2->{'timestamp'};
1384             $data->{"card$ii"}      = $data2->{'cardnumber'} if $data2->{'cardnumber'};
1385             $data->{"borrower$ii"}  = $data2->{'borrowernumber'} if $data2->{'borrowernumber'};
1386             $ii++;
1387         }
1388
1389         $results[$i] = $data;
1390         $i++;
1391     }
1392         if($serial) {
1393                 return( sort { ($b->{'publisheddate'} || $b->{'enumchron'}) cmp ($a->{'publisheddate'} || $a->{'enumchron'}) } @results );
1394         } else {
1395         return (@results);
1396         }
1397 }
1398
1399 =head2 get_itemnumbers_of
1400
1401 =over 4
1402
1403 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1404
1405 =back
1406
1407 Given a list of biblionumbers, return the list of corresponding itemnumbers
1408 for each biblionumber.
1409
1410 Return a reference on a hash where keys are biblionumbers and values are
1411 references on array of itemnumbers.
1412
1413 =cut
1414
1415 sub get_itemnumbers_of {
1416     my @biblionumbers = @_;
1417
1418     my $dbh = C4::Context->dbh;
1419
1420     my $query = '
1421         SELECT itemnumber,
1422             biblionumber
1423         FROM items
1424         WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1425     ';
1426     my $sth = $dbh->prepare($query);
1427     $sth->execute(@biblionumbers);
1428
1429     my %itemnumbers_of;
1430
1431     while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1432         push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1433     }
1434
1435     return \%itemnumbers_of;
1436 }
1437
1438 =head2 GetItemnumberFromBarcode
1439
1440 =over 4
1441
1442 $result = GetItemnumberFromBarcode($barcode);
1443
1444 =back
1445
1446 =cut
1447
1448 sub GetItemnumberFromBarcode {
1449     my ($barcode) = @_;
1450     my $dbh = C4::Context->dbh;
1451
1452     my $rq =
1453       $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1454     $rq->execute($barcode);
1455     my ($result) = $rq->fetchrow;
1456     return ($result);
1457 }
1458
1459 =head3 get_item_authorised_values
1460
1461   find the types and values for all authorised values assigned to this item.
1462
1463   parameters:
1464     itemnumber
1465
1466   returns: a hashref malling the authorised value to the value set for this itemnumber
1467
1468     $authorised_values = {
1469              'CCODE'      => undef,
1470              'DAMAGED'    => '0',
1471              'LOC'        => '3',
1472              'LOST'       => '0'
1473              'NOT_LOAN'   => '0',
1474              'RESTRICTED' => undef,
1475              'STACK'      => undef,
1476              'WITHDRAWN'  => '0',
1477              'branches'   => 'CPL',
1478              'cn_source'  => undef,
1479              'itemtypes'  => 'SER',
1480            };
1481
1482    Notes: see C4::Biblio::get_biblio_authorised_values for a similar method at the biblio level.
1483
1484 =cut
1485
1486 sub get_item_authorised_values {
1487     my $itemnumber = shift;
1488
1489     # assume that these entries in the authorised_value table are item level.
1490     my $query = q(SELECT distinct authorised_value, kohafield
1491                     FROM marc_subfield_structure
1492                     WHERE kohafield like 'item%'
1493                       AND authorised_value != '' );
1494
1495     my $itemlevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
1496     my $iteminfo = GetItem( $itemnumber );
1497     # warn( Data::Dumper->Dump( [ $itemlevel_authorised_values ], [ 'itemlevel_authorised_values' ] ) );
1498     my $return;
1499     foreach my $this_authorised_value ( keys %$itemlevel_authorised_values ) {
1500         my $field = $itemlevel_authorised_values->{ $this_authorised_value }->{'kohafield'};
1501         $field =~ s/^items\.//;
1502         if ( exists $iteminfo->{ $field } ) {
1503             $return->{ $this_authorised_value } = $iteminfo->{ $field };
1504         }
1505     }
1506     # warn( Data::Dumper->Dump( [ $return ], [ 'return' ] ) );
1507     return $return;
1508 }
1509
1510 =head3 get_authorised_value_images
1511
1512   find a list of icons that are appropriate for display based on the
1513   authorised values for a biblio.
1514
1515   parameters: listref of authorised values, such as comes from
1516     get_item_ahtorised_values or
1517     from C4::Biblio::get_biblio_authorised_values
1518
1519   returns: listref of hashrefs for each image. Each hashref looks like
1520     this:
1521
1522       { imageurl => '/intranet-tmpl/prog/img/itemtypeimg/npl/WEB.gif',
1523         label    => '',
1524         category => '',
1525         value    => '', }
1526
1527   Notes: Currently, I put on the full path to the images on the staff
1528   side. This should either be configurable or not done at all. Since I
1529   have to deal with 'intranet' or 'opac' in
1530   get_biblio_authorised_values, perhaps I should be passing it in.
1531
1532 =cut
1533
1534 sub get_authorised_value_images {
1535     my $authorised_values = shift;
1536
1537     my @imagelist;
1538
1539     my $authorised_value_list = GetAuthorisedValues();
1540     # warn ( Data::Dumper->Dump( [ $authorised_value_list ], [ 'authorised_value_list' ] ) );
1541     foreach my $this_authorised_value ( @$authorised_value_list ) {
1542         if ( exists $authorised_values->{ $this_authorised_value->{'category'} }
1543              && $authorised_values->{ $this_authorised_value->{'category'} } eq $this_authorised_value->{'authorised_value'} ) {
1544             # warn ( Data::Dumper->Dump( [ $this_authorised_value ], [ 'this_authorised_value' ] ) );
1545             if ( defined $this_authorised_value->{'imageurl'} ) {
1546                 push @imagelist, { imageurl => C4::Koha::getitemtypeimagelocation( 'intranet', $this_authorised_value->{'imageurl'} ),
1547                                    label    => $this_authorised_value->{'lib'},
1548                                    category => $this_authorised_value->{'category'},
1549                                    value    => $this_authorised_value->{'authorised_value'}, };
1550             }
1551         }
1552     }
1553
1554     # warn ( Data::Dumper->Dump( [ \@imagelist ], [ 'imagelist' ] ) );
1555     return \@imagelist;
1556
1557 }
1558
1559 =head1 LIMITED USE FUNCTIONS
1560
1561 The following functions, while part of the public API,
1562 are not exported.  This is generally because they are
1563 meant to be used by only one script for a specific
1564 purpose, and should not be used in any other context
1565 without careful thought.
1566
1567 =cut
1568
1569 =head2 GetMarcItem
1570
1571 =over 4
1572
1573 my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1574
1575 =back
1576
1577 Returns MARC::Record of the item passed in parameter.
1578 This function is meant for use only in C<cataloguing/additem.pl>,
1579 where it is needed to support that script's MARC-like
1580 editor.
1581
1582 =cut
1583
1584 sub GetMarcItem {
1585     my ( $biblionumber, $itemnumber ) = @_;
1586
1587     # GetMarcItem has been revised so that it does the following:
1588     #  1. Gets the item information from the items table.
1589     #  2. Converts it to a MARC field for storage in the bib record.
1590     #
1591     # The previous behavior was:
1592     #  1. Get the bib record.
1593     #  2. Return the MARC tag corresponding to the item record.
1594     #
1595     # The difference is that one treats the items row as authoritative,
1596     # while the other treats the MARC representation as authoritative
1597     # under certain circumstances.
1598
1599     my $itemrecord = GetItem($itemnumber);
1600
1601     # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1602     # Also, don't emit a subfield if the underlying field is blank.
1603     my $mungeditem = {
1604         map {
1605             defined($itemrecord->{$_}) && $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : ()
1606         } keys %{ $itemrecord }
1607     };
1608     my $itemmarc = TransformKohaToMarc($mungeditem);
1609
1610     my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1611     if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1612         my @fields = $itemmarc->fields();
1613         if ($#fields > -1) {
1614             $fields[0]->add_subfields(@$unlinked_item_subfields);
1615         }
1616     }
1617
1618     return $itemmarc;
1619
1620 }
1621
1622 =head1 PRIVATE FUNCTIONS AND VARIABLES
1623
1624 The following functions are not meant to be called
1625 directly, but are documented in order to explain
1626 the inner workings of C<C4::Items>.
1627
1628 =cut
1629
1630 =head2 %derived_columns
1631
1632 This hash keeps track of item columns that
1633 are strictly derived from other columns in
1634 the item record and are not meant to be set
1635 independently.
1636
1637 Each key in the hash should be the name of a
1638 column (as named by TransformMarcToKoha).  Each
1639 value should be hashref whose keys are the
1640 columns on which the derived column depends.  The
1641 hashref should also contain a 'BUILDER' key
1642 that is a reference to a sub that calculates
1643 the derived value.
1644
1645 =cut
1646
1647 my %derived_columns = (
1648     'items.cn_sort' => {
1649         'itemcallnumber' => 1,
1650         'items.cn_source' => 1,
1651         'BUILDER' => \&_calc_items_cn_sort,
1652     }
1653 );
1654
1655 =head2 _set_derived_columns_for_add
1656
1657 =over 4
1658
1659 _set_derived_column_for_add($item);
1660
1661 =back
1662
1663 Given an item hash representing a new item to be added,
1664 calculate any derived columns.  Currently the only
1665 such column is C<items.cn_sort>.
1666
1667 =cut
1668
1669 sub _set_derived_columns_for_add {
1670     my $item = shift;
1671
1672     foreach my $column (keys %derived_columns) {
1673         my $builder = $derived_columns{$column}->{'BUILDER'};
1674         my $source_values = {};
1675         foreach my $source_column (keys %{ $derived_columns{$column} }) {
1676             next if $source_column eq 'BUILDER';
1677             $source_values->{$source_column} = $item->{$source_column};
1678         }
1679         $builder->($item, $source_values);
1680     }
1681 }
1682
1683 =head2 _set_derived_columns_for_mod
1684
1685 =over 4
1686
1687 _set_derived_column_for_mod($item);
1688
1689 =back
1690
1691 Given an item hash representing a new item to be modified.
1692 calculate any derived columns.  Currently the only
1693 such column is C<items.cn_sort>.
1694
1695 This routine differs from C<_set_derived_columns_for_add>
1696 in that it needs to handle partial item records.  In other
1697 words, the caller of C<ModItem> may have supplied only one
1698 or two columns to be changed, so this function needs to
1699 determine whether any of the columns to be changed affect
1700 any of the derived columns.  Also, if a derived column
1701 depends on more than one column, but the caller is not
1702 changing all of then, this routine retrieves the unchanged
1703 values from the database in order to ensure a correct
1704 calculation.
1705
1706 =cut
1707
1708 sub _set_derived_columns_for_mod {
1709     my $item = shift;
1710
1711     foreach my $column (keys %derived_columns) {
1712         my $builder = $derived_columns{$column}->{'BUILDER'};
1713         my $source_values = {};
1714         my %missing_sources = ();
1715         my $must_recalc = 0;
1716         foreach my $source_column (keys %{ $derived_columns{$column} }) {
1717             next if $source_column eq 'BUILDER';
1718             if (exists $item->{$source_column}) {
1719                 $must_recalc = 1;
1720                 $source_values->{$source_column} = $item->{$source_column};
1721             } else {
1722                 $missing_sources{$source_column} = 1;
1723             }
1724         }
1725         if ($must_recalc) {
1726             foreach my $source_column (keys %missing_sources) {
1727                 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
1728             }
1729             $builder->($item, $source_values);
1730         }
1731     }
1732 }
1733
1734 =head2 _do_column_fixes_for_mod
1735
1736 =over 4
1737
1738 _do_column_fixes_for_mod($item);
1739
1740 =back
1741
1742 Given an item hashref containing one or more
1743 columns to modify, fix up certain values.
1744 Specifically, set to 0 any passed value
1745 of C<notforloan>, C<damaged>, C<itemlost>, or
1746 C<wthdrawn> that is either undefined or
1747 contains the empty string.
1748
1749 =cut
1750
1751 sub _do_column_fixes_for_mod {
1752     my $item = shift;
1753
1754     if (exists $item->{'notforloan'} and
1755         (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
1756         $item->{'notforloan'} = 0;
1757     }
1758     if (exists $item->{'damaged'} and
1759         (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
1760         $item->{'damaged'} = 0;
1761     }
1762     if (exists $item->{'itemlost'} and
1763         (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
1764         $item->{'itemlost'} = 0;
1765     }
1766     if (exists $item->{'wthdrawn'} and
1767         (not defined $item->{'wthdrawn'} or $item->{'wthdrawn'} eq '')) {
1768         $item->{'wthdrawn'} = 0;
1769     }
1770 }
1771
1772 =head2 _get_single_item_column
1773
1774 =over 4
1775
1776 _get_single_item_column($column, $itemnumber);
1777
1778 =back
1779
1780 Retrieves the value of a single column from an C<items>
1781 row specified by C<$itemnumber>.
1782
1783 =cut
1784
1785 sub _get_single_item_column {
1786     my $column = shift;
1787     my $itemnumber = shift;
1788
1789     my $dbh = C4::Context->dbh;
1790     my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
1791     $sth->execute($itemnumber);
1792     my ($value) = $sth->fetchrow();
1793     return $value;
1794 }
1795
1796 =head2 _calc_items_cn_sort
1797
1798 =over 4
1799
1800 _calc_items_cn_sort($item, $source_values);
1801
1802 =back
1803
1804 Helper routine to calculate C<items.cn_sort>.
1805
1806 =cut
1807
1808 sub _calc_items_cn_sort {
1809     my $item = shift;
1810     my $source_values = shift;
1811
1812     $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
1813 }
1814
1815 =head2 _set_defaults_for_add
1816
1817 =over 4
1818
1819 _set_defaults_for_add($item_hash);
1820
1821 =back
1822
1823 Given an item hash representing an item to be added, set
1824 correct default values for columns whose default value
1825 is not handled by the DBMS.  This includes the following
1826 columns:
1827
1828 =over 2
1829
1830 =item *
1831
1832 C<items.dateaccessioned>
1833
1834 =item *
1835
1836 C<items.notforloan>
1837
1838 =item *
1839
1840 C<items.damaged>
1841
1842 =item *
1843
1844 C<items.itemlost>
1845
1846 =item *
1847
1848 C<items.wthdrawn>
1849
1850 =back
1851
1852 =cut
1853
1854 sub _set_defaults_for_add {
1855     my $item = shift;
1856     $item->{dateaccessioned} ||= C4::Dates->new->output('iso');
1857     $item->{$_} ||= 0 for (qw( notforloan damaged itemlost wthdrawn));
1858 }
1859
1860 =head2 _koha_new_item
1861
1862 =over 4
1863
1864 my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
1865
1866 =back
1867
1868 Perform the actual insert into the C<items> table.
1869
1870 =cut
1871
1872 sub _koha_new_item {
1873     my ( $item, $barcode ) = @_;
1874     my $dbh=C4::Context->dbh;
1875     my $error;
1876     my $query =
1877            "INSERT INTO items SET
1878             biblionumber        = ?,
1879             biblioitemnumber    = ?,
1880             barcode             = ?,
1881             dateaccessioned     = ?,
1882             booksellerid        = ?,
1883             homebranch          = ?,
1884             price               = ?,
1885             replacementprice    = ?,
1886             replacementpricedate = NOW(),
1887             datelastborrowed    = ?,
1888             datelastseen        = NOW(),
1889             stack               = ?,
1890             notforloan          = ?,
1891             damaged             = ?,
1892             itemlost            = ?,
1893             wthdrawn            = ?,
1894             itemcallnumber      = ?,
1895             restricted          = ?,
1896             itemnotes           = ?,
1897             holdingbranch       = ?,
1898             paidfor             = ?,
1899             location            = ?,
1900             onloan              = ?,
1901             issues              = ?,
1902             renewals            = ?,
1903             reserves            = ?,
1904             cn_source           = ?,
1905             cn_sort             = ?,
1906             ccode               = ?,
1907             itype               = ?,
1908             materials           = ?,
1909             uri = ?,
1910             enumchron           = ?,
1911             more_subfields_xml  = ?,
1912             copynumber          = ?
1913           ";
1914     my $sth = $dbh->prepare($query);
1915    $sth->execute(
1916             $item->{'biblionumber'},
1917             $item->{'biblioitemnumber'},
1918             $barcode,
1919             $item->{'dateaccessioned'},
1920             $item->{'booksellerid'},
1921             $item->{'homebranch'},
1922             $item->{'price'},
1923             $item->{'replacementprice'},
1924             $item->{datelastborrowed},
1925             $item->{stack},
1926             $item->{'notforloan'},
1927             $item->{'damaged'},
1928             $item->{'itemlost'},
1929             $item->{'wthdrawn'},
1930             $item->{'itemcallnumber'},
1931             $item->{'restricted'},
1932             $item->{'itemnotes'},
1933             $item->{'holdingbranch'},
1934             $item->{'paidfor'},
1935             $item->{'location'},
1936             $item->{'onloan'},
1937             $item->{'issues'},
1938             $item->{'renewals'},
1939             $item->{'reserves'},
1940             $item->{'items.cn_source'},
1941             $item->{'items.cn_sort'},
1942             $item->{'ccode'},
1943             $item->{'itype'},
1944             $item->{'materials'},
1945             $item->{'uri'},
1946             $item->{'enumchron'},
1947             $item->{'more_subfields_xml'},
1948             $item->{'copynumber'},
1949     );
1950     my $itemnumber = $dbh->{'mysql_insertid'};
1951     if ( defined $sth->errstr ) {
1952         $error.="ERROR in _koha_new_item $query".$sth->errstr;
1953     }
1954     $sth->finish();
1955     return ( $itemnumber, $error );
1956 }
1957
1958 =head2 _koha_modify_item
1959
1960 =over 4
1961
1962 my ($itemnumber,$error) =_koha_modify_item( $item );
1963
1964 =back
1965
1966 Perform the actual update of the C<items> row.  Note that this
1967 routine accepts a hashref specifying the columns to update.
1968
1969 =cut
1970
1971 sub _koha_modify_item {
1972     my ( $item ) = @_;
1973     my $dbh=C4::Context->dbh;
1974     my $error;
1975
1976     my $query = "UPDATE items SET ";
1977     my @bind;
1978     for my $key ( keys %$item ) {
1979         $query.="$key=?,";
1980         push @bind, $item->{$key};
1981     }
1982     $query =~ s/,$//;
1983     $query .= " WHERE itemnumber=?";
1984     push @bind, $item->{'itemnumber'};
1985     my $sth = C4::Context->dbh->prepare($query);
1986     $sth->execute(@bind);
1987     if ( C4::Context->dbh->errstr ) {
1988         $error.="ERROR in _koha_modify_item $query".$dbh->errstr;
1989         warn $error;
1990     }
1991     $sth->finish();
1992     return ($item->{'itemnumber'},$error);
1993 }
1994
1995 =head2 _koha_delete_item
1996
1997 =over 4
1998
1999 _koha_delete_item( $dbh, $itemnum );
2000
2001 =back
2002
2003 Internal function to delete an item record from the koha tables
2004
2005 =cut
2006
2007 sub _koha_delete_item {
2008     my ( $dbh, $itemnum ) = @_;
2009
2010     # save the deleted item to deleteditems table
2011     my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
2012     $sth->execute($itemnum);
2013     my $data = $sth->fetchrow_hashref();
2014     $sth->finish();
2015     my $query = "INSERT INTO deleteditems SET ";
2016     my @bind  = ();
2017     foreach my $key ( keys %$data ) {
2018         $query .= "$key = ?,";
2019         push( @bind, $data->{$key} );
2020     }
2021     $query =~ s/\,$//;
2022     $sth = $dbh->prepare($query);
2023     $sth->execute(@bind);
2024     $sth->finish();
2025
2026     # delete from items table
2027     $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
2028     $sth->execute($itemnum);
2029     $sth->finish();
2030     return undef;
2031 }
2032
2033 =head2 _marc_from_item_hash
2034
2035 =over 4
2036
2037 my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
2038
2039 =back
2040
2041 Given an item hash representing a complete item record,
2042 create a C<MARC::Record> object containing an embedded
2043 tag representing that item.
2044
2045 The third, optional parameter C<$unlinked_item_subfields> is
2046 an arrayref of subfields (not mapped to C<items> fields per the
2047 framework) to be added to the MARC representation
2048 of the item.
2049
2050 =cut
2051
2052 sub _marc_from_item_hash {
2053     my $item = shift;
2054     my $frameworkcode = shift;
2055     my $unlinked_item_subfields;
2056     if (@_) {
2057         $unlinked_item_subfields = shift;
2058     }
2059
2060     # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
2061     # Also, don't emit a subfield if the underlying field is blank.
2062     my $mungeditem = { map {  (defined($item->{$_}) and $item->{$_} ne '') ?
2063                                 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
2064                                 : ()  } keys %{ $item } };
2065
2066     my $item_marc = MARC::Record->new();
2067     foreach my $item_field (keys %{ $mungeditem }) {
2068         my ($tag, $subfield) = GetMarcFromKohaField($item_field, $frameworkcode);
2069         next unless defined $tag and defined $subfield; # skip if not mapped to MARC field
2070         if (my $field = $item_marc->field($tag)) {
2071             $field->add_subfields($subfield => $mungeditem->{$item_field});
2072         } else {
2073             my $add_subfields = [];
2074             if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2075                 $add_subfields = $unlinked_item_subfields;
2076             }
2077             $item_marc->add_fields( $tag, " ", " ", $subfield =>  $mungeditem->{$item_field}, @$add_subfields);
2078         }
2079     }
2080
2081     return $item_marc;
2082 }
2083
2084 =head2 _add_item_field_to_biblio
2085
2086 =over 4
2087
2088 _add_item_field_to_biblio($item_marc, $biblionumber, $frameworkcode);
2089
2090 =back
2091
2092 Adds the fields from a MARC record containing the
2093 representation of a Koha item record to the MARC
2094 biblio record.  The input C<$item_marc> record
2095 is expect to contain just one field, the embedded
2096 item information field.
2097
2098 =cut
2099
2100 sub _add_item_field_to_biblio {
2101     my ($item_marc, $biblionumber, $frameworkcode) = @_;
2102
2103     my $biblio_marc = GetMarcBiblio($biblionumber);
2104     foreach my $field ($item_marc->fields()) {
2105         $biblio_marc->append_fields($field);
2106     }
2107
2108     ModBiblioMarc($biblio_marc, $biblionumber, $frameworkcode);
2109 }
2110
2111 =head2 _replace_item_field_in_biblio
2112
2113 =over
2114
2115 &_replace_item_field_in_biblio($item_marc, $biblionumber, $itemnumber, $frameworkcode)
2116
2117 =back
2118
2119 Given a MARC::Record C<$item_marc> containing one tag with the MARC
2120 representation of the item, examine the biblio MARC
2121 for the corresponding tag for that item and
2122 replace it with the tag from C<$item_marc>.
2123
2124 =cut
2125
2126 sub _replace_item_field_in_biblio {
2127     my ($ItemRecord, $biblionumber, $itemnumber, $frameworkcode) = @_;
2128     my $dbh = C4::Context->dbh;
2129
2130     # get complete MARC record & replace the item field by the new one
2131     my $completeRecord = GetMarcBiblio($biblionumber);
2132     my ($itemtag,$itemsubfield) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
2133     my $itemField = $ItemRecord->field($itemtag);
2134     my @items = $completeRecord->field($itemtag);
2135     my $found = 0;
2136     foreach (@items) {
2137         if ($_->subfield($itemsubfield) eq $itemnumber) {
2138             $_->replace_with($itemField);
2139             $found = 1;
2140         }
2141     }
2142
2143     unless ($found) {
2144         # If we haven't found the matching field,
2145         # just add it.  However, this means that
2146         # there is likely a bug.
2147         $completeRecord->append_fields($itemField);
2148     }
2149
2150     # save the record
2151     ModBiblioMarc($completeRecord, $biblionumber, $frameworkcode);
2152 }
2153
2154 =head2 _repack_item_errors
2155
2156 Add an error message hash generated by C<CheckItemPreSave>
2157 to a list of errors.
2158
2159 =cut
2160
2161 sub _repack_item_errors {
2162     my $item_sequence_num = shift;
2163     my $item_ref = shift;
2164     my $error_ref = shift;
2165
2166     my @repacked_errors = ();
2167
2168     foreach my $error_code (sort keys %{ $error_ref }) {
2169         my $repacked_error = {};
2170         $repacked_error->{'item_sequence'} = $item_sequence_num;
2171         $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
2172         $repacked_error->{'error_code'} = $error_code;
2173         $repacked_error->{'error_information'} = $error_ref->{$error_code};
2174         push @repacked_errors, $repacked_error;
2175     }
2176
2177     return @repacked_errors;
2178 }
2179
2180 =head2 _get_unlinked_item_subfields
2181
2182 =over 4
2183
2184 my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
2185
2186 =back
2187
2188 =cut
2189
2190 sub _get_unlinked_item_subfields {
2191     my $original_item_marc = shift;
2192     my $frameworkcode = shift;
2193
2194     my $marcstructure = GetMarcStructure(1, $frameworkcode);
2195
2196     # assume that this record has only one field, and that that
2197     # field contains only the item information
2198     my $subfields = [];
2199     my @fields = $original_item_marc->fields();
2200     if ($#fields > -1) {
2201         my $field = $fields[0];
2202             my $tag = $field->tag();
2203         foreach my $subfield ($field->subfields()) {
2204             if (defined $subfield->[1] and
2205                 $subfield->[1] ne '' and
2206                 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
2207                 push @$subfields, $subfield->[0] => $subfield->[1];
2208             }
2209         }
2210     }
2211     return $subfields;
2212 }
2213
2214 =head2 _get_unlinked_subfields_xml
2215
2216 =over 4
2217
2218 my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
2219
2220 =back
2221
2222 =cut
2223
2224 sub _get_unlinked_subfields_xml {
2225     my $unlinked_item_subfields = shift;
2226
2227     my $xml;
2228     if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2229         my $marc = MARC::Record->new();
2230         # use of tag 999 is arbitrary, and doesn't need to match the item tag
2231         # used in the framework
2232         $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
2233         $marc->encoding("UTF-8");
2234         $xml = $marc->as_xml("USMARC");
2235     }
2236
2237     return $xml;
2238 }
2239
2240 =head2 _parse_unlinked_item_subfields_from_xml
2241
2242 =over 4
2243
2244 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2245
2246 =back
2247
2248 =cut
2249
2250 sub  _parse_unlinked_item_subfields_from_xml {
2251     my $xml = shift;
2252
2253     return unless defined $xml and $xml ne "";
2254     my $marc = MARC::Record->new_from_xml(StripNonXmlChars($xml),'UTF-8');
2255     my $unlinked_subfields = [];
2256     my @fields = $marc->fields();
2257     if ($#fields > -1) {
2258         foreach my $subfield ($fields[0]->subfields()) {
2259             push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2260         }
2261     }
2262     return $unlinked_subfields;
2263 }
2264
2265 1;