C4/Items.pm

   1 package C4::Items;
   2
   3 # Copyright 2007 LibLime, Inc.
   4 # Parts Copyright Biblibre 2010
   5 #
   6 # This file is part of Koha.
   7 #
   8 # Koha is free software; you can redistribute it and/or modify it under the
   9 # terms of the GNU General Public License as published by the Free Software
  10 # Foundation; either version 2 of the License, or (at your option) any later
  11 # version.
  12 #
  13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  15 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License along
  18 # with Koha; if not, write to the Free Software Foundation, Inc.,
  19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20
  21 use strict;
  22 #use warnings; FIXME - Bug 2505
  23
  24 use Carp;
  25 use C4::Context;
  26 use C4::Koha;
  27 use C4::Biblio;
  28 use C4::Dates qw/format_date format_date_in_iso/;
  29 use MARC::Record;
  30 use C4::ClassSource;
  31 use C4::Log;
  32 use List::MoreUtils qw/any/;
  33 use YAML qw/Load/;
  34 use DateTime::Format::MySQL;
  35 use Data::Dumper; # used as part of logging item record changes, not just for
  36                   # debugging; so please don't remove this
  37 use Koha::DateUtils qw/dt_from_string/;
  38
  39 use vars qw($VERSION @ISA @EXPORT);
  40
  41 BEGIN {
  42     $VERSION = 3.07.00.049;
  43
  44         require Exporter;
  45     @ISA = qw( Exporter );
  46
  47     # function exports
  48     @EXPORT = qw(
  49         GetItem
  50         AddItemFromMarc
  51         AddItem
  52         AddItemBatchFromMarc
  53         ModItemFromMarc
  54     Item2Marc
  55         ModItem
  56         ModDateLastSeen
  57         ModItemTransfer
  58         DelItem
  59
  60         CheckItemPreSave
  61
  62         GetItemStatus
  63         GetItemLocation
  64         GetLostItems
  65         GetItemsForInventory
  66         GetItemsCount
  67         GetItemInfosOf
  68         GetItemsByBiblioitemnumber
  69         GetItemsInfo
  70         GetItemsLocationInfo
  71         GetHostItemsInfo
  72         GetItemnumbersForBiblio
  73         get_itemnumbers_of
  74         get_hostitemnumbers_of
  75         GetItemnumberFromBarcode
  76         GetBarcodeFromItemnumber
  77         GetHiddenItemnumbers
  78         DelItemCheck
  79     MoveItemFromBiblio
  80     GetLatestAcquisitions
  81
  82         CartToShelf
  83         ShelfToCart
  84
  85         GetAnalyticsCount
  86         GetItemHolds
  87
  88         SearchItems
  89
  90         PrepareItemrecordDisplay
  91
  92     );
  93 }
  94
  95 =head1 NAME
  96
  97 C4::Items - item management functions
  98
  99 =head1 DESCRIPTION
 100
 101 This module contains an API for manipulating item
 102 records in Koha, and is used by cataloguing, circulation,
 103 acquisitions, and serials management.
 104
 105 A Koha item record is stored in two places: the
 106 items table and embedded in a MARC tag in the XML
 107 version of the associated bib record in C<biblioitems.marcxml>.
 108 This is done to allow the item information to be readily
 109 indexed (e.g., by Zebra), but means that each item
 110 modification transaction must keep the items table
 111 and the MARC XML in sync at all times.
 112
 113 Consequently, all code that creates, modifies, or deletes
 114 item records B<must> use an appropriate function from
 115 C<C4::Items>.  If no existing function is suitable, it is
 116 better to add one to C<C4::Items> than to use add
 117 one-off SQL statements to add or modify items.
 118
 119 The items table will be considered authoritative.  In other
 120 words, if there is ever a discrepancy between the items
 121 table and the MARC XML, the items table should be considered
 122 accurate.
 123
 124 =head1 HISTORICAL NOTE
 125
 126 Most of the functions in C<C4::Items> were originally in
 127 the C<C4::Biblio> module.
 128
 129 =head1 CORE EXPORTED FUNCTIONS
 130
 131 The following functions are meant for use by users
 132 of C<C4::Items>
 133
 134 =cut
 135
 136 =head2 GetItem
 137
 138   $item = GetItem($itemnumber,$barcode,$serial);
 139
 140 Return item information, for a given itemnumber or barcode.
 141 The return value is a hashref mapping item column
 142 names to values.  If C<$serial> is true, include serial publication data.
 143
 144 =cut
 145
 146 sub GetItem {
 147     my ($itemnumber,$barcode, $serial) = @_;
 148     my $dbh = C4::Context->dbh;
 149         my $data;
 150
 151     if ($itemnumber) {
 152         my $sth = $dbh->prepare("
 153             SELECT * FROM items
 154             WHERE itemnumber = ?");
 155         $sth->execute($itemnumber);
 156         $data = $sth->fetchrow_hashref;
 157     } else {
 158         my $sth = $dbh->prepare("
 159             SELECT * FROM items
 160             WHERE barcode = ?"
 161             );
 162         $sth->execute($barcode);
 163         $data = $sth->fetchrow_hashref;
 164     }
 165
 166     return unless ( $data );
 167
 168     if ( $serial) {
 169     my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=?");
 170         $ssth->execute($data->{'itemnumber'}) ;
 171         ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
 172     }
 173         #if we don't have an items.itype, use biblioitems.itemtype.
 174         if( ! $data->{'itype'} ) {
 175                 my $sth = $dbh->prepare("SELECT itemtype FROM biblioitems  WHERE biblionumber = ?");
 176                 $sth->execute($data->{'biblionumber'});
 177                 ($data->{'itype'}) = $sth->fetchrow_array;
 178         }
 179     return $data;
 180 }    # sub GetItem
 181
 182 =head2 CartToShelf
 183
 184   CartToShelf($itemnumber);
 185
 186 Set the current shelving location of the item record
 187 to its stored permanent shelving location.  This is
 188 primarily used to indicate when an item whose current
 189 location is a special processing ('PROC') or shelving cart
 190 ('CART') location is back in the stacks.
 191
 192 =cut
 193
 194 sub CartToShelf {
 195     my ( $itemnumber ) = @_;
 196
 197     unless ( $itemnumber ) {
 198         croak "FAILED CartToShelf() - no itemnumber supplied";
 199     }
 200
 201     my $item = GetItem($itemnumber);
 202     if ( $item->{location} eq 'CART' ) {
 203         $item->{location} = $item->{permanent_location};
 204         ModItem($item, undef, $itemnumber);
 205     }
 206 }
 207
 208 =head2 ShelfToCart
 209
 210   ShelfToCart($itemnumber);
 211
 212 Set the current shelving location of the item
 213 to shelving cart ('CART').
 214
 215 =cut
 216
 217 sub ShelfToCart {
 218     my ( $itemnumber ) = @_;
 219
 220     unless ( $itemnumber ) {
 221         croak "FAILED ShelfToCart() - no itemnumber supplied";
 222     }
 223
 224     my $item = GetItem($itemnumber);
 225     $item->{'location'} = 'CART';
 226     ModItem($item, undef, $itemnumber);
 227 }
 228
 229 =head2 AddItemFromMarc
 230
 231   my ($biblionumber, $biblioitemnumber, $itemnumber)
 232       = AddItemFromMarc($source_item_marc, $biblionumber);
 233
 234 Given a MARC::Record object containing an embedded item
 235 record and a biblionumber, create a new item record.
 236
 237 =cut
 238
 239 sub AddItemFromMarc {
 240     my ( $source_item_marc, $biblionumber ) = @_;
 241     my $dbh = C4::Context->dbh;
 242
 243     # parse item hash from MARC
 244     my $frameworkcode = GetFrameworkCode( $biblionumber );
 245         my ($itemtag,$itemsubfield)=GetMarcFromKohaField("items.itemnumber",$frameworkcode);
 246
 247         my $localitemmarc=MARC::Record->new;
 248         $localitemmarc->append_fields($source_item_marc->field($itemtag));
 249     my $item = &TransformMarcToKoha( $dbh, $localitemmarc, $frameworkcode ,'items');
 250     my $unlinked_item_subfields = _get_unlinked_item_subfields($localitemmarc, $frameworkcode);
 251     return AddItem($item, $biblionumber, $dbh, $frameworkcode, $unlinked_item_subfields);
 252 }
 253
 254 =head2 AddItem
 255
 256   my ($biblionumber, $biblioitemnumber, $itemnumber)
 257       = AddItem($item, $biblionumber[, $dbh, $frameworkcode, $unlinked_item_subfields]);
 258
 259 Given a hash containing item column names as keys,
 260 create a new Koha item record.
 261
 262 The first two optional parameters (C<$dbh> and C<$frameworkcode>)
 263 do not need to be supplied for general use; they exist
 264 simply to allow them to be picked up from AddItemFromMarc.
 265
 266 The final optional parameter, C<$unlinked_item_subfields>, contains
 267 an arrayref containing subfields present in the original MARC
 268 representation of the item (e.g., from the item editor) that are
 269 not mapped to C<items> columns directly but should instead
 270 be stored in C<items.more_subfields_xml> and included in
 271 the biblio items tag for display and indexing.
 272
 273 =cut
 274
 275 sub AddItem {
 276     my $item = shift;
 277     my $biblionumber = shift;
 278
 279     my $dbh           = @_ ? shift : C4::Context->dbh;
 280     my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
 281     my $unlinked_item_subfields;
 282     if (@_) {
 283         $unlinked_item_subfields = shift
 284     };
 285
 286     # needs old biblionumber and biblioitemnumber
 287     $item->{'biblionumber'} = $biblionumber;
 288     my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
 289     $sth->execute( $item->{'biblionumber'} );
 290     ($item->{'biblioitemnumber'}) = $sth->fetchrow;
 291
 292     _set_defaults_for_add($item);
 293     _set_derived_columns_for_add($item);
 294     $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
 295     # FIXME - checks here
 296     unless ( $item->{itype} ) {  # default to biblioitem.itemtype if no itype
 297         my $itype_sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
 298         $itype_sth->execute( $item->{'biblionumber'} );
 299         ( $item->{'itype'} ) = $itype_sth->fetchrow_array;
 300     }
 301
 302         my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
 303     $item->{'itemnumber'} = $itemnumber;
 304
 305     ModZebra( $item->{biblionumber}, "specialUpdate", "biblioserver" );
 306
 307     logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
 308
 309     return ($item->{biblionumber}, $item->{biblioitemnumber}, $itemnumber);
 310 }
 311
 312 =head2 AddItemBatchFromMarc
 313
 314   ($itemnumber_ref, $error_ref) = AddItemBatchFromMarc($record,
 315              $biblionumber, $biblioitemnumber, $frameworkcode);
 316
 317 Efficiently create item records from a MARC biblio record with
 318 embedded item fields.  This routine is suitable for batch jobs.
 319
 320 This API assumes that the bib record has already been
 321 saved to the C<biblio> and C<biblioitems> tables.  It does
 322 not expect that C<biblioitems.marc> and C<biblioitems.marcxml>
 323 are populated, but it will do so via a call to ModBibiloMarc.
 324
 325 The goal of this API is to have a similar effect to using AddBiblio
 326 and AddItems in succession, but without inefficient repeated
 327 parsing of the MARC XML bib record.
 328
 329 This function returns an arrayref of new itemsnumbers and an arrayref of item
 330 errors encountered during the processing.  Each entry in the errors
 331 list is a hashref containing the following keys:
 332
 333 =over
 334
 335 =item item_sequence
 336
 337 Sequence number of original item tag in the MARC record.
 338
 339 =item item_barcode
 340
 341 Item barcode, provide to assist in the construction of
 342 useful error messages.
 343
 344 =item error_code
 345
 346 Code representing the error condition.  Can be 'duplicate_barcode',
 347 'invalid_homebranch', or 'invalid_holdingbranch'.
 348
 349 =item error_information
 350
 351 Additional information appropriate to the error condition.
 352
 353 =back
 354
 355 =cut
 356
 357 sub AddItemBatchFromMarc {
 358     my ($record, $biblionumber, $biblioitemnumber, $frameworkcode) = @_;
 359     my $error;
 360     my @itemnumbers = ();
 361     my @errors = ();
 362     my $dbh = C4::Context->dbh;
 363
 364     # We modify the record, so lets work on a clone so we don't change the
 365     # original.
 366     $record = $record->clone();
 367     # loop through the item tags and start creating items
 368     my @bad_item_fields = ();
 369     my ($itemtag, $itemsubfield) = &GetMarcFromKohaField("items.itemnumber",'');
 370     my $item_sequence_num = 0;
 371     ITEMFIELD: foreach my $item_field ($record->field($itemtag)) {
 372         $item_sequence_num++;
 373         # we take the item field and stick it into a new
 374         # MARC record -- this is required so far because (FIXME)
 375         # TransformMarcToKoha requires a MARC::Record, not a MARC::Field
 376         # and there is no TransformMarcFieldToKoha
 377         my $temp_item_marc = MARC::Record->new();
 378         $temp_item_marc->append_fields($item_field);
 379
 380         # add biblionumber and biblioitemnumber
 381         my $item = TransformMarcToKoha( $dbh, $temp_item_marc, $frameworkcode, 'items' );
 382         my $unlinked_item_subfields = _get_unlinked_item_subfields($temp_item_marc, $frameworkcode);
 383         $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
 384         $item->{'biblionumber'} = $biblionumber;
 385         $item->{'biblioitemnumber'} = $biblioitemnumber;
 386
 387         # check for duplicate barcode
 388         my %item_errors = CheckItemPreSave($item);
 389         if (%item_errors) {
 390             push @errors, _repack_item_errors($item_sequence_num, $item, \%item_errors);
 391             push @bad_item_fields, $item_field;
 392             next ITEMFIELD;
 393         }
 394
 395         _set_defaults_for_add($item);
 396         _set_derived_columns_for_add($item);
 397         my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
 398         warn $error if $error;
 399         push @itemnumbers, $itemnumber; # FIXME not checking error
 400         $item->{'itemnumber'} = $itemnumber;
 401
 402         logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
 403
 404         my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
 405         $item_field->replace_with($new_item_marc->field($itemtag));
 406     }
 407
 408     # remove any MARC item fields for rejected items
 409     foreach my $item_field (@bad_item_fields) {
 410         $record->delete_field($item_field);
 411     }
 412
 413     # update the MARC biblio
 414  #   $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode );
 415
 416     return (\@itemnumbers, \@errors);
 417 }
 418
 419 =head2 ModItemFromMarc
 420
 421   ModItemFromMarc($item_marc, $biblionumber, $itemnumber);
 422
 423 This function updates an item record based on a supplied
 424 C<MARC::Record> object containing an embedded item field.
 425 This API is meant for the use of C<additem.pl>; for
 426 other purposes, C<ModItem> should be used.
 427
 428 This function uses the hash %default_values_for_mod_from_marc,
 429 which contains default values for item fields to
 430 apply when modifying an item.  This is needed beccause
 431 if an item field's value is cleared, TransformMarcToKoha
 432 does not include the column in the
 433 hash that's passed to ModItem, which without
 434 use of this hash makes it impossible to clear
 435 an item field's value.  See bug 2466.
 436
 437 Note that only columns that can be directly
 438 changed from the cataloging and serials
 439 item editors are included in this hash.
 440
 441 Returns item record
 442
 443 =cut
 444
 445 my %default_values_for_mod_from_marc = (
 446     barcode              => undef,
 447     booksellerid         => undef,
 448     ccode                => undef,
 449     'items.cn_source'    => undef,
 450     coded_location_qualifier => undef,
 451     copynumber           => undef,
 452     damaged              => 0,
 453 #    dateaccessioned      => undef,
 454     enumchron            => undef,
 455     holdingbranch        => undef,
 456     homebranch           => undef,
 457     itemcallnumber       => undef,
 458     itemlost             => 0,
 459     itemnotes            => undef,
 460     itype                => undef,
 461     location             => undef,
 462     permanent_location   => undef,
 463     materials            => undef,
 464     notforloan           => 0,
 465     paidfor              => undef,
 466     price                => undef,
 467     replacementprice     => undef,
 468     replacementpricedate => undef,
 469     restricted           => undef,
 470     stack                => undef,
 471     stocknumber          => undef,
 472     uri                  => undef,
 473     withdrawn             => 0,
 474 );
 475
 476 sub ModItemFromMarc {
 477     my $item_marc = shift;
 478     my $biblionumber = shift;
 479     my $itemnumber = shift;
 480
 481     my $dbh           = C4::Context->dbh;
 482     my $frameworkcode = GetFrameworkCode($biblionumber);
 483     my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
 484
 485     my $localitemmarc = MARC::Record->new;
 486     $localitemmarc->append_fields( $item_marc->field($itemtag) );
 487     my $item = &TransformMarcToKoha( $dbh, $localitemmarc, $frameworkcode, 'items' );
 488     foreach my $item_field ( keys %default_values_for_mod_from_marc ) {
 489         $item->{$item_field} = $default_values_for_mod_from_marc{$item_field} unless (exists $item->{$item_field});
 490     }
 491     my $unlinked_item_subfields = _get_unlinked_item_subfields( $localitemmarc, $frameworkcode );
 492
 493     ModItem($item, $biblionumber, $itemnumber, $dbh, $frameworkcode, $unlinked_item_subfields);
 494     return $item;
 495 }
 496
 497 =head2 ModItem
 498
 499   ModItem({ column => $newvalue }, $biblionumber, $itemnumber);
 500
 501 Change one or more columns in an item record and update
 502 the MARC representation of the item.
 503
 504 The first argument is a hashref mapping from item column
 505 names to the new values.  The second and third arguments
 506 are the biblionumber and itemnumber, respectively.
 507
 508 The fourth, optional parameter, C<$unlinked_item_subfields>, contains
 509 an arrayref containing subfields present in the original MARC
 510 representation of the item (e.g., from the item editor) that are
 511 not mapped to C<items> columns directly but should instead
 512 be stored in C<items.more_subfields_xml> and included in
 513 the biblio items tag for display and indexing.
 514
 515 If one of the changed columns is used to calculate
 516 the derived value of a column such as C<items.cn_sort>,
 517 this routine will perform the necessary calculation
 518 and set the value.
 519
 520 =cut
 521
 522 sub ModItem {
 523     my $item = shift;
 524     my $biblionumber = shift;
 525     my $itemnumber = shift;
 526
 527     # if $biblionumber is undefined, get it from the current item
 528     unless (defined $biblionumber) {
 529         $biblionumber = _get_single_item_column('biblionumber', $itemnumber);
 530     }
 531
 532     my $dbh           = @_ ? shift : C4::Context->dbh;
 533     my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
 534
 535     my $unlinked_item_subfields;
 536     if (@_) {
 537         $unlinked_item_subfields = shift;
 538         $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
 539     };
 540
 541     $item->{'itemnumber'} = $itemnumber or return;
 542
 543     $item->{onloan} = undef if $item->{itemlost};
 544
 545     my @fields = qw( itemlost withdrawn );
 546
 547     # Only call GetItem if we need to set an "on" date field
 548     if ( $item->{itemlost} || $item->{withdrawn} ) {
 549         my $pre_mod_item = GetItem( $item->{'itemnumber'} );
 550         for my $field (@fields) {
 551             if (    defined( $item->{$field} )
 552                 and not $pre_mod_item->{$field}
 553                 and $item->{$field} )
 554             {
 555                 $item->{ $field . '_on' } =
 556                   DateTime::Format::MySQL->format_datetime( dt_from_string() );
 557             }
 558         }
 559     }
 560
 561     # If the field is defined but empty, we are removing and,
 562     # and thus need to clear out the 'on' field as well
 563     for my $field (@fields) {
 564         if ( defined( $item->{$field} ) && !$item->{$field} ) {
 565             $item->{ $field . '_on' } = undef;
 566         }
 567     }
 568
 569
 570     _set_derived_columns_for_mod($item);
 571     _do_column_fixes_for_mod($item);
 572     # FIXME add checks
 573     # duplicate barcode
 574     # attempt to change itemnumber
 575     # attempt to change biblionumber (if we want
 576     # an API to relink an item to a different bib,
 577     # it should be a separate function)
 578
 579     # update items table
 580     _koha_modify_item($item);
 581
 582     # request that bib be reindexed so that searching on current
 583     # item status is possible
 584     ModZebra( $biblionumber, "specialUpdate", "biblioserver" );
 585
 586     logaction("CATALOGUING", "MODIFY", $itemnumber, "item ".Dumper($item)) if C4::Context->preference("CataloguingLog");
 587 }
 588
 589 =head2 ModItemTransfer
 590
 591   ModItemTransfer($itenumber, $frombranch, $tobranch);
 592
 593 Marks an item as being transferred from one branch
 594 to another.
 595
 596 =cut
 597
 598 sub ModItemTransfer {
 599     my ( $itemnumber, $frombranch, $tobranch ) = @_;
 600
 601     my $dbh = C4::Context->dbh;
 602
 603     # Remove the 'shelving cart' location status if it is being used.
 604     CartToShelf( $itemnumber ) if ( C4::Context->preference("ReturnToShelvingCart") );
 605
 606     #new entry in branchtransfers....
 607     my $sth = $dbh->prepare(
 608         "INSERT INTO branchtransfers (itemnumber, frombranch, datesent, tobranch)
 609         VALUES (?, ?, NOW(), ?)");
 610     $sth->execute($itemnumber, $frombranch, $tobranch);
 611
 612     ModItem({ holdingbranch => $tobranch }, undef, $itemnumber);
 613     ModDateLastSeen($itemnumber);
 614     return;
 615 }
 616
 617 =head2 ModDateLastSeen
 618
 619   ModDateLastSeen($itemnum);
 620
 621 Mark item as seen. Is called when an item is issued, returned or manually marked during inventory/stocktaking.
 622 C<$itemnum> is the item number
 623
 624 =cut
 625
 626 sub ModDateLastSeen {
 627     my ($itemnumber) = @_;
 628
 629     my $today = C4::Dates->new();
 630     ModItem({ itemlost => 0, datelastseen => $today->output("iso") }, undef, $itemnumber);
 631 }
 632
 633 =head2 DelItem
 634
 635   DelItem($dbh, $biblionumber, $itemnumber);
 636
 637 Exported function (core API) for deleting an item record in Koha.
 638
 639 =cut
 640
 641 sub DelItem {
 642     my ( $dbh, $biblionumber, $itemnumber ) = @_;
 643
 644     # FIXME check the item has no current issues
 645
 646     _koha_delete_item( $dbh, $itemnumber );
 647
 648     # get the MARC record
 649     my $record = GetMarcBiblio($biblionumber);
 650     ModZebra( $biblionumber, "specialUpdate", "biblioserver" );
 651
 652     #search item field code
 653     logaction("CATALOGUING", "DELETE", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
 654 }
 655
 656 =head2 CheckItemPreSave
 657
 658     my $item_ref = TransformMarcToKoha($marc, 'items');
 659     # do stuff
 660     my %errors = CheckItemPreSave($item_ref);
 661     if (exists $errors{'duplicate_barcode'}) {
 662         print "item has duplicate barcode: ", $errors{'duplicate_barcode'}, "\n";
 663     } elsif (exists $errors{'invalid_homebranch'}) {
 664         print "item has invalid home branch: ", $errors{'invalid_homebranch'}, "\n";
 665     } elsif (exists $errors{'invalid_holdingbranch'}) {
 666         print "item has invalid holding branch: ", $errors{'invalid_holdingbranch'}, "\n";
 667     } else {
 668         print "item is OK";
 669     }
 670
 671 Given a hashref containing item fields, determine if it can be
 672 inserted or updated in the database.  Specifically, checks for
 673 database integrity issues, and returns a hash containing any
 674 of the following keys, if applicable.
 675
 676 =over 2
 677
 678 =item duplicate_barcode
 679
 680 Barcode, if it duplicates one already found in the database.
 681
 682 =item invalid_homebranch
 683
 684 Home branch, if not defined in branches table.
 685
 686 =item invalid_holdingbranch
 687
 688 Holding branch, if not defined in branches table.
 689
 690 =back
 691
 692 This function does NOT implement any policy-related checks,
 693 e.g., whether current operator is allowed to save an
 694 item that has a given branch code.
 695
 696 =cut
 697
 698 sub CheckItemPreSave {
 699     my $item_ref = shift;
 700     require C4::Branch;
 701
 702     my %errors = ();
 703
 704     # check for duplicate barcode
 705     if (exists $item_ref->{'barcode'} and defined $item_ref->{'barcode'}) {
 706         my $existing_itemnumber = GetItemnumberFromBarcode($item_ref->{'barcode'});
 707         if ($existing_itemnumber) {
 708             if (!exists $item_ref->{'itemnumber'}                       # new item
 709                 or $item_ref->{'itemnumber'} != $existing_itemnumber) { # existing item
 710                 $errors{'duplicate_barcode'} = $item_ref->{'barcode'};
 711             }
 712         }
 713     }
 714
 715     # check for valid home branch
 716     if (exists $item_ref->{'homebranch'} and defined $item_ref->{'homebranch'}) {
 717         my $branch_name = C4::Branch::GetBranchName($item_ref->{'homebranch'});
 718         unless (defined $branch_name) {
 719             # relies on fact that branches.branchname is a non-NULL column,
 720             # so GetBranchName returns undef only if branch does not exist
 721             $errors{'invalid_homebranch'} = $item_ref->{'homebranch'};
 722         }
 723     }
 724
 725     # check for valid holding branch
 726     if (exists $item_ref->{'holdingbranch'} and defined $item_ref->{'holdingbranch'}) {
 727         my $branch_name = C4::Branch::GetBranchName($item_ref->{'holdingbranch'});
 728         unless (defined $branch_name) {
 729             # relies on fact that branches.branchname is a non-NULL column,
 730             # so GetBranchName returns undef only if branch does not exist
 731             $errors{'invalid_holdingbranch'} = $item_ref->{'holdingbranch'};
 732         }
 733     }
 734
 735     return %errors;
 736
 737 }
 738
 739 =head1 EXPORTED SPECIAL ACCESSOR FUNCTIONS
 740
 741 The following functions provide various ways of
 742 getting an item record, a set of item records, or
 743 lists of authorized values for certain item fields.
 744
 745 Some of the functions in this group are candidates
 746 for refactoring -- for example, some of the code
 747 in C<GetItemsByBiblioitemnumber> and C<GetItemsInfo>
 748 has copy-and-paste work.
 749
 750 =cut
 751
 752 =head2 GetItemStatus
 753
 754   $itemstatushash = GetItemStatus($fwkcode);
 755
 756 Returns a list of valid values for the
 757 C<items.notforloan> field.
 758
 759 NOTE: does B<not> return an individual item's
 760 status.
 761
 762 Can be MARC dependant.
 763 fwkcode is optional.
 764 But basically could be can be loan or not
 765 Create a status selector with the following code
 766
 767 =head3 in PERL SCRIPT
 768
 769  my $itemstatushash = getitemstatus;
 770  my @itemstatusloop;
 771  foreach my $thisstatus (keys %$itemstatushash) {
 772      my %row =(value => $thisstatus,
 773                  statusname => $itemstatushash->{$thisstatus}->{'statusname'},
 774              );
 775      push @itemstatusloop, \%row;
 776  }
 777  $template->param(statusloop=>\@itemstatusloop);
 778
 779 =head3 in TEMPLATE
 780
 781 <select name="statusloop" id="statusloop">
 782     <option value="">Default</option>
 783     [% FOREACH statusloo IN statusloop %]
 784         [% IF ( statusloo.selected ) %]
 785             <option value="[% statusloo.value %]" selected="selected">[% statusloo.statusname %]</option>
 786         [% ELSE %]
 787             <option value="[% statusloo.value %]">[% statusloo.statusname %]</option>
 788         [% END %]
 789     [% END %]
 790 </select>
 791
 792 =cut
 793
 794 sub GetItemStatus {
 795
 796     # returns a reference to a hash of references to status...
 797     my ($fwk) = @_;
 798     my %itemstatus;
 799     my $dbh = C4::Context->dbh;
 800     my $sth;
 801     $fwk = '' unless ($fwk);
 802     my ( $tag, $subfield ) =
 803       GetMarcFromKohaField( "items.notforloan", $fwk );
 804     if ( $tag and $subfield ) {
 805         my $sth =
 806           $dbh->prepare(
 807             "SELECT authorised_value
 808             FROM marc_subfield_structure
 809             WHERE tagfield=?
 810                 AND tagsubfield=?
 811                 AND frameworkcode=?
 812             "
 813           );
 814         $sth->execute( $tag, $subfield, $fwk );
 815         if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
 816             my $authvalsth =
 817               $dbh->prepare(
 818                 "SELECT authorised_value,lib
 819                 FROM authorised_values
 820                 WHERE category=?
 821                 ORDER BY lib
 822                 "
 823               );
 824             $authvalsth->execute($authorisedvaluecat);
 825             while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
 826                 $itemstatus{$authorisedvalue} = $lib;
 827             }
 828             return \%itemstatus;
 829             exit 1;
 830         }
 831         else {
 832
 833             #No authvalue list
 834             # build default
 835         }
 836     }
 837
 838     #No authvalue list
 839     #build default
 840     $itemstatus{"1"} = "Not For Loan";
 841     return \%itemstatus;
 842 }
 843
 844 =head2 GetItemLocation
 845
 846   $itemlochash = GetItemLocation($fwk);
 847
 848 Returns a list of valid values for the
 849 C<items.location> field.
 850
 851 NOTE: does B<not> return an individual item's
 852 location.
 853
 854 where fwk stands for an optional framework code.
 855 Create a location selector with the following code
 856
 857 =head3 in PERL SCRIPT
 858
 859   my $itemlochash = getitemlocation;
 860   my @itemlocloop;
 861   foreach my $thisloc (keys %$itemlochash) {
 862       my $selected = 1 if $thisbranch eq $branch;
 863       my %row =(locval => $thisloc,
 864                   selected => $selected,
 865                   locname => $itemlochash->{$thisloc},
 866                );
 867       push @itemlocloop, \%row;
 868   }
 869   $template->param(itemlocationloop => \@itemlocloop);
 870
 871 =head3 in TEMPLATE
 872
 873   <select name="location">
 874       <option value="">Default</option>
 875   <!-- TMPL_LOOP name="itemlocationloop" -->
 876       <option value="<!-- TMPL_VAR name="locval" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="locname" --></option>
 877   <!-- /TMPL_LOOP -->
 878   </select>
 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             return \%itemlocation;
 915             exit 1;
 916         }
 917         else {
 918
 919             #No authvalue list
 920             # build default
 921         }
 922     }
 923
 924     #No authvalue list
 925     #build default
 926     $itemlocation{"1"} = "Not For Loan";
 927     return \%itemlocation;
 928 }
 929
 930 =head2 GetLostItems
 931
 932   $items = GetLostItems( $where, $orderby );
 933
 934 This function gets a list of lost items.
 935
 936 =over 2
 937
 938 =item input:
 939
 940 C<$where> is a hashref. it containts a field of the items table as key
 941 and the value to match as value. For example:
 942
 943 { barcode    => 'abc123',
 944   homebranch => 'CPL',    }
 945
 946 C<$orderby> is a field of the items table by which the resultset
 947 should be orderd.
 948
 949 =item return:
 950
 951 C<$items> is a reference to an array full of hashrefs with columns
 952 from the "items" table as keys.
 953
 954 =item usage in the perl script:
 955
 956   my $where = { barcode => '0001548' };
 957   my $items = GetLostItems( $where, "homebranch" );
 958   $template->param( itemsloop => $items );
 959
 960 =back
 961
 962 =cut
 963
 964 sub GetLostItems {
 965     # Getting input args.
 966     my $where   = shift;
 967     my $orderby = shift;
 968     my $dbh     = C4::Context->dbh;
 969
 970     my $query   = "
 971         SELECT title, author, lib, itemlost, authorised_value, barcode, datelastseen, price, replacementprice, homebranch,
 972                itype, itemtype, holdingbranch, location, itemnotes, items.biblionumber as biblionumber
 973         FROM   items
 974             LEFT JOIN biblio ON (items.biblionumber = biblio.biblionumber)
 975             LEFT JOIN biblioitems ON (items.biblionumber = biblioitems.biblionumber)
 976             LEFT JOIN authorised_values ON (items.itemlost = authorised_values.authorised_value)
 977         WHERE
 978                 authorised_values.category = 'LOST'
 979                 AND itemlost IS NOT NULL
 980                 AND itemlost <> 0
 981     ";
 982     my @query_parameters;
 983     foreach my $key (keys %$where) {
 984         $query .= " AND $key LIKE ?";
 985         push @query_parameters, "%$where->{$key}%";
 986     }
 987     my @ordervalues = qw/title author homebranch itype barcode price replacementprice lib datelastseen location/;
 988
 989     if ( defined $orderby && grep($orderby, @ordervalues)) {
 990         $query .= ' ORDER BY '.$orderby;
 991     }
 992
 993     my $sth = $dbh->prepare($query);
 994     $sth->execute( @query_parameters );
 995     my $items = [];
 996     while ( my $row = $sth->fetchrow_hashref ){
 997         push @$items, $row;
 998     }
 999     return $items;
1000 }
1001
1002 =head2 GetItemsForInventory
1003
1004 ($itemlist, $iTotalRecords)  = GetItemsForInventory($minlocation, $maxlocation, $location, $itemtype, $ignoreissued, $datelastseen, $branchcode, $offset, $size, $statushash);
1005
1006 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
1007
1008 The sub returns a reference to a list of hashes, each containing
1009 itemnumber, author, title, barcode, item callnumber, and date last
1010 seen. It is ordered by callnumber then title.
1011
1012 The required minlocation & maxlocation parameters are used to specify a range of item callnumbers
1013 the datelastseen can be used to specify that you want to see items not seen since a past date only.
1014 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
1015 $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.
1016
1017 $iTotalRecords is the number of rows that would have been returned without the $offset, $size limit clause
1018
1019 =cut
1020
1021 sub GetItemsForInventory {
1022     my ( $minlocation, $maxlocation,$location, $itemtype, $ignoreissued, $datelastseen, $branchcode, $branch, $offset, $size, $statushash ) = @_;
1023     my $dbh = C4::Context->dbh;
1024     my ( @bind_params, @where_strings );
1025
1026     my $select_columns = q{
1027         SELECT items.itemnumber, barcode, itemcallnumber, title, author, biblio.biblionumber, biblio.frameworkcode, datelastseen, homebranch, location, notforloan, damaged, itemlost, stocknumber
1028     };
1029     my $select_count = q{SELECT COUNT(*)};
1030     my $query = q{
1031         FROM items
1032         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
1033         LEFT JOIN biblioitems on items.biblionumber = biblioitems.biblionumber
1034     };
1035     if ($statushash){
1036         for my $authvfield (keys %$statushash){
1037             if ( scalar @{$statushash->{$authvfield}} > 0 ){
1038                 my $joinedvals = join ',', @{$statushash->{$authvfield}};
1039                 push @where_strings, "$authvfield in (" . $joinedvals . ")";
1040             }
1041         }
1042     }
1043
1044     if ($minlocation) {
1045         push @where_strings, 'itemcallnumber >= ?';
1046         push @bind_params, $minlocation;
1047     }
1048
1049     if ($maxlocation) {
1050         push @where_strings, 'itemcallnumber <= ?';
1051         push @bind_params, $maxlocation;
1052     }
1053
1054     if ($datelastseen) {
1055         $datelastseen = format_date_in_iso($datelastseen);
1056         push @where_strings, '(datelastseen < ? OR datelastseen IS NULL)';
1057         push @bind_params, $datelastseen;
1058     }
1059
1060     if ( $location ) {
1061         push @where_strings, 'items.location = ?';
1062         push @bind_params, $location;
1063     }
1064
1065     if ( $branchcode ) {
1066         if($branch eq "homebranch"){
1067         push @where_strings, 'items.homebranch = ?';
1068         }else{
1069             push @where_strings, 'items.holdingbranch = ?';
1070         }
1071         push @bind_params, $branchcode;
1072     }
1073
1074     if ( $itemtype ) {
1075         push @where_strings, 'biblioitems.itemtype = ?';
1076         push @bind_params, $itemtype;
1077     }
1078
1079     if ( $ignoreissued) {
1080         $query .= "LEFT JOIN issues ON items.itemnumber = issues.itemnumber ";
1081         push @where_strings, 'issues.date_due IS NULL';
1082     }
1083
1084     if ( @where_strings ) {
1085         $query .= 'WHERE ';
1086         $query .= join ' AND ', @where_strings;
1087     }
1088     $query .= ' ORDER BY items.cn_sort, itemcallnumber, title';
1089     my $count_query = $select_count . $query;
1090     $query .= " LIMIT $offset, $size" if ($offset and $size);
1091     $query = $select_columns . $query;
1092     my $sth = $dbh->prepare($query);
1093     $sth->execute( @bind_params );
1094
1095     my @results = ();
1096     my $tmpresults = $sth->fetchall_arrayref({});
1097     $sth = $dbh->prepare( $count_query );
1098     $sth->execute( @bind_params );
1099     my ($iTotalRecords) = $sth->fetchrow_array();
1100
1101     foreach my $row (@$tmpresults) {
1102
1103         # Auth values
1104         foreach (keys %$row) {
1105             # If the koha field is mapped to a marc field
1106             my ($f, $sf) = GetMarcFromKohaField("items.$_", $row->{'frameworkcode'});
1107             if ($f and $sf) {
1108                 # We replace the code with it's description
1109                 my $authvals = C4::Koha::GetKohaAuthorisedValuesFromField($f, $sf, $row->{'frameworkcode'});
1110                 $row->{$_} = $authvals->{$row->{$_}} if defined $authvals->{$row->{$_}};
1111             }
1112         }
1113         push @results, $row;
1114     }
1115
1116     return (\@results, $iTotalRecords);
1117 }
1118
1119 =head2 GetItemsCount
1120
1121   $count = &GetItemsCount( $biblionumber);
1122
1123 This function return count of item with $biblionumber
1124
1125 =cut
1126
1127 sub GetItemsCount {
1128     my ( $biblionumber ) = @_;
1129     my $dbh = C4::Context->dbh;
1130     my $query = "SELECT count(*)
1131           FROM  items
1132           WHERE biblionumber=?";
1133     my $sth = $dbh->prepare($query);
1134     $sth->execute($biblionumber);
1135     my $count = $sth->fetchrow;
1136     return ($count);
1137 }
1138
1139 =head2 GetItemInfosOf
1140
1141   GetItemInfosOf(@itemnumbers);
1142
1143 =cut
1144
1145 sub GetItemInfosOf {
1146     my @itemnumbers = @_;
1147
1148     my $itemnumber_values = @itemnumbers ? join( ',', @itemnumbers ) : "''";
1149
1150     my $query = "
1151         SELECT *
1152         FROM items
1153         WHERE itemnumber IN ($itemnumber_values)
1154     ";
1155     return get_infos_of( $query, 'itemnumber' );
1156 }
1157
1158 =head2 GetItemsByBiblioitemnumber
1159
1160   GetItemsByBiblioitemnumber($biblioitemnumber);
1161
1162 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1163 Called by C<C4::XISBN>
1164
1165 =cut
1166
1167 sub GetItemsByBiblioitemnumber {
1168     my ( $bibitem ) = @_;
1169     my $dbh = C4::Context->dbh;
1170     my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1171     # Get all items attached to a biblioitem
1172     my $i = 0;
1173     my @results;
1174     $sth->execute($bibitem) || die $sth->errstr;
1175     while ( my $data = $sth->fetchrow_hashref ) {
1176         # Foreach item, get circulation information
1177         my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1178                                    WHERE itemnumber = ?
1179                                    AND issues.borrowernumber = borrowers.borrowernumber"
1180         );
1181         $sth2->execute( $data->{'itemnumber'} );
1182         if ( my $data2 = $sth2->fetchrow_hashref ) {
1183             # if item is out, set the due date and who it is out too
1184             $data->{'date_due'}   = $data2->{'date_due'};
1185             $data->{'cardnumber'} = $data2->{'cardnumber'};
1186             $data->{'borrowernumber'}   = $data2->{'borrowernumber'};
1187         }
1188         else {
1189             # set date_due to blank, so in the template we check itemlost, and withdrawn
1190             $data->{'date_due'} = '';
1191         }    # else
1192         # Find the last 3 people who borrowed this item.
1193         my $query2 = "SELECT * FROM old_issues, borrowers WHERE itemnumber = ?
1194                       AND old_issues.borrowernumber = borrowers.borrowernumber
1195                       ORDER BY returndate desc,timestamp desc LIMIT 3";
1196         $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1197         $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1198         my $i2 = 0;
1199         while ( my $data2 = $sth2->fetchrow_hashref ) {
1200             $data->{"timestamp$i2"} = $data2->{'timestamp'};
1201             $data->{"card$i2"}      = $data2->{'cardnumber'};
1202             $data->{"borrower$i2"}  = $data2->{'borrowernumber'};
1203             $i2++;
1204         }
1205         push(@results,$data);
1206     }
1207     return (\@results);
1208 }
1209
1210 =head2 GetItemsInfo
1211
1212   @results = GetItemsInfo($biblionumber);
1213
1214 Returns information about items with the given biblionumber.
1215
1216 C<GetItemsInfo> returns a list of references-to-hash. Each element
1217 contains a number of keys. Most of them are attributes from the
1218 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
1219 Koha database. Other keys include:
1220
1221 =over 2
1222
1223 =item C<$data-E<gt>{branchname}>
1224
1225 The name (not the code) of the branch to which the book belongs.
1226
1227 =item C<$data-E<gt>{datelastseen}>
1228
1229 This is simply C<items.datelastseen>, except that while the date is
1230 stored in YYYY-MM-DD format in the database, here it is converted to
1231 DD/MM/YYYY format. A NULL date is returned as C<//>.
1232
1233 =item C<$data-E<gt>{datedue}>
1234
1235 =item C<$data-E<gt>{class}>
1236
1237 This is the concatenation of C<biblioitems.classification>, the book's
1238 Dewey code, and C<biblioitems.subclass>.
1239
1240 =item C<$data-E<gt>{ocount}>
1241
1242 I think this is the number of copies of the book available.
1243
1244 =item C<$data-E<gt>{order}>
1245
1246 If this is set, it is set to C<One Order>.
1247
1248 =back
1249
1250 =cut
1251
1252 sub GetItemsInfo {
1253     my ( $biblionumber ) = @_;
1254     my $dbh   = C4::Context->dbh;
1255     # note biblioitems.* must be avoided to prevent large marc and marcxml fields from killing performance.
1256     my $query = "
1257     SELECT items.*,
1258            biblio.*,
1259            biblioitems.volume,
1260            biblioitems.number,
1261            biblioitems.itemtype,
1262            biblioitems.isbn,
1263            biblioitems.issn,
1264            biblioitems.publicationyear,
1265            biblioitems.publishercode,
1266            biblioitems.volumedate,
1267            biblioitems.volumedesc,
1268            biblioitems.lccn,
1269            biblioitems.url,
1270            items.notforloan as itemnotforloan,
1271            itemtypes.description,
1272            itemtypes.notforloan as notforloan_per_itemtype,
1273            holding.branchurl,
1274            holding.branchname,
1275            holding.opac_info as holding_branch_opac_info,
1276            home.opac_info as home_branch_opac_info
1277      FROM items
1278      LEFT JOIN branches AS holding ON items.holdingbranch = holding.branchcode
1279      LEFT JOIN branches AS home ON items.homebranch=home.branchcode
1280      LEFT JOIN biblio      ON      biblio.biblionumber     = items.biblionumber
1281      LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1282      LEFT JOIN itemtypes   ON   itemtypes.itemtype         = "
1283      . (C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype');
1284     $query .= " WHERE items.biblionumber = ? ORDER BY home.branchname, items.enumchron, LPAD( items.copynumber, 8, '0' ), items.dateaccessioned DESC" ;
1285     my $sth = $dbh->prepare($query);
1286     $sth->execute($biblionumber);
1287     my $i = 0;
1288     my @results;
1289     my $serial;
1290
1291     my $isth    = $dbh->prepare(
1292         "SELECT issues.*,borrowers.cardnumber,borrowers.surname,borrowers.firstname,borrowers.branchcode as bcode
1293         FROM   issues LEFT JOIN borrowers ON issues.borrowernumber=borrowers.borrowernumber
1294         WHERE  itemnumber = ?"
1295        );
1296         my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=? ");
1297         while ( my $data = $sth->fetchrow_hashref ) {
1298         my $datedue = '';
1299         $isth->execute( $data->{'itemnumber'} );
1300         if ( my $idata = $isth->fetchrow_hashref ) {
1301             $data->{borrowernumber} = $idata->{borrowernumber};
1302             $data->{cardnumber}     = $idata->{cardnumber};
1303             $data->{surname}     = $idata->{surname};
1304             $data->{firstname}     = $idata->{firstname};
1305             $data->{lastreneweddate} = $idata->{lastreneweddate};
1306             $datedue                = $idata->{'date_due'};
1307         if (C4::Context->preference("IndependentBranches")){
1308         my $userenv = C4::Context->userenv;
1309         unless ( C4::Context->IsSuperLibrarian() ) {
1310             $data->{'NOTSAMEBRANCH'} = 1 if ($idata->{'bcode'} ne $userenv->{branch});
1311         }
1312         }
1313         }
1314                 if ( $data->{'serial'}) {
1315                         $ssth->execute($data->{'itemnumber'}) ;
1316                         ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
1317                         $serial = 1;
1318         }
1319         #get branch information.....
1320         my $bsth = $dbh->prepare(
1321             "SELECT * FROM branches WHERE branchcode = ?
1322         "
1323         );
1324         $bsth->execute( $data->{'holdingbranch'} );
1325         if ( my $bdata = $bsth->fetchrow_hashref ) {
1326             $data->{'branchname'} = $bdata->{'branchname'};
1327         }
1328         $data->{'datedue'}        = $datedue;
1329
1330         # get notforloan complete status if applicable
1331         if ( my $code = C4::Koha::GetAuthValCode( 'items.notforloan', $data->{frameworkcode} ) ) {
1332             $data->{notforloanvalue}     = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{itemnotforloan} );
1333             $data->{notforloanvalueopac} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{itemnotforloan}, 1 );
1334         }
1335
1336         # get restricted status and description if applicable
1337         if ( my $code = C4::Koha::GetAuthValCode( 'items.restricted', $data->{frameworkcode} ) ) {
1338             $data->{restrictedopac} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{restricted}, 1 );
1339             $data->{restricted}     = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{restricted} );
1340         }
1341
1342         # my stack procedures
1343         if ( my $code = C4::Koha::GetAuthValCode( 'items.stack', $data->{frameworkcode} ) ) {
1344             $data->{stack}          = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{stack} );
1345         }
1346         # Find the last 3 people who borrowed this item.
1347         my $sth2 = $dbh->prepare("SELECT * FROM old_issues,borrowers
1348                                     WHERE itemnumber = ?
1349                                     AND old_issues.borrowernumber = borrowers.borrowernumber
1350                                     ORDER BY returndate DESC
1351                                     LIMIT 3");
1352         $sth2->execute($data->{'itemnumber'});
1353         my $ii = 0;
1354         while (my $data2 = $sth2->fetchrow_hashref()) {
1355             $data->{"timestamp$ii"} = $data2->{'timestamp'} if $data2->{'timestamp'};
1356             $data->{"card$ii"}      = $data2->{'cardnumber'} if $data2->{'cardnumber'};
1357             $data->{"borrower$ii"}  = $data2->{'borrowernumber'} if $data2->{'borrowernumber'};
1358             $ii++;
1359         }
1360
1361         $results[$i] = $data;
1362         $i++;
1363     }
1364         if($serial) {
1365                 return( sort { ($b->{'publisheddate'} || $b->{'enumchron'}) cmp ($a->{'publisheddate'} || $a->{'enumchron'}) } @results );
1366         } else {
1367         return (@results);
1368         }
1369 }
1370
1371 =head2 GetItemsLocationInfo
1372
1373   my @itemlocinfo = GetItemsLocationInfo($biblionumber);
1374
1375 Returns the branch names, shelving location and itemcallnumber for each item attached to the biblio in question
1376
1377 C<GetItemsInfo> returns a list of references-to-hash. Data returned:
1378
1379 =over 2
1380
1381 =item C<$data-E<gt>{homebranch}>
1382
1383 Branch Name of the item's homebranch
1384
1385 =item C<$data-E<gt>{holdingbranch}>
1386
1387 Branch Name of the item's holdingbranch
1388
1389 =item C<$data-E<gt>{location}>
1390
1391 Item's shelving location code
1392
1393 =item C<$data-E<gt>{location_intranet}>
1394
1395 The intranet description for the Shelving Location as set in authorised_values 'LOC'
1396
1397 =item C<$data-E<gt>{location_opac}>
1398
1399 The OPAC description for the Shelving Location as set in authorised_values 'LOC'.  Falls back to intranet description if no OPAC
1400 description is set.
1401
1402 =item C<$data-E<gt>{itemcallnumber}>
1403
1404 Item's itemcallnumber
1405
1406 =item C<$data-E<gt>{cn_sort}>
1407
1408 Item's call number normalized for sorting
1409
1410 =back
1411
1412 =cut
1413
1414 sub GetItemsLocationInfo {
1415         my $biblionumber = shift;
1416         my @results;
1417
1418         my $dbh = C4::Context->dbh;
1419         my $query = "SELECT a.branchname as homebranch, b.branchname as holdingbranch,
1420                             location, itemcallnumber, cn_sort
1421                      FROM items, branches as a, branches as b
1422                      WHERE homebranch = a.branchcode AND holdingbranch = b.branchcode
1423                      AND biblionumber = ?
1424                      ORDER BY cn_sort ASC";
1425         my $sth = $dbh->prepare($query);
1426         $sth->execute($biblionumber);
1427
1428         while ( my $data = $sth->fetchrow_hashref ) {
1429              $data->{location_intranet} = GetKohaAuthorisedValueLib('LOC', $data->{location});
1430              $data->{location_opac}= GetKohaAuthorisedValueLib('LOC', $data->{location}, 1);
1431              push @results, $data;
1432         }
1433         return @results;
1434 }
1435
1436 =head2 GetHostItemsInfo
1437
1438         $hostiteminfo = GetHostItemsInfo($hostfield);
1439         Returns the iteminfo for items linked to records via a host field
1440
1441 =cut
1442
1443 sub GetHostItemsInfo {
1444         my ($record) = @_;
1445         my @returnitemsInfo;
1446
1447         if (C4::Context->preference('marcflavour') eq 'MARC21' ||
1448         C4::Context->preference('marcflavour') eq 'NORMARC'){
1449             foreach my $hostfield ( $record->field('773') ) {
1450                 my $hostbiblionumber = $hostfield->subfield("0");
1451                 my $linkeditemnumber = $hostfield->subfield("9");
1452                 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1453                 foreach my $hostitemInfo (@hostitemInfos){
1454                         if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1455                                 push (@returnitemsInfo,$hostitemInfo);
1456                                 last;
1457                         }
1458                 }
1459             }
1460         } elsif ( C4::Context->preference('marcflavour') eq 'UNIMARC'){
1461             foreach my $hostfield ( $record->field('461') ) {
1462                 my $hostbiblionumber = $hostfield->subfield("0");
1463                 my $linkeditemnumber = $hostfield->subfield("9");
1464                 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1465                 foreach my $hostitemInfo (@hostitemInfos){
1466                         if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1467                                 push (@returnitemsInfo,$hostitemInfo);
1468                                 last;
1469                         }
1470                 }
1471             }
1472         }
1473         return @returnitemsInfo;
1474 }
1475
1476
1477 =head2 GetLastAcquisitions
1478
1479   my $lastacq = GetLastAcquisitions({'branches' => ('branch1','branch2'),
1480                                     'itemtypes' => ('BK','BD')}, 10);
1481
1482 =cut
1483
1484 sub  GetLastAcquisitions {
1485         my ($data,$max) = @_;
1486
1487         my $itemtype = C4::Context->preference('item-level_itypes') ? 'itype' : 'itemtype';
1488
1489         my $number_of_branches = @{$data->{branches}};
1490         my $number_of_itemtypes   = @{$data->{itemtypes}};
1491
1492
1493         my @where = ('WHERE 1 ');
1494         $number_of_branches and push @where
1495            , 'AND holdingbranch IN ('
1496            , join(',', ('?') x $number_of_branches )
1497            , ')'
1498          ;
1499
1500         $number_of_itemtypes and push @where
1501            , "AND $itemtype IN ("
1502            , join(',', ('?') x $number_of_itemtypes )
1503            , ')'
1504          ;
1505
1506         my $query = "SELECT biblio.biblionumber as biblionumber, title, dateaccessioned
1507                                  FROM items RIGHT JOIN biblio ON (items.biblionumber=biblio.biblionumber)
1508                                     RIGHT JOIN biblioitems ON (items.biblioitemnumber=biblioitems.biblioitemnumber)
1509                                     @where
1510                                     GROUP BY biblio.biblionumber
1511                                     ORDER BY dateaccessioned DESC LIMIT $max";
1512
1513         my $dbh = C4::Context->dbh;
1514         my $sth = $dbh->prepare($query);
1515
1516     $sth->execute((@{$data->{branches}}, @{$data->{itemtypes}}));
1517
1518         my @results;
1519         while( my $row = $sth->fetchrow_hashref){
1520                 push @results, {date => $row->{dateaccessioned}
1521                                                 , biblionumber => $row->{biblionumber}
1522                                                 , title => $row->{title}};
1523         }
1524
1525         return @results;
1526 }
1527
1528 =head2 GetItemnumbersForBiblio
1529
1530   my $itemnumbers = GetItemnumbersForBiblio($biblionumber);
1531
1532 Given a single biblionumber, return an arrayref of all the corresponding itemnumbers
1533
1534 =cut
1535
1536 sub GetItemnumbersForBiblio {
1537     my $biblionumber = shift;
1538     my @items;
1539     my $dbh = C4::Context->dbh;
1540     my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber = ?");
1541     $sth->execute($biblionumber);
1542     while (my $result = $sth->fetchrow_hashref) {
1543         push @items, $result->{'itemnumber'};
1544     }
1545     return \@items;
1546 }
1547
1548 =head2 get_itemnumbers_of
1549
1550   my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1551
1552 Given a list of biblionumbers, return the list of corresponding itemnumbers
1553 for each biblionumber.
1554
1555 Return a reference on a hash where keys are biblionumbers and values are
1556 references on array of itemnumbers.
1557
1558 =cut
1559
1560 sub get_itemnumbers_of {
1561     my @biblionumbers = @_;
1562
1563     my $dbh = C4::Context->dbh;
1564
1565     my $query = '
1566         SELECT itemnumber,
1567             biblionumber
1568         FROM items
1569         WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1570     ';
1571     my $sth = $dbh->prepare($query);
1572     $sth->execute(@biblionumbers);
1573
1574     my %itemnumbers_of;
1575
1576     while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1577         push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1578     }
1579
1580     return \%itemnumbers_of;
1581 }
1582
1583 =head2 get_hostitemnumbers_of
1584
1585   my @itemnumbers_of = get_hostitemnumbers_of($biblionumber);
1586
1587 Given a biblionumber, return the list of corresponding itemnumbers that are linked to it via host fields
1588
1589 Return a reference on a hash where key is a biblionumber and values are
1590 references on array of itemnumbers.
1591
1592 =cut
1593
1594
1595 sub get_hostitemnumbers_of {
1596         my ($biblionumber) = @_;
1597         my $marcrecord = GetMarcBiblio($biblionumber);
1598         my (@returnhostitemnumbers,$tag, $biblio_s, $item_s);
1599
1600         my $marcflavor = C4::Context->preference('marcflavour');
1601         if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1602         $tag='773';
1603         $biblio_s='0';
1604         $item_s='9';
1605     } elsif ($marcflavor eq 'UNIMARC') {
1606         $tag='461';
1607         $biblio_s='0';
1608         $item_s='9';
1609     }
1610
1611     foreach my $hostfield ( $marcrecord->field($tag) ) {
1612         my $hostbiblionumber = $hostfield->subfield($biblio_s);
1613         my $linkeditemnumber = $hostfield->subfield($item_s);
1614         my @itemnumbers;
1615         if (my $itemnumbers = get_itemnumbers_of($hostbiblionumber)->{$hostbiblionumber})
1616         {
1617             @itemnumbers = @$itemnumbers;
1618         }
1619         foreach my $itemnumber (@itemnumbers){
1620             if ($itemnumber eq $linkeditemnumber){
1621                 push (@returnhostitemnumbers,$itemnumber);
1622                 last;
1623             }
1624         }
1625     }
1626     return @returnhostitemnumbers;
1627 }
1628
1629
1630 =head2 GetItemnumberFromBarcode
1631
1632   $result = GetItemnumberFromBarcode($barcode);
1633
1634 =cut
1635
1636 sub GetItemnumberFromBarcode {
1637     my ($barcode) = @_;
1638     my $dbh = C4::Context->dbh;
1639
1640     my $rq =
1641       $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1642     $rq->execute($barcode);
1643     my ($result) = $rq->fetchrow;
1644     return ($result);
1645 }
1646
1647 =head2 GetBarcodeFromItemnumber
1648
1649   $result = GetBarcodeFromItemnumber($itemnumber);
1650
1651 =cut
1652
1653 sub GetBarcodeFromItemnumber {
1654     my ($itemnumber) = @_;
1655     my $dbh = C4::Context->dbh;
1656
1657     my $rq =
1658       $dbh->prepare("SELECT barcode FROM items WHERE items.itemnumber=?");
1659     $rq->execute($itemnumber);
1660     my ($result) = $rq->fetchrow;
1661     return ($result);
1662 }
1663
1664 =head2 GetHiddenItemnumbers
1665
1666     my @itemnumbers_to_hide = GetHiddenItemnumbers(@items);
1667
1668 Given a list of items it checks which should be hidden from the OPAC given
1669 the current configuration. Returns a list of itemnumbers corresponding to
1670 those that should be hidden.
1671
1672 =cut
1673
1674 sub GetHiddenItemnumbers {
1675     my (@items) = @_;
1676     my @resultitems;
1677
1678     my $yaml = C4::Context->preference('OpacHiddenItems');
1679     return () if (! $yaml =~ /\S/ );
1680     $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1681     my $hidingrules;
1682     eval {
1683         $hidingrules = YAML::Load($yaml);
1684     };
1685     if ($@) {
1686         warn "Unable to parse OpacHiddenItems syspref : $@";
1687         return ();
1688     }
1689     my $dbh = C4::Context->dbh;
1690
1691     # For each item
1692     foreach my $item (@items) {
1693
1694         # We check each rule
1695         foreach my $field (keys %$hidingrules) {
1696             my $val;
1697             if (exists $item->{$field}) {
1698                 $val = $item->{$field};
1699             }
1700             else {
1701                 my $query = "SELECT $field from items where itemnumber = ?";
1702                 $val = $dbh->selectrow_array($query, undef, $item->{'itemnumber'});
1703             }
1704             $val = '' unless defined $val;
1705
1706             # If the results matches the values in the yaml file
1707             if (any { $val eq $_ } @{$hidingrules->{$field}}) {
1708
1709                 # We add the itemnumber to the list
1710                 push @resultitems, $item->{'itemnumber'};
1711
1712                 # If at least one rule matched for an item, no need to test the others
1713                 last;
1714             }
1715         }
1716     }
1717     return @resultitems;
1718 }
1719
1720 =head3 get_item_authorised_values
1721
1722 find the types and values for all authorised values assigned to this item.
1723
1724 parameters: itemnumber
1725
1726 returns: a hashref malling the authorised value to the value set for this itemnumber
1727
1728     $authorised_values = {
1729              'CCODE'      => undef,
1730              'DAMAGED'    => '0',
1731              'LOC'        => '3',
1732              'LOST'       => '0'
1733              'NOT_LOAN'   => '0',
1734              'RESTRICTED' => undef,
1735              'STACK'      => undef,
1736              'WITHDRAWN'  => '0',
1737              'branches'   => 'CPL',
1738              'cn_source'  => undef,
1739              'itemtypes'  => 'SER',
1740            };
1741
1742 Notes: see C4::Biblio::get_biblio_authorised_values for a similar method at the biblio level.
1743
1744 =cut
1745
1746 sub get_item_authorised_values {
1747     my $itemnumber = shift;
1748
1749     # assume that these entries in the authorised_value table are item level.
1750     my $query = q(SELECT distinct authorised_value, kohafield
1751                     FROM marc_subfield_structure
1752                     WHERE kohafield like 'item%'
1753                       AND authorised_value != '' );
1754
1755     my $itemlevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
1756     my $iteminfo = GetItem( $itemnumber );
1757     # warn( Data::Dumper->Dump( [ $itemlevel_authorised_values ], [ 'itemlevel_authorised_values' ] ) );
1758     my $return;
1759     foreach my $this_authorised_value ( keys %$itemlevel_authorised_values ) {
1760         my $field = $itemlevel_authorised_values->{ $this_authorised_value }->{'kohafield'};
1761         $field =~ s/^items\.//;
1762         if ( exists $iteminfo->{ $field } ) {
1763             $return->{ $this_authorised_value } = $iteminfo->{ $field };
1764         }
1765     }
1766     # warn( Data::Dumper->Dump( [ $return ], [ 'return' ] ) );
1767     return $return;
1768 }
1769
1770 =head3 get_authorised_value_images
1771
1772 find a list of icons that are appropriate for display based on the
1773 authorised values for a biblio.
1774
1775 parameters: listref of authorised values, such as comes from
1776 get_item_authorised_values or
1777 from C4::Biblio::get_biblio_authorised_values
1778
1779 returns: listref of hashrefs for each image. Each hashref looks like this:
1780
1781       { imageurl => '/intranet-tmpl/prog/img/itemtypeimg/npl/WEB.gif',
1782         label    => '',
1783         category => '',
1784         value    => '', }
1785
1786 Notes: Currently, I put on the full path to the images on the staff
1787 side. This should either be configurable or not done at all. Since I
1788 have to deal with 'intranet' or 'opac' in
1789 get_biblio_authorised_values, perhaps I should be passing it in.
1790
1791 =cut
1792
1793 sub get_authorised_value_images {
1794     my $authorised_values = shift;
1795
1796     my @imagelist;
1797
1798     my $authorised_value_list = GetAuthorisedValues();
1799     # warn ( Data::Dumper->Dump( [ $authorised_value_list ], [ 'authorised_value_list' ] ) );
1800     foreach my $this_authorised_value ( @$authorised_value_list ) {
1801         if ( exists $authorised_values->{ $this_authorised_value->{'category'} }
1802              && $authorised_values->{ $this_authorised_value->{'category'} } eq $this_authorised_value->{'authorised_value'} ) {
1803             # warn ( Data::Dumper->Dump( [ $this_authorised_value ], [ 'this_authorised_value' ] ) );
1804             if ( defined $this_authorised_value->{'imageurl'} ) {
1805                 push @imagelist, { imageurl => C4::Koha::getitemtypeimagelocation( 'intranet', $this_authorised_value->{'imageurl'} ),
1806                                    label    => $this_authorised_value->{'lib'},
1807                                    category => $this_authorised_value->{'category'},
1808                                    value    => $this_authorised_value->{'authorised_value'}, };
1809             }
1810         }
1811     }
1812
1813     # warn ( Data::Dumper->Dump( [ \@imagelist ], [ 'imagelist' ] ) );
1814     return \@imagelist;
1815
1816 }
1817
1818 =head1 LIMITED USE FUNCTIONS
1819
1820 The following functions, while part of the public API,
1821 are not exported.  This is generally because they are
1822 meant to be used by only one script for a specific
1823 purpose, and should not be used in any other context
1824 without careful thought.
1825
1826 =cut
1827
1828 =head2 GetMarcItem
1829
1830   my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1831
1832 Returns MARC::Record of the item passed in parameter.
1833 This function is meant for use only in C<cataloguing/additem.pl>,
1834 where it is needed to support that script's MARC-like
1835 editor.
1836
1837 =cut
1838
1839 sub GetMarcItem {
1840     my ( $biblionumber, $itemnumber ) = @_;
1841
1842     # GetMarcItem has been revised so that it does the following:
1843     #  1. Gets the item information from the items table.
1844     #  2. Converts it to a MARC field for storage in the bib record.
1845     #
1846     # The previous behavior was:
1847     #  1. Get the bib record.
1848     #  2. Return the MARC tag corresponding to the item record.
1849     #
1850     # The difference is that one treats the items row as authoritative,
1851     # while the other treats the MARC representation as authoritative
1852     # under certain circumstances.
1853
1854     my $itemrecord = GetItem($itemnumber);
1855
1856     # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1857     # Also, don't emit a subfield if the underlying field is blank.
1858
1859
1860     return Item2Marc($itemrecord,$biblionumber);
1861
1862 }
1863 sub Item2Marc {
1864         my ($itemrecord,$biblionumber)=@_;
1865     my $mungeditem = {
1866         map {
1867             defined($itemrecord->{$_}) && $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : ()
1868         } keys %{ $itemrecord }
1869     };
1870     my $itemmarc = TransformKohaToMarc($mungeditem);
1871     my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",GetFrameworkCode($biblionumber)||'');
1872
1873     my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1874     if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1875                 foreach my $field ($itemmarc->field($itemtag)){
1876             $field->add_subfields(@$unlinked_item_subfields);
1877         }
1878     }
1879         return $itemmarc;
1880 }
1881
1882 =head1 PRIVATE FUNCTIONS AND VARIABLES
1883
1884 The following functions are not meant to be called
1885 directly, but are documented in order to explain
1886 the inner workings of C<C4::Items>.
1887
1888 =cut
1889
1890 =head2 %derived_columns
1891
1892 This hash keeps track of item columns that
1893 are strictly derived from other columns in
1894 the item record and are not meant to be set
1895 independently.
1896
1897 Each key in the hash should be the name of a
1898 column (as named by TransformMarcToKoha).  Each
1899 value should be hashref whose keys are the
1900 columns on which the derived column depends.  The
1901 hashref should also contain a 'BUILDER' key
1902 that is a reference to a sub that calculates
1903 the derived value.
1904
1905 =cut
1906
1907 my %derived_columns = (
1908     'items.cn_sort' => {
1909         'itemcallnumber' => 1,
1910         'items.cn_source' => 1,
1911         'BUILDER' => \&_calc_items_cn_sort,
1912     }
1913 );
1914
1915 =head2 _set_derived_columns_for_add
1916
1917   _set_derived_column_for_add($item);
1918
1919 Given an item hash representing a new item to be added,
1920 calculate any derived columns.  Currently the only
1921 such column is C<items.cn_sort>.
1922
1923 =cut
1924
1925 sub _set_derived_columns_for_add {
1926     my $item = shift;
1927
1928     foreach my $column (keys %derived_columns) {
1929         my $builder = $derived_columns{$column}->{'BUILDER'};
1930         my $source_values = {};
1931         foreach my $source_column (keys %{ $derived_columns{$column} }) {
1932             next if $source_column eq 'BUILDER';
1933             $source_values->{$source_column} = $item->{$source_column};
1934         }
1935         $builder->($item, $source_values);
1936     }
1937 }
1938
1939 =head2 _set_derived_columns_for_mod
1940
1941   _set_derived_column_for_mod($item);
1942
1943 Given an item hash representing a new item to be modified.
1944 calculate any derived columns.  Currently the only
1945 such column is C<items.cn_sort>.
1946
1947 This routine differs from C<_set_derived_columns_for_add>
1948 in that it needs to handle partial item records.  In other
1949 words, the caller of C<ModItem> may have supplied only one
1950 or two columns to be changed, so this function needs to
1951 determine whether any of the columns to be changed affect
1952 any of the derived columns.  Also, if a derived column
1953 depends on more than one column, but the caller is not
1954 changing all of then, this routine retrieves the unchanged
1955 values from the database in order to ensure a correct
1956 calculation.
1957
1958 =cut
1959
1960 sub _set_derived_columns_for_mod {
1961     my $item = shift;
1962
1963     foreach my $column (keys %derived_columns) {
1964         my $builder = $derived_columns{$column}->{'BUILDER'};
1965         my $source_values = {};
1966         my %missing_sources = ();
1967         my $must_recalc = 0;
1968         foreach my $source_column (keys %{ $derived_columns{$column} }) {
1969             next if $source_column eq 'BUILDER';
1970             if (exists $item->{$source_column}) {
1971                 $must_recalc = 1;
1972                 $source_values->{$source_column} = $item->{$source_column};
1973             } else {
1974                 $missing_sources{$source_column} = 1;
1975             }
1976         }
1977         if ($must_recalc) {
1978             foreach my $source_column (keys %missing_sources) {
1979                 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
1980             }
1981             $builder->($item, $source_values);
1982         }
1983     }
1984 }
1985
1986 =head2 _do_column_fixes_for_mod
1987
1988   _do_column_fixes_for_mod($item);
1989
1990 Given an item hashref containing one or more
1991 columns to modify, fix up certain values.
1992 Specifically, set to 0 any passed value
1993 of C<notforloan>, C<damaged>, C<itemlost>, or
1994 C<withdrawn> that is either undefined or
1995 contains the empty string.
1996
1997 =cut
1998
1999 sub _do_column_fixes_for_mod {
2000     my $item = shift;
2001
2002     if (exists $item->{'notforloan'} and
2003         (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
2004         $item->{'notforloan'} = 0;
2005     }
2006     if (exists $item->{'damaged'} and
2007         (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
2008         $item->{'damaged'} = 0;
2009     }
2010     if (exists $item->{'itemlost'} and
2011         (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
2012         $item->{'itemlost'} = 0;
2013     }
2014     if (exists $item->{'withdrawn'} and
2015         (not defined $item->{'withdrawn'} or $item->{'withdrawn'} eq '')) {
2016         $item->{'withdrawn'} = 0;
2017     }
2018     if (exists $item->{'location'} && !exists $item->{'permanent_location'}) {
2019         $item->{'permanent_location'} = $item->{'location'};
2020     }
2021     if (exists $item->{'timestamp'}) {
2022         delete $item->{'timestamp'};
2023     }
2024 }
2025
2026 =head2 _get_single_item_column
2027
2028   _get_single_item_column($column, $itemnumber);
2029
2030 Retrieves the value of a single column from an C<items>
2031 row specified by C<$itemnumber>.
2032
2033 =cut
2034
2035 sub _get_single_item_column {
2036     my $column = shift;
2037     my $itemnumber = shift;
2038
2039     my $dbh = C4::Context->dbh;
2040     my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
2041     $sth->execute($itemnumber);
2042     my ($value) = $sth->fetchrow();
2043     return $value;
2044 }
2045
2046 =head2 _calc_items_cn_sort
2047
2048   _calc_items_cn_sort($item, $source_values);
2049
2050 Helper routine to calculate C<items.cn_sort>.
2051
2052 =cut
2053
2054 sub _calc_items_cn_sort {
2055     my $item = shift;
2056     my $source_values = shift;
2057
2058     $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
2059 }
2060
2061 =head2 _set_defaults_for_add
2062
2063   _set_defaults_for_add($item_hash);
2064
2065 Given an item hash representing an item to be added, set
2066 correct default values for columns whose default value
2067 is not handled by the DBMS.  This includes the following
2068 columns:
2069
2070 =over 2
2071
2072 =item *
2073
2074 C<items.dateaccessioned>
2075
2076 =item *
2077
2078 C<items.notforloan>
2079
2080 =item *
2081
2082 C<items.damaged>
2083
2084 =item *
2085
2086 C<items.itemlost>
2087
2088 =item *
2089
2090 C<items.withdrawn>
2091
2092 =back
2093
2094 =cut
2095
2096 sub _set_defaults_for_add {
2097     my $item = shift;
2098     $item->{dateaccessioned} ||= C4::Dates->new->output('iso');
2099     $item->{$_} ||= 0 for (qw( notforloan damaged itemlost withdrawn));
2100 }
2101
2102 =head2 _koha_new_item
2103
2104   my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
2105
2106 Perform the actual insert into the C<items> table.
2107
2108 =cut
2109
2110 sub _koha_new_item {
2111     my ( $item, $barcode ) = @_;
2112     my $dbh=C4::Context->dbh;
2113     my $error;
2114     my $query =
2115            "INSERT INTO items SET
2116             biblionumber        = ?,
2117             biblioitemnumber    = ?,
2118             barcode             = ?,
2119             dateaccessioned     = ?,
2120             booksellerid        = ?,
2121             homebranch          = ?,
2122             price               = ?,
2123             replacementprice    = ?,
2124             replacementpricedate = ?,
2125             datelastborrowed    = ?,
2126             datelastseen        = ?,
2127             stack               = ?,
2128             notforloan          = ?,
2129             damaged             = ?,
2130             itemlost            = ?,
2131             withdrawn            = ?,
2132             itemcallnumber      = ?,
2133             coded_location_qualifier = ?,
2134             restricted          = ?,
2135             itemnotes           = ?,
2136             holdingbranch       = ?,
2137             paidfor             = ?,
2138             location            = ?,
2139             permanent_location            = ?,
2140             onloan              = ?,
2141             issues              = ?,
2142             renewals            = ?,
2143             reserves            = ?,
2144             cn_source           = ?,
2145             cn_sort             = ?,
2146             ccode               = ?,
2147             itype               = ?,
2148             materials           = ?,
2149             uri = ?,
2150             enumchron           = ?,
2151             more_subfields_xml  = ?,
2152             copynumber          = ?,
2153             stocknumber         = ?
2154           ";
2155     my $sth = $dbh->prepare($query);
2156     my $today = C4::Dates->today('iso');
2157    $sth->execute(
2158             $item->{'biblionumber'},
2159             $item->{'biblioitemnumber'},
2160             $barcode,
2161             $item->{'dateaccessioned'},
2162             $item->{'booksellerid'},
2163             $item->{'homebranch'},
2164             $item->{'price'},
2165             $item->{'replacementprice'},
2166             $item->{'replacementpricedate'} || $today,
2167             $item->{datelastborrowed},
2168             $item->{datelastseen} || $today,
2169             $item->{stack},
2170             $item->{'notforloan'},
2171             $item->{'damaged'},
2172             $item->{'itemlost'},
2173             $item->{'withdrawn'},
2174             $item->{'itemcallnumber'},
2175             $item->{'coded_location_qualifier'},
2176             $item->{'restricted'},
2177             $item->{'itemnotes'},
2178             $item->{'holdingbranch'},
2179             $item->{'paidfor'},
2180             $item->{'location'},
2181             $item->{'permanent_location'},
2182             $item->{'onloan'},
2183             $item->{'issues'},
2184             $item->{'renewals'},
2185             $item->{'reserves'},
2186             $item->{'items.cn_source'},
2187             $item->{'items.cn_sort'},
2188             $item->{'ccode'},
2189             $item->{'itype'},
2190             $item->{'materials'},
2191             $item->{'uri'},
2192             $item->{'enumchron'},
2193             $item->{'more_subfields_xml'},
2194             $item->{'copynumber'},
2195             $item->{'stocknumber'},
2196     );
2197
2198     my $itemnumber;
2199     if ( defined $sth->errstr ) {
2200         $error.="ERROR in _koha_new_item $query".$sth->errstr;
2201     }
2202     else {
2203         $itemnumber = $dbh->{'mysql_insertid'};
2204     }
2205
2206     return ( $itemnumber, $error );
2207 }
2208
2209 =head2 MoveItemFromBiblio
2210
2211   MoveItemFromBiblio($itenumber, $frombiblio, $tobiblio);
2212
2213 Moves an item from a biblio to another
2214
2215 Returns undef if the move failed or the biblionumber of the destination record otherwise
2216
2217 =cut
2218
2219 sub MoveItemFromBiblio {
2220     my ($itemnumber, $frombiblio, $tobiblio) = @_;
2221     my $dbh = C4::Context->dbh;
2222     my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber = ?");
2223     $sth->execute( $tobiblio );
2224     my ( $tobiblioitem ) = $sth->fetchrow();
2225     $sth = $dbh->prepare("UPDATE items SET biblioitemnumber = ?, biblionumber = ? WHERE itemnumber = ? AND biblionumber = ?");
2226     my $return = $sth->execute($tobiblioitem, $tobiblio, $itemnumber, $frombiblio);
2227     if ($return == 1) {
2228         ModZebra( $tobiblio, "specialUpdate", "biblioserver" );
2229         ModZebra( $frombiblio, "specialUpdate", "biblioserver" );
2230             # Checking if the item we want to move is in an order
2231         require C4::Acquisition;
2232         my $order = C4::Acquisition::GetOrderFromItemnumber($itemnumber);
2233             if ($order) {
2234                     # Replacing the biblionumber within the order if necessary
2235                     $order->{'biblionumber'} = $tobiblio;
2236                 C4::Acquisition::ModOrder($order);
2237             }
2238         return $tobiblio;
2239         }
2240     return;
2241 }
2242
2243 =head2 DelItemCheck
2244
2245    DelItemCheck($dbh, $biblionumber, $itemnumber);
2246
2247 Exported function (core API) for deleting an item record in Koha if there no current issue.
2248
2249 =cut
2250
2251 sub DelItemCheck {
2252     my ( $dbh, $biblionumber, $itemnumber ) = @_;
2253     my $error;
2254
2255         my $countanalytics=GetAnalyticsCount($itemnumber);
2256
2257
2258     # check that there is no issue on this item before deletion.
2259     my $sth = $dbh->prepare(q{
2260         SELECT COUNT(*) FROM issues
2261         WHERE itemnumber = ?
2262     });
2263     $sth->execute($itemnumber);
2264     my ($onloan) = $sth->fetchrow;
2265
2266     my $item = GetItem($itemnumber);
2267
2268     if ($onloan){
2269         $error = "book_on_loan"
2270     }
2271     elsif ( !C4::Context->IsSuperLibrarian()
2272         and C4::Context->preference("IndependentBranches")
2273         and ( C4::Context->userenv->{branch} ne $item->{'homebranch'} ) )
2274     {
2275         $error = "not_same_branch";
2276     }
2277         else{
2278         # check it doesnt have a waiting reserve
2279         $sth = $dbh->prepare(q{
2280             SELECT COUNT(*) FROM reserves
2281             WHERE (found = 'W' OR found = 'T')
2282             AND itemnumber = ?
2283         });
2284         $sth->execute($itemnumber);
2285         my ($reserve) = $sth->fetchrow;
2286         if ($reserve){
2287             $error = "book_reserved";
2288         } elsif ($countanalytics > 0){
2289                 $error = "linked_analytics";
2290         } else {
2291             DelItem($dbh, $biblionumber, $itemnumber);
2292             return 1;
2293         }
2294     }
2295     return $error;
2296 }
2297
2298 =head2 _koha_modify_item
2299
2300   my ($itemnumber,$error) =_koha_modify_item( $item );
2301
2302 Perform the actual update of the C<items> row.  Note that this
2303 routine accepts a hashref specifying the columns to update.
2304
2305 =cut
2306
2307 sub _koha_modify_item {
2308     my ( $item ) = @_;
2309     my $dbh=C4::Context->dbh;
2310     my $error;
2311
2312     my $query = "UPDATE items SET ";
2313     my @bind;
2314     for my $key ( keys %$item ) {
2315         next if ( $key eq 'itemnumber' );
2316         $query.="$key=?,";
2317         push @bind, $item->{$key};
2318     }
2319     $query =~ s/,$//;
2320     $query .= " WHERE itemnumber=?";
2321     push @bind, $item->{'itemnumber'};
2322     my $sth = $dbh->prepare($query);
2323     $sth->execute(@bind);
2324     if ( $sth->err ) {
2325         $error.="ERROR in _koha_modify_item $query: ".$sth->errstr;
2326         warn $error;
2327     }
2328     return ($item->{'itemnumber'},$error);
2329 }
2330
2331 =head2 _koha_delete_item
2332
2333   _koha_delete_item( $dbh, $itemnum );
2334
2335 Internal function to delete an item record from the koha tables
2336
2337 =cut
2338
2339 sub _koha_delete_item {
2340     my ( $dbh, $itemnum ) = @_;
2341
2342     # save the deleted item to deleteditems table
2343     my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
2344     $sth->execute($itemnum);
2345     my $data = $sth->fetchrow_hashref();
2346     my $query = "INSERT INTO deleteditems SET ";
2347     my @bind  = ();
2348     foreach my $key ( keys %$data ) {
2349         next if ( $key eq 'timestamp' ); # timestamp will be set by db
2350         $query .= "$key = ?,";
2351         push( @bind, $data->{$key} );
2352     }
2353     $query =~ s/\,$//;
2354     $sth = $dbh->prepare($query);
2355     $sth->execute(@bind);
2356
2357     # delete from items table
2358     $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
2359     $sth->execute($itemnum);
2360     return;
2361 }
2362
2363 =head2 _marc_from_item_hash
2364
2365   my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
2366
2367 Given an item hash representing a complete item record,
2368 create a C<MARC::Record> object containing an embedded
2369 tag representing that item.
2370
2371 The third, optional parameter C<$unlinked_item_subfields> is
2372 an arrayref of subfields (not mapped to C<items> fields per the
2373 framework) to be added to the MARC representation
2374 of the item.
2375
2376 =cut
2377
2378 sub _marc_from_item_hash {
2379     my $item = shift;
2380     my $frameworkcode = shift;
2381     my $unlinked_item_subfields;
2382     if (@_) {
2383         $unlinked_item_subfields = shift;
2384     }
2385
2386     # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
2387     # Also, don't emit a subfield if the underlying field is blank.
2388     my $mungeditem = { map {  (defined($item->{$_}) and $item->{$_} ne '') ?
2389                                 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
2390                                 : ()  } keys %{ $item } };
2391
2392     my $item_marc = MARC::Record->new();
2393     foreach my $item_field ( keys %{$mungeditem} ) {
2394         my ( $tag, $subfield ) = GetMarcFromKohaField( $item_field, $frameworkcode );
2395         next unless defined $tag and defined $subfield;    # skip if not mapped to MARC field
2396         my @values = split(/\s?\|\s?/, $mungeditem->{$item_field}, -1);
2397         foreach my $value (@values){
2398             if ( my $field = $item_marc->field($tag) ) {
2399                     $field->add_subfields( $subfield => $value );
2400             } else {
2401                 my $add_subfields = [];
2402                 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2403                     $add_subfields = $unlinked_item_subfields;
2404             }
2405             $item_marc->add_fields( $tag, " ", " ", $subfield => $value, @$add_subfields );
2406             }
2407         }
2408     }
2409
2410     return $item_marc;
2411 }
2412
2413 =head2 _repack_item_errors
2414
2415 Add an error message hash generated by C<CheckItemPreSave>
2416 to a list of errors.
2417
2418 =cut
2419
2420 sub _repack_item_errors {
2421     my $item_sequence_num = shift;
2422     my $item_ref = shift;
2423     my $error_ref = shift;
2424
2425     my @repacked_errors = ();
2426
2427     foreach my $error_code (sort keys %{ $error_ref }) {
2428         my $repacked_error = {};
2429         $repacked_error->{'item_sequence'} = $item_sequence_num;
2430         $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
2431         $repacked_error->{'error_code'} = $error_code;
2432         $repacked_error->{'error_information'} = $error_ref->{$error_code};
2433         push @repacked_errors, $repacked_error;
2434     }
2435
2436     return @repacked_errors;
2437 }
2438
2439 =head2 _get_unlinked_item_subfields
2440
2441   my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
2442
2443 =cut
2444
2445 sub _get_unlinked_item_subfields {
2446     my $original_item_marc = shift;
2447     my $frameworkcode = shift;
2448
2449     my $marcstructure = GetMarcStructure(1, $frameworkcode);
2450
2451     # assume that this record has only one field, and that that
2452     # field contains only the item information
2453     my $subfields = [];
2454     my @fields = $original_item_marc->fields();
2455     if ($#fields > -1) {
2456         my $field = $fields[0];
2457             my $tag = $field->tag();
2458         foreach my $subfield ($field->subfields()) {
2459             if (defined $subfield->[1] and
2460                 $subfield->[1] ne '' and
2461                 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
2462                 push @$subfields, $subfield->[0] => $subfield->[1];
2463             }
2464         }
2465     }
2466     return $subfields;
2467 }
2468
2469 =head2 _get_unlinked_subfields_xml
2470
2471   my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
2472
2473 =cut
2474
2475 sub _get_unlinked_subfields_xml {
2476     my $unlinked_item_subfields = shift;
2477
2478     my $xml;
2479     if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2480         my $marc = MARC::Record->new();
2481         # use of tag 999 is arbitrary, and doesn't need to match the item tag
2482         # used in the framework
2483         $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
2484         $marc->encoding("UTF-8");
2485         $xml = $marc->as_xml("USMARC");
2486     }
2487
2488     return $xml;
2489 }
2490
2491 =head2 _parse_unlinked_item_subfields_from_xml
2492
2493   my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2494
2495 =cut
2496
2497 sub  _parse_unlinked_item_subfields_from_xml {
2498     my $xml = shift;
2499     require C4::Charset;
2500     return unless defined $xml and $xml ne "";
2501     my $marc = MARC::Record->new_from_xml(C4::Charset::StripNonXmlChars($xml),'UTF-8');
2502     my $unlinked_subfields = [];
2503     my @fields = $marc->fields();
2504     if ($#fields > -1) {
2505         foreach my $subfield ($fields[0]->subfields()) {
2506             push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2507         }
2508     }
2509     return $unlinked_subfields;
2510 }
2511
2512 =head2 GetAnalyticsCount
2513
2514   $count= &GetAnalyticsCount($itemnumber)
2515
2516 counts Usage of itemnumber in Analytical bibliorecords.
2517
2518 =cut
2519
2520 sub GetAnalyticsCount {
2521     my ($itemnumber) = @_;
2522     require C4::Search;
2523
2524     ### ZOOM search here
2525     my $query;
2526     $query= "hi=".$itemnumber;
2527             my ($err,$res,$result) = C4::Search::SimpleSearch($query,0,10);
2528     return ($result);
2529 }
2530
2531 =head2 GetItemHolds
2532
2533 =over 4
2534 $holds = &GetItemHolds($biblionumber, $itemnumber);
2535
2536 =back
2537
2538 This function return the count of holds with $biblionumber and $itemnumber
2539
2540 =cut
2541
2542 sub GetItemHolds {
2543     my ($biblionumber, $itemnumber) = @_;
2544     my $holds;
2545     my $dbh            = C4::Context->dbh;
2546     my $query          = "SELECT count(*)
2547         FROM  reserves
2548         WHERE biblionumber=? AND itemnumber=?";
2549     my $sth = $dbh->prepare($query);
2550     $sth->execute($biblionumber, $itemnumber);
2551     $holds = $sth->fetchrow;
2552     return $holds;
2553 }
2554
2555 # Return the list of the column names of items table
2556 sub _get_items_columns {
2557     my $dbh = C4::Context->dbh;
2558     my $sth = $dbh->column_info(undef, undef, 'items', '%');
2559     $sth->execute;
2560     my $results = $sth->fetchall_hashref('COLUMN_NAME');
2561     return keys %$results;
2562 }
2563
2564 =head2 SearchItems
2565
2566     my $items = SearchItems($field, $value);
2567
2568 SearchItems will search for items on a specific given field.
2569 For instance you can search all items with a specific stocknumber like this:
2570
2571     my $items = SearchItems('stocknumber', $stocknumber);
2572
2573 =cut
2574
2575 sub SearchItems {
2576     my ($field, $value) = @_;
2577
2578     my $dbh = C4::Context->dbh;
2579     my @columns = _get_items_columns;
2580     my $results = [];
2581     if(0 < grep /^$field$/, @columns) {
2582         my $query = "SELECT $field FROM items WHERE $field = ?";
2583         my $sth = $dbh->prepare( $query );
2584         $sth->execute( $value );
2585         $results = $sth->fetchall_arrayref({});
2586     }
2587     return $results;
2588 }
2589
2590
2591 =head1  OTHER FUNCTIONS
2592
2593 =head2 _find_value
2594
2595   ($indicators, $value) = _find_value($tag, $subfield, $record,$encoding);
2596
2597 Find the given $subfield in the given $tag in the given
2598 MARC::Record $record.  If the subfield is found, returns
2599 the (indicators, value) pair; otherwise, (undef, undef) is
2600 returned.
2601
2602 PROPOSITION :
2603 Such a function is used in addbiblio AND additem and serial-edit and maybe could be used in Authorities.
2604 I suggest we export it from this module.
2605
2606 =cut
2607
2608 sub _find_value {
2609     my ( $tagfield, $insubfield, $record, $encoding ) = @_;
2610     my @result;
2611     my $indicator;
2612     if ( $tagfield < 10 ) {
2613         if ( $record->field($tagfield) ) {
2614             push @result, $record->field($tagfield)->data();
2615         } else {
2616             push @result, "";
2617         }
2618     } else {
2619         foreach my $field ( $record->field($tagfield) ) {
2620             my @subfields = $field->subfields();
2621             foreach my $subfield (@subfields) {
2622                 if ( @$subfield[0] eq $insubfield ) {
2623                     push @result, @$subfield[1];
2624                     $indicator = $field->indicator(1) . $field->indicator(2);
2625                 }
2626             }
2627         }
2628     }
2629     return ( $indicator, @result );
2630 }
2631
2632
2633 =head2 PrepareItemrecordDisplay
2634
2635   PrepareItemrecordDisplay($itemrecord,$bibnum,$itemumber,$frameworkcode);
2636
2637 Returns a hash with all the fields for Display a given item data in a template
2638
2639 The $frameworkcode returns the item for the given frameworkcode, ONLY if bibnum is not provided
2640
2641 =cut
2642
2643 sub PrepareItemrecordDisplay {
2644
2645     my ( $bibnum, $itemnum, $defaultvalues, $frameworkcode ) = @_;
2646
2647     my $dbh = C4::Context->dbh;
2648     $frameworkcode = &GetFrameworkCode($bibnum) if $bibnum;
2649     my ( $itemtagfield, $itemtagsubfield ) = &GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
2650     my $tagslib = &GetMarcStructure( 1, $frameworkcode );
2651
2652     # return nothing if we don't have found an existing framework.
2653     return q{} unless $tagslib;
2654     my $itemrecord;
2655     if ($itemnum) {
2656         $itemrecord = C4::Items::GetMarcItem( $bibnum, $itemnum );
2657     }
2658     my @loop_data;
2659
2660     my $branch_limit = C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
2661     my $query = qq{
2662         SELECT authorised_value,lib FROM authorised_values
2663     };
2664     $query .= qq{
2665         LEFT JOIN authorised_values_branches ON ( id = av_id )
2666     } if $branch_limit;
2667     $query .= qq{
2668         WHERE category = ?
2669     };
2670     $query .= qq{ AND ( branchcode = ? OR branchcode IS NULL )} if $branch_limit;
2671     $query .= qq{ ORDER BY lib};
2672     my $authorised_values_sth = $dbh->prepare( $query );
2673     foreach my $tag ( sort keys %{$tagslib} ) {
2674         my $previous_tag = '';
2675         if ( $tag ne '' ) {
2676
2677             # loop through each subfield
2678             my $cntsubf;
2679             foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
2680                 next if ( subfield_is_koha_internal_p($subfield) );
2681                 next if ( $tagslib->{$tag}->{$subfield}->{'tab'} ne "10" );
2682                 my %subfield_data;
2683                 $subfield_data{tag}           = $tag;
2684                 $subfield_data{subfield}      = $subfield;
2685                 $subfield_data{countsubfield} = $cntsubf++;
2686                 $subfield_data{kohafield}     = $tagslib->{$tag}->{$subfield}->{'kohafield'};
2687                 $subfield_data{id}            = "tag_".$tag."_subfield_".$subfield."_".int(rand(1000000));
2688
2689                 #        $subfield_data{marc_lib}=$tagslib->{$tag}->{$subfield}->{lib};
2690                 $subfield_data{marc_lib}   = $tagslib->{$tag}->{$subfield}->{lib};
2691                 $subfield_data{mandatory}  = $tagslib->{$tag}->{$subfield}->{mandatory};
2692                 $subfield_data{repeatable} = $tagslib->{$tag}->{$subfield}->{repeatable};
2693                 $subfield_data{hidden}     = "display:none"
2694                   if ( ( $tagslib->{$tag}->{$subfield}->{hidden} > 4 )
2695                     || ( $tagslib->{$tag}->{$subfield}->{hidden} < -4 ) );
2696                 my ( $x, $defaultvalue );
2697                 if ($itemrecord) {
2698                     ( $x, $defaultvalue ) = _find_value( $tag, $subfield, $itemrecord );
2699                 }
2700                 $defaultvalue = $tagslib->{$tag}->{$subfield}->{defaultvalue} unless $defaultvalue;
2701                 if ( !defined $defaultvalue ) {
2702                     $defaultvalue = q||;
2703                 } else {
2704                     $defaultvalue =~ s/"/&quot;/g;
2705                 }
2706
2707                 # search for itemcallnumber if applicable
2708                 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.itemcallnumber'
2709                     && C4::Context->preference('itemcallnumber') ) {
2710                     my $CNtag      = substr( C4::Context->preference('itemcallnumber'), 0, 3 );
2711                     my $CNsubfield = substr( C4::Context->preference('itemcallnumber'), 3, 1 );
2712                     if ( $itemrecord and my $field = $itemrecord->field($CNtag) ) {
2713                         $defaultvalue = $field->subfield($CNsubfield);
2714                     }
2715                 }
2716                 if (   $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.itemcallnumber'
2717                     && $defaultvalues
2718                     && $defaultvalues->{'callnumber'} ) {
2719                     if( $itemrecord and $defaultvalues and not $itemrecord->field($subfield) ){
2720                         # if the item record exists, only use default value if the item has no callnumber
2721                         $defaultvalue = $defaultvalues->{callnumber};
2722                     } elsif ( !$itemrecord and $defaultvalues ) {
2723                         # if the item record *doesn't* exists, always use the default value
2724                         $defaultvalue = $defaultvalues->{callnumber};
2725                     }
2726                 }
2727                 if (   ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.holdingbranch' || $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.homebranch' )
2728                     && $defaultvalues
2729                     && $defaultvalues->{'branchcode'} ) {
2730                     if ( $itemrecord and $defaultvalues and not $itemrecord->field($subfield) ) {
2731                         $defaultvalue = $defaultvalues->{branchcode};
2732                     }
2733                 }
2734                 if (   ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.location' )
2735                     && $defaultvalues
2736                     && $defaultvalues->{'location'} ) {
2737
2738                     if ( $itemrecord and $defaultvalues and not $itemrecord->field($subfield) ) {
2739                         # if the item record exists, only use default value if the item has no locationr
2740                         $defaultvalue = $defaultvalues->{location};
2741                     } elsif ( !$itemrecord and $defaultvalues ) {
2742                         # if the item record *doesn't* exists, always use the default value
2743                         $defaultvalue = $defaultvalues->{location};
2744                     }
2745                 }
2746                 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
2747                     my @authorised_values;
2748                     my %authorised_lib;
2749
2750                     # builds list, depending on authorised value...
2751                     #---- branch
2752                     if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
2753                         if (   ( C4::Context->preference("IndependentBranches") )
2754                             && !C4::Context->IsSuperLibrarian() ) {
2755                             my $sth = $dbh->prepare( "SELECT branchcode,branchname FROM branches WHERE branchcode = ? ORDER BY branchname" );
2756                             $sth->execute( C4::Context->userenv->{branch} );
2757                             push @authorised_values, ""
2758                               unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2759                             while ( my ( $branchcode, $branchname ) = $sth->fetchrow_array ) {
2760                                 push @authorised_values, $branchcode;
2761                                 $authorised_lib{$branchcode} = $branchname;
2762                             }
2763                         } else {
2764                             my $sth = $dbh->prepare( "SELECT branchcode,branchname FROM branches ORDER BY branchname" );
2765                             $sth->execute;
2766                             push @authorised_values, ""
2767                               unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2768                             while ( my ( $branchcode, $branchname ) = $sth->fetchrow_array ) {
2769                                 push @authorised_values, $branchcode;
2770                                 $authorised_lib{$branchcode} = $branchname;
2771                             }
2772                         }
2773
2774                         $defaultvalue = C4::Context->userenv ? C4::Context->userenv->{branch} : undef;
2775                         if ( $defaultvalues and $defaultvalues->{branchcode} ) {
2776                             $defaultvalue = $defaultvalues->{branchcode};
2777                         }
2778
2779                         #----- itemtypes
2780                     } elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "itemtypes" ) {
2781                         my $sth = $dbh->prepare( "SELECT itemtype,description FROM itemtypes ORDER BY description" );
2782                         $sth->execute;
2783                         push @authorised_values, ""
2784                           unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2785                         while ( my ( $itemtype, $description ) = $sth->fetchrow_array ) {
2786                             push @authorised_values, $itemtype;
2787                             $authorised_lib{$itemtype} = $description;
2788                         }
2789                         #---- class_sources
2790                     } elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "cn_source" ) {
2791                         push @authorised_values, "" unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2792
2793                         my $class_sources = GetClassSources();
2794                         my $default_source = C4::Context->preference("DefaultClassificationSource");
2795
2796                         foreach my $class_source (sort keys %$class_sources) {
2797                             next unless $class_sources->{$class_source}->{'used'} or
2798                                         ($class_source eq $default_source);
2799                             push @authorised_values, $class_source;
2800                             $authorised_lib{$class_source} = $class_sources->{$class_source}->{'description'};
2801                         }
2802
2803                         $defaultvalue = $default_source;
2804
2805                         #---- "true" authorised value
2806                     } else {
2807                         $authorised_values_sth->execute(
2808                             $tagslib->{$tag}->{$subfield}->{authorised_value},
2809                             $branch_limit ? $branch_limit : ()
2810                         );
2811                         push @authorised_values, ""
2812                           unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2813                         while ( my ( $value, $lib ) = $authorised_values_sth->fetchrow_array ) {
2814                             push @authorised_values, $value;
2815                             $authorised_lib{$value} = $lib;
2816                         }
2817                     }
2818                     $subfield_data{marc_value} = CGI::scrolling_list(
2819                         -name     => 'field_value',
2820                         -values   => \@authorised_values,
2821                         -default  => "$defaultvalue",
2822                         -labels   => \%authorised_lib,
2823                         -size     => 1,
2824                         -tabindex => '',
2825                         -multiple => 0,
2826                     );
2827                 } elsif ( $tagslib->{$tag}->{$subfield}->{value_builder} ) {
2828                         # opening plugin
2829                         my $plugin = C4::Context->intranetdir . "/cataloguing/value_builder/" . $tagslib->{$tag}->{$subfield}->{'value_builder'};
2830                         if (do $plugin) {
2831                             my $extended_param = plugin_parameters( $dbh, undef, $tagslib, $subfield_data{id}, undef );
2832                             my ( $function_name, $javascript ) = plugin_javascript( $dbh, undef, $tagslib, $subfield_data{id}, undef );
2833                             $subfield_data{random}     = int(rand(1000000));    # why do we need 2 different randoms?
2834                             $subfield_data{marc_value} = qq[<input type="text" tabindex="1" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" maxlength="255"
2835                                 onfocus="Focus$function_name($subfield_data{random}, '$subfield_data{id}');"
2836                                  onblur=" Blur$function_name($subfield_data{random}, '$subfield_data{id}');" />
2837                                 <a href="#" class="buttonDot" onclick="Clic$function_name('$subfield_data{id}'); return false;" title="Tag Editor">...</a>
2838                                 $javascript];
2839                         } else {
2840                             warn "Plugin Failed: $plugin";
2841                             $subfield_data{marc_value} = qq(<input type="text" tabindex="1" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" maxlength="255" />); # supply default input form
2842                         }
2843                 }
2844                 elsif ( $tag eq '' ) {       # it's an hidden field
2845                     $subfield_data{marc_value} = qq(<input type="hidden" tabindex="1" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" maxlength="255" value="$defaultvalue" />);
2846                 }
2847                 elsif ( $tagslib->{$tag}->{$subfield}->{'hidden'} ) {   # FIXME: shouldn't input type be "hidden" ?
2848                     $subfield_data{marc_value} = qq(<input type="text" tabindex="1" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" maxlength="255" value="$defaultvalue" />);
2849                 }
2850                 elsif ( length($defaultvalue) > 100
2851                             or (C4::Context->preference("marcflavour") eq "UNIMARC" and
2852                                   300 <= $tag && $tag < 400 && $subfield eq 'a' )
2853                             or (C4::Context->preference("marcflavour") eq "MARC21"  and
2854                                   500 <= $tag && $tag < 600                     )
2855                           ) {
2856                     # oversize field (textarea)
2857                     $subfield_data{marc_value} = qq(<textarea tabindex="1" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" maxlength="255">$defaultvalue</textarea>\n");
2858                 } else {
2859                     $subfield_data{marc_value} = "<input type=\"text\" name=\"field_value\" value=\"$defaultvalue\" size=\"50\" maxlength=\"255\" />";
2860                 }
2861                 push( @loop_data, \%subfield_data );
2862             }
2863         }
2864     }
2865     my $itemnumber;
2866     if ( $itemrecord && $itemrecord->field($itemtagfield) ) {
2867         $itemnumber = $itemrecord->subfield( $itemtagfield, $itemtagsubfield );
2868     }
2869     return {
2870         'itemtagfield'    => $itemtagfield,
2871         'itemtagsubfield' => $itemtagsubfield,
2872         'itemnumber'      => $itemnumber,
2873         'iteminformation' => \@loop_data
2874     };
2875 }
2876
2877 1;