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