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 $query = '
1149         SELECT *
1150         FROM items
1151         WHERE itemnumber IN (' . join( ',', @itemnumbers ) . ')
1152     ';
1153     return get_infos_of( $query, 'itemnumber' );
1154 }
1155
1156 =head2 GetItemsByBiblioitemnumber
1157
1158   GetItemsByBiblioitemnumber($biblioitemnumber);
1159
1160 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1161 Called by C<C4::XISBN>
1162
1163 =cut
1164
1165 sub GetItemsByBiblioitemnumber {
1166     my ( $bibitem ) = @_;
1167     my $dbh = C4::Context->dbh;
1168     my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1169     # Get all items attached to a biblioitem
1170     my $i = 0;
1171     my @results;
1172     $sth->execute($bibitem) || die $sth->errstr;
1173     while ( my $data = $sth->fetchrow_hashref ) {
1174         # Foreach item, get circulation information
1175         my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1176                                    WHERE itemnumber = ?
1177                                    AND issues.borrowernumber = borrowers.borrowernumber"
1178         );
1179         $sth2->execute( $data->{'itemnumber'} );
1180         if ( my $data2 = $sth2->fetchrow_hashref ) {
1181             # if item is out, set the due date and who it is out too
1182             $data->{'date_due'}   = $data2->{'date_due'};
1183             $data->{'cardnumber'} = $data2->{'cardnumber'};
1184             $data->{'borrowernumber'}   = $data2->{'borrowernumber'};
1185         }
1186         else {
1187             # set date_due to blank, so in the template we check itemlost, and withdrawn
1188             $data->{'date_due'} = '';
1189         }    # else
1190         # Find the last 3 people who borrowed this item.
1191         my $query2 = "SELECT * FROM old_issues, borrowers WHERE itemnumber = ?
1192                       AND old_issues.borrowernumber = borrowers.borrowernumber
1193                       ORDER BY returndate desc,timestamp desc LIMIT 3";
1194         $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1195         $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1196         my $i2 = 0;
1197         while ( my $data2 = $sth2->fetchrow_hashref ) {
1198             $data->{"timestamp$i2"} = $data2->{'timestamp'};
1199             $data->{"card$i2"}      = $data2->{'cardnumber'};
1200             $data->{"borrower$i2"}  = $data2->{'borrowernumber'};
1201             $i2++;
1202         }
1203         push(@results,$data);
1204     }
1205     return (\@results);
1206 }
1207
1208 =head2 GetItemsInfo
1209
1210   @results = GetItemsInfo($biblionumber);
1211
1212 Returns information about items with the given biblionumber.
1213
1214 C<GetItemsInfo> returns a list of references-to-hash. Each element
1215 contains a number of keys. Most of them are attributes from the
1216 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
1217 Koha database. Other keys include:
1218
1219 =over 2
1220
1221 =item C<$data-E<gt>{branchname}>
1222
1223 The name (not the code) of the branch to which the book belongs.
1224
1225 =item C<$data-E<gt>{datelastseen}>
1226
1227 This is simply C<items.datelastseen>, except that while the date is
1228 stored in YYYY-MM-DD format in the database, here it is converted to
1229 DD/MM/YYYY format. A NULL date is returned as C<//>.
1230
1231 =item C<$data-E<gt>{datedue}>
1232
1233 =item C<$data-E<gt>{class}>
1234
1235 This is the concatenation of C<biblioitems.classification>, the book's
1236 Dewey code, and C<biblioitems.subclass>.
1237
1238 =item C<$data-E<gt>{ocount}>
1239
1240 I think this is the number of copies of the book available.
1241
1242 =item C<$data-E<gt>{order}>
1243
1244 If this is set, it is set to C<One Order>.
1245
1246 =back
1247
1248 =cut
1249
1250 sub GetItemsInfo {
1251     my ( $biblionumber ) = @_;
1252     my $dbh   = C4::Context->dbh;
1253     # note biblioitems.* must be avoided to prevent large marc and marcxml fields from killing performance.
1254     my $query = "
1255     SELECT items.*,
1256            biblio.*,
1257            biblioitems.volume,
1258            biblioitems.number,
1259            biblioitems.itemtype,
1260            biblioitems.isbn,
1261            biblioitems.issn,
1262            biblioitems.publicationyear,
1263            biblioitems.publishercode,
1264            biblioitems.volumedate,
1265            biblioitems.volumedesc,
1266            biblioitems.lccn,
1267            biblioitems.url,
1268            items.notforloan as itemnotforloan,
1269            itemtypes.description,
1270            itemtypes.notforloan as notforloan_per_itemtype,
1271            holding.branchurl,
1272            holding.branchname,
1273            holding.opac_info as branch_opac_info
1274      FROM items
1275      LEFT JOIN branches AS holding ON items.holdingbranch = holding.branchcode
1276      LEFT JOIN branches AS home ON items.homebranch=home.branchcode
1277      LEFT JOIN biblio      ON      biblio.biblionumber     = items.biblionumber
1278      LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1279      LEFT JOIN itemtypes   ON   itemtypes.itemtype         = "
1280      . (C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype');
1281     $query .= " WHERE items.biblionumber = ? ORDER BY home.branchname, items.enumchron, LPAD( items.copynumber, 8, '0' ), items.dateaccessioned DESC" ;
1282     my $sth = $dbh->prepare($query);
1283     $sth->execute($biblionumber);
1284     my $i = 0;
1285     my @results;
1286     my $serial;
1287
1288     my $isth    = $dbh->prepare(
1289         "SELECT issues.*,borrowers.cardnumber,borrowers.surname,borrowers.firstname,borrowers.branchcode as bcode
1290         FROM   issues LEFT JOIN borrowers ON issues.borrowernumber=borrowers.borrowernumber
1291         WHERE  itemnumber = ?"
1292        );
1293         my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=? ");
1294         while ( my $data = $sth->fetchrow_hashref ) {
1295         my $datedue = '';
1296         $isth->execute( $data->{'itemnumber'} );
1297         if ( my $idata = $isth->fetchrow_hashref ) {
1298             $data->{borrowernumber} = $idata->{borrowernumber};
1299             $data->{cardnumber}     = $idata->{cardnumber};
1300             $data->{surname}     = $idata->{surname};
1301             $data->{firstname}     = $idata->{firstname};
1302             $data->{lastreneweddate} = $idata->{lastreneweddate};
1303             $datedue                = $idata->{'date_due'};
1304         if (C4::Context->preference("IndependentBranches")){
1305         my $userenv = C4::Context->userenv;
1306         unless ( C4::Context->IsSuperLibrarian() ) {
1307             $data->{'NOTSAMEBRANCH'} = 1 if ($idata->{'bcode'} ne $userenv->{branch});
1308         }
1309         }
1310         }
1311                 if ( $data->{'serial'}) {
1312                         $ssth->execute($data->{'itemnumber'}) ;
1313                         ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
1314                         $serial = 1;
1315         }
1316         #get branch information.....
1317         my $bsth = $dbh->prepare(
1318             "SELECT * FROM branches WHERE branchcode = ?
1319         "
1320         );
1321         $bsth->execute( $data->{'holdingbranch'} );
1322         if ( my $bdata = $bsth->fetchrow_hashref ) {
1323             $data->{'branchname'} = $bdata->{'branchname'};
1324         }
1325         $data->{'datedue'}        = $datedue;
1326
1327         # get notforloan complete status if applicable
1328         if ( my $code = C4::Koha::GetAuthValCode( 'items.notforloan', $data->{frameworkcode} ) ) {
1329             $data->{notforloanvalue}     = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{itemnotforloan} );
1330             $data->{notforloanvalueopac} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{itemnotforloan}, 1 );
1331         }
1332
1333         # get restricted status and description if applicable
1334         if ( my $code = C4::Koha::GetAuthValCode( 'items.restricted', $data->{frameworkcode} ) ) {
1335             $data->{restrictedopac} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{restricted}, 1 );
1336             $data->{restricted}     = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{restricted} );
1337         }
1338
1339         # my stack procedures
1340         if ( my $code = C4::Koha::GetAuthValCode( 'items.stack', $data->{frameworkcode} ) ) {
1341             $data->{stack}          = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{stack} );
1342         }
1343         # Find the last 3 people who borrowed this item.
1344         my $sth2 = $dbh->prepare("SELECT * FROM old_issues,borrowers
1345                                     WHERE itemnumber = ?
1346                                     AND old_issues.borrowernumber = borrowers.borrowernumber
1347                                     ORDER BY returndate DESC
1348                                     LIMIT 3");
1349         $sth2->execute($data->{'itemnumber'});
1350         my $ii = 0;
1351         while (my $data2 = $sth2->fetchrow_hashref()) {
1352             $data->{"timestamp$ii"} = $data2->{'timestamp'} if $data2->{'timestamp'};
1353             $data->{"card$ii"}      = $data2->{'cardnumber'} if $data2->{'cardnumber'};
1354             $data->{"borrower$ii"}  = $data2->{'borrowernumber'} if $data2->{'borrowernumber'};
1355             $ii++;
1356         }
1357
1358         $results[$i] = $data;
1359         $i++;
1360     }
1361         if($serial) {
1362                 return( sort { ($b->{'publisheddate'} || $b->{'enumchron'}) cmp ($a->{'publisheddate'} || $a->{'enumchron'}) } @results );
1363         } else {
1364         return (@results);
1365         }
1366 }
1367
1368 =head2 GetItemsLocationInfo
1369
1370   my @itemlocinfo = GetItemsLocationInfo($biblionumber);
1371
1372 Returns the branch names, shelving location and itemcallnumber for each item attached to the biblio in question
1373
1374 C<GetItemsInfo> returns a list of references-to-hash. Data returned:
1375
1376 =over 2
1377
1378 =item C<$data-E<gt>{homebranch}>
1379
1380 Branch Name of the item's homebranch
1381
1382 =item C<$data-E<gt>{holdingbranch}>
1383
1384 Branch Name of the item's holdingbranch
1385
1386 =item C<$data-E<gt>{location}>
1387
1388 Item's shelving location code
1389
1390 =item C<$data-E<gt>{location_intranet}>
1391
1392 The intranet description for the Shelving Location as set in authorised_values 'LOC'
1393
1394 =item C<$data-E<gt>{location_opac}>
1395
1396 The OPAC description for the Shelving Location as set in authorised_values 'LOC'.  Falls back to intranet description if no OPAC
1397 description is set.
1398
1399 =item C<$data-E<gt>{itemcallnumber}>
1400
1401 Item's itemcallnumber
1402
1403 =item C<$data-E<gt>{cn_sort}>
1404
1405 Item's call number normalized for sorting
1406
1407 =back
1408
1409 =cut
1410
1411 sub GetItemsLocationInfo {
1412         my $biblionumber = shift;
1413         my @results;
1414
1415         my $dbh = C4::Context->dbh;
1416         my $query = "SELECT a.branchname as homebranch, b.branchname as holdingbranch,
1417                             location, itemcallnumber, cn_sort
1418                      FROM items, branches as a, branches as b
1419                      WHERE homebranch = a.branchcode AND holdingbranch = b.branchcode
1420                      AND biblionumber = ?
1421                      ORDER BY cn_sort ASC";
1422         my $sth = $dbh->prepare($query);
1423         $sth->execute($biblionumber);
1424
1425         while ( my $data = $sth->fetchrow_hashref ) {
1426              $data->{location_intranet} = GetKohaAuthorisedValueLib('LOC', $data->{location});
1427              $data->{location_opac}= GetKohaAuthorisedValueLib('LOC', $data->{location}, 1);
1428              push @results, $data;
1429         }
1430         return @results;
1431 }
1432
1433 =head2 GetHostItemsInfo
1434
1435         $hostiteminfo = GetHostItemsInfo($hostfield);
1436         Returns the iteminfo for items linked to records via a host field
1437
1438 =cut
1439
1440 sub GetHostItemsInfo {
1441         my ($record) = @_;
1442         my @returnitemsInfo;
1443
1444         if (C4::Context->preference('marcflavour') eq 'MARC21' ||
1445         C4::Context->preference('marcflavour') eq 'NORMARC'){
1446             foreach my $hostfield ( $record->field('773') ) {
1447                 my $hostbiblionumber = $hostfield->subfield("0");
1448                 my $linkeditemnumber = $hostfield->subfield("9");
1449                 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1450                 foreach my $hostitemInfo (@hostitemInfos){
1451                         if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1452                                 push (@returnitemsInfo,$hostitemInfo);
1453                                 last;
1454                         }
1455                 }
1456             }
1457         } elsif ( C4::Context->preference('marcflavour') eq 'UNIMARC'){
1458             foreach my $hostfield ( $record->field('461') ) {
1459                 my $hostbiblionumber = $hostfield->subfield("0");
1460                 my $linkeditemnumber = $hostfield->subfield("9");
1461                 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1462                 foreach my $hostitemInfo (@hostitemInfos){
1463                         if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1464                                 push (@returnitemsInfo,$hostitemInfo);
1465                                 last;
1466                         }
1467                 }
1468             }
1469         }
1470         return @returnitemsInfo;
1471 }
1472
1473
1474 =head2 GetLastAcquisitions
1475
1476   my $lastacq = GetLastAcquisitions({'branches' => ('branch1','branch2'),
1477                                     'itemtypes' => ('BK','BD')}, 10);
1478
1479 =cut
1480
1481 sub  GetLastAcquisitions {
1482         my ($data,$max) = @_;
1483
1484         my $itemtype = C4::Context->preference('item-level_itypes') ? 'itype' : 'itemtype';
1485
1486         my $number_of_branches = @{$data->{branches}};
1487         my $number_of_itemtypes   = @{$data->{itemtypes}};
1488
1489
1490         my @where = ('WHERE 1 ');
1491         $number_of_branches and push @where
1492            , 'AND holdingbranch IN ('
1493            , join(',', ('?') x $number_of_branches )
1494            , ')'
1495          ;
1496
1497         $number_of_itemtypes and push @where
1498            , "AND $itemtype IN ("
1499            , join(',', ('?') x $number_of_itemtypes )
1500            , ')'
1501          ;
1502
1503         my $query = "SELECT biblio.biblionumber as biblionumber, title, dateaccessioned
1504                                  FROM items RIGHT JOIN biblio ON (items.biblionumber=biblio.biblionumber)
1505                                     RIGHT JOIN biblioitems ON (items.biblioitemnumber=biblioitems.biblioitemnumber)
1506                                     @where
1507                                     GROUP BY biblio.biblionumber
1508                                     ORDER BY dateaccessioned DESC LIMIT $max";
1509
1510         my $dbh = C4::Context->dbh;
1511         my $sth = $dbh->prepare($query);
1512
1513     $sth->execute((@{$data->{branches}}, @{$data->{itemtypes}}));
1514
1515         my @results;
1516         while( my $row = $sth->fetchrow_hashref){
1517                 push @results, {date => $row->{dateaccessioned}
1518                                                 , biblionumber => $row->{biblionumber}
1519                                                 , title => $row->{title}};
1520         }
1521
1522         return @results;
1523 }
1524
1525 =head2 GetItemnumbersForBiblio
1526
1527   my $itemnumbers = GetItemnumbersForBiblio($biblionumber);
1528
1529 Given a single biblionumber, return an arrayref of all the corresponding itemnumbers
1530
1531 =cut
1532
1533 sub GetItemnumbersForBiblio {
1534     my $biblionumber = shift;
1535     my @items;
1536     my $dbh = C4::Context->dbh;
1537     my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber = ?");
1538     $sth->execute($biblionumber);
1539     while (my $result = $sth->fetchrow_hashref) {
1540         push @items, $result->{'itemnumber'};
1541     }
1542     return \@items;
1543 }
1544
1545 =head2 get_itemnumbers_of
1546
1547   my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1548
1549 Given a list of biblionumbers, return the list of corresponding itemnumbers
1550 for each biblionumber.
1551
1552 Return a reference on a hash where keys are biblionumbers and values are
1553 references on array of itemnumbers.
1554
1555 =cut
1556
1557 sub get_itemnumbers_of {
1558     my @biblionumbers = @_;
1559
1560     my $dbh = C4::Context->dbh;
1561
1562     my $query = '
1563         SELECT itemnumber,
1564             biblionumber
1565         FROM items
1566         WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1567     ';
1568     my $sth = $dbh->prepare($query);
1569     $sth->execute(@biblionumbers);
1570
1571     my %itemnumbers_of;
1572
1573     while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1574         push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1575     }
1576
1577     return \%itemnumbers_of;
1578 }
1579
1580 =head2 get_hostitemnumbers_of
1581
1582   my @itemnumbers_of = get_hostitemnumbers_of($biblionumber);
1583
1584 Given a biblionumber, return the list of corresponding itemnumbers that are linked to it via host fields
1585
1586 Return a reference on a hash where key is a biblionumber and values are
1587 references on array of itemnumbers.
1588
1589 =cut
1590
1591
1592 sub get_hostitemnumbers_of {
1593         my ($biblionumber) = @_;
1594         my $marcrecord = GetMarcBiblio($biblionumber);
1595         my (@returnhostitemnumbers,$tag, $biblio_s, $item_s);
1596
1597         my $marcflavor = C4::Context->preference('marcflavour');
1598         if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1599         $tag='773';
1600         $biblio_s='0';
1601         $item_s='9';
1602     } elsif ($marcflavor eq 'UNIMARC') {
1603         $tag='461';
1604         $biblio_s='0';
1605         $item_s='9';
1606     }
1607
1608     foreach my $hostfield ( $marcrecord->field($tag) ) {
1609         my $hostbiblionumber = $hostfield->subfield($biblio_s);
1610         my $linkeditemnumber = $hostfield->subfield($item_s);
1611         my @itemnumbers;
1612         if (my $itemnumbers = get_itemnumbers_of($hostbiblionumber)->{$hostbiblionumber})
1613         {
1614             @itemnumbers = @$itemnumbers;
1615         }
1616         foreach my $itemnumber (@itemnumbers){
1617             if ($itemnumber eq $linkeditemnumber){
1618                 push (@returnhostitemnumbers,$itemnumber);
1619                 last;
1620             }
1621         }
1622     }
1623     return @returnhostitemnumbers;
1624 }
1625
1626
1627 =head2 GetItemnumberFromBarcode
1628
1629   $result = GetItemnumberFromBarcode($barcode);
1630
1631 =cut
1632
1633 sub GetItemnumberFromBarcode {
1634     my ($barcode) = @_;
1635     my $dbh = C4::Context->dbh;
1636
1637     my $rq =
1638       $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1639     $rq->execute($barcode);
1640     my ($result) = $rq->fetchrow;
1641     return ($result);
1642 }
1643
1644 =head2 GetBarcodeFromItemnumber
1645
1646   $result = GetBarcodeFromItemnumber($itemnumber);
1647
1648 =cut
1649
1650 sub GetBarcodeFromItemnumber {
1651     my ($itemnumber) = @_;
1652     my $dbh = C4::Context->dbh;
1653
1654     my $rq =
1655       $dbh->prepare("SELECT barcode FROM items WHERE items.itemnumber=?");
1656     $rq->execute($itemnumber);
1657     my ($result) = $rq->fetchrow;
1658     return ($result);
1659 }
1660
1661 =head2 GetHiddenItemnumbers
1662
1663     my @itemnumbers_to_hide = GetHiddenItemnumbers(@items);
1664
1665 Given a list of items it checks which should be hidden from the OPAC given
1666 the current configuration. Returns a list of itemnumbers corresponding to
1667 those that should be hidden.
1668
1669 =cut
1670
1671 sub GetHiddenItemnumbers {
1672     my (@items) = @_;
1673     my @resultitems;
1674
1675     my $yaml = C4::Context->preference('OpacHiddenItems');
1676     return () if (! $yaml =~ /\S/ );
1677     $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1678     my $hidingrules;
1679     eval {
1680         $hidingrules = YAML::Load($yaml);
1681     };
1682     if ($@) {
1683         warn "Unable to parse OpacHiddenItems syspref : $@";
1684         return ();
1685     }
1686     my $dbh = C4::Context->dbh;
1687
1688     # For each item
1689     foreach my $item (@items) {
1690
1691         # We check each rule
1692         foreach my $field (keys %$hidingrules) {
1693             my $val;
1694             if (exists $item->{$field}) {
1695                 $val = $item->{$field};
1696             }
1697             else {
1698                 my $query = "SELECT $field from items where itemnumber = ?";
1699                 $val = $dbh->selectrow_array($query, undef, $item->{'itemnumber'});
1700             }
1701             $val = '' unless defined $val;
1702
1703             # If the results matches the values in the yaml file
1704             if (any { $val eq $_ } @{$hidingrules->{$field}}) {
1705
1706                 # We add the itemnumber to the list
1707                 push @resultitems, $item->{'itemnumber'};
1708
1709                 # If at least one rule matched for an item, no need to test the others
1710                 last;
1711             }
1712         }
1713     }
1714     return @resultitems;
1715 }
1716
1717 =head3 get_item_authorised_values
1718
1719 find the types and values for all authorised values assigned to this item.
1720
1721 parameters: itemnumber
1722
1723 returns: a hashref malling the authorised value to the value set for this itemnumber
1724
1725     $authorised_values = {
1726              'CCODE'      => undef,
1727              'DAMAGED'    => '0',
1728              'LOC'        => '3',
1729              'LOST'       => '0'
1730              'NOT_LOAN'   => '0',
1731              'RESTRICTED' => undef,
1732              'STACK'      => undef,
1733              'WITHDRAWN'  => '0',
1734              'branches'   => 'CPL',
1735              'cn_source'  => undef,
1736              'itemtypes'  => 'SER',
1737            };
1738
1739 Notes: see C4::Biblio::get_biblio_authorised_values for a similar method at the biblio level.
1740
1741 =cut
1742
1743 sub get_item_authorised_values {
1744     my $itemnumber = shift;
1745
1746     # assume that these entries in the authorised_value table are item level.
1747     my $query = q(SELECT distinct authorised_value, kohafield
1748                     FROM marc_subfield_structure
1749                     WHERE kohafield like 'item%'
1750                       AND authorised_value != '' );
1751
1752     my $itemlevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
1753     my $iteminfo = GetItem( $itemnumber );
1754     # warn( Data::Dumper->Dump( [ $itemlevel_authorised_values ], [ 'itemlevel_authorised_values' ] ) );
1755     my $return;
1756     foreach my $this_authorised_value ( keys %$itemlevel_authorised_values ) {
1757         my $field = $itemlevel_authorised_values->{ $this_authorised_value }->{'kohafield'};
1758         $field =~ s/^items\.//;
1759         if ( exists $iteminfo->{ $field } ) {
1760             $return->{ $this_authorised_value } = $iteminfo->{ $field };
1761         }
1762     }
1763     # warn( Data::Dumper->Dump( [ $return ], [ 'return' ] ) );
1764     return $return;
1765 }
1766
1767 =head3 get_authorised_value_images
1768
1769 find a list of icons that are appropriate for display based on the
1770 authorised values for a biblio.
1771
1772 parameters: listref of authorised values, such as comes from
1773 get_item_authorised_values or
1774 from C4::Biblio::get_biblio_authorised_values
1775
1776 returns: listref of hashrefs for each image. Each hashref looks like this:
1777
1778       { imageurl => '/intranet-tmpl/prog/img/itemtypeimg/npl/WEB.gif',
1779         label    => '',
1780         category => '',
1781         value    => '', }
1782
1783 Notes: Currently, I put on the full path to the images on the staff
1784 side. This should either be configurable or not done at all. Since I
1785 have to deal with 'intranet' or 'opac' in
1786 get_biblio_authorised_values, perhaps I should be passing it in.
1787
1788 =cut
1789
1790 sub get_authorised_value_images {
1791     my $authorised_values = shift;
1792
1793     my @imagelist;
1794
1795     my $authorised_value_list = GetAuthorisedValues();
1796     # warn ( Data::Dumper->Dump( [ $authorised_value_list ], [ 'authorised_value_list' ] ) );
1797     foreach my $this_authorised_value ( @$authorised_value_list ) {
1798         if ( exists $authorised_values->{ $this_authorised_value->{'category'} }
1799              && $authorised_values->{ $this_authorised_value->{'category'} } eq $this_authorised_value->{'authorised_value'} ) {
1800             # warn ( Data::Dumper->Dump( [ $this_authorised_value ], [ 'this_authorised_value' ] ) );
1801             if ( defined $this_authorised_value->{'imageurl'} ) {
1802                 push @imagelist, { imageurl => C4::Koha::getitemtypeimagelocation( 'intranet', $this_authorised_value->{'imageurl'} ),
1803                                    label    => $this_authorised_value->{'lib'},
1804                                    category => $this_authorised_value->{'category'},
1805                                    value    => $this_authorised_value->{'authorised_value'}, };
1806             }
1807         }
1808     }
1809
1810     # warn ( Data::Dumper->Dump( [ \@imagelist ], [ 'imagelist' ] ) );
1811     return \@imagelist;
1812
1813 }
1814
1815 =head1 LIMITED USE FUNCTIONS
1816
1817 The following functions, while part of the public API,
1818 are not exported.  This is generally because they are
1819 meant to be used by only one script for a specific
1820 purpose, and should not be used in any other context
1821 without careful thought.
1822
1823 =cut
1824
1825 =head2 GetMarcItem
1826
1827   my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1828
1829 Returns MARC::Record of the item passed in parameter.
1830 This function is meant for use only in C<cataloguing/additem.pl>,
1831 where it is needed to support that script's MARC-like
1832 editor.
1833
1834 =cut
1835
1836 sub GetMarcItem {
1837     my ( $biblionumber, $itemnumber ) = @_;
1838
1839     # GetMarcItem has been revised so that it does the following:
1840     #  1. Gets the item information from the items table.
1841     #  2. Converts it to a MARC field for storage in the bib record.
1842     #
1843     # The previous behavior was:
1844     #  1. Get the bib record.
1845     #  2. Return the MARC tag corresponding to the item record.
1846     #
1847     # The difference is that one treats the items row as authoritative,
1848     # while the other treats the MARC representation as authoritative
1849     # under certain circumstances.
1850
1851     my $itemrecord = GetItem($itemnumber);
1852
1853     # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1854     # Also, don't emit a subfield if the underlying field is blank.
1855
1856
1857     return Item2Marc($itemrecord,$biblionumber);
1858
1859 }
1860 sub Item2Marc {
1861         my ($itemrecord,$biblionumber)=@_;
1862     my $mungeditem = {
1863         map {
1864             defined($itemrecord->{$_}) && $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : ()
1865         } keys %{ $itemrecord }
1866     };
1867     my $itemmarc = TransformKohaToMarc($mungeditem);
1868     my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",GetFrameworkCode($biblionumber)||'');
1869
1870     my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1871     if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1872                 foreach my $field ($itemmarc->field($itemtag)){
1873             $field->add_subfields(@$unlinked_item_subfields);
1874         }
1875     }
1876         return $itemmarc;
1877 }
1878
1879 =head1 PRIVATE FUNCTIONS AND VARIABLES
1880
1881 The following functions are not meant to be called
1882 directly, but are documented in order to explain
1883 the inner workings of C<C4::Items>.
1884
1885 =cut
1886
1887 =head2 %derived_columns
1888
1889 This hash keeps track of item columns that
1890 are strictly derived from other columns in
1891 the item record and are not meant to be set
1892 independently.
1893
1894 Each key in the hash should be the name of a
1895 column (as named by TransformMarcToKoha).  Each
1896 value should be hashref whose keys are the
1897 columns on which the derived column depends.  The
1898 hashref should also contain a 'BUILDER' key
1899 that is a reference to a sub that calculates
1900 the derived value.
1901
1902 =cut
1903
1904 my %derived_columns = (
1905     'items.cn_sort' => {
1906         'itemcallnumber' => 1,
1907         'items.cn_source' => 1,
1908         'BUILDER' => \&_calc_items_cn_sort,
1909     }
1910 );
1911
1912 =head2 _set_derived_columns_for_add
1913
1914   _set_derived_column_for_add($item);
1915
1916 Given an item hash representing a new item to be added,
1917 calculate any derived columns.  Currently the only
1918 such column is C<items.cn_sort>.
1919
1920 =cut
1921
1922 sub _set_derived_columns_for_add {
1923     my $item = shift;
1924
1925     foreach my $column (keys %derived_columns) {
1926         my $builder = $derived_columns{$column}->{'BUILDER'};
1927         my $source_values = {};
1928         foreach my $source_column (keys %{ $derived_columns{$column} }) {
1929             next if $source_column eq 'BUILDER';
1930             $source_values->{$source_column} = $item->{$source_column};
1931         }
1932         $builder->($item, $source_values);
1933     }
1934 }
1935
1936 =head2 _set_derived_columns_for_mod
1937
1938   _set_derived_column_for_mod($item);
1939
1940 Given an item hash representing a new item to be modified.
1941 calculate any derived columns.  Currently the only
1942 such column is C<items.cn_sort>.
1943
1944 This routine differs from C<_set_derived_columns_for_add>
1945 in that it needs to handle partial item records.  In other
1946 words, the caller of C<ModItem> may have supplied only one
1947 or two columns to be changed, so this function needs to
1948 determine whether any of the columns to be changed affect
1949 any of the derived columns.  Also, if a derived column
1950 depends on more than one column, but the caller is not
1951 changing all of then, this routine retrieves the unchanged
1952 values from the database in order to ensure a correct
1953 calculation.
1954
1955 =cut
1956
1957 sub _set_derived_columns_for_mod {
1958     my $item = shift;
1959
1960     foreach my $column (keys %derived_columns) {
1961         my $builder = $derived_columns{$column}->{'BUILDER'};
1962         my $source_values = {};
1963         my %missing_sources = ();
1964         my $must_recalc = 0;
1965         foreach my $source_column (keys %{ $derived_columns{$column} }) {
1966             next if $source_column eq 'BUILDER';
1967             if (exists $item->{$source_column}) {
1968                 $must_recalc = 1;
1969                 $source_values->{$source_column} = $item->{$source_column};
1970             } else {
1971                 $missing_sources{$source_column} = 1;
1972             }
1973         }
1974         if ($must_recalc) {
1975             foreach my $source_column (keys %missing_sources) {
1976                 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
1977             }
1978             $builder->($item, $source_values);
1979         }
1980     }
1981 }
1982
1983 =head2 _do_column_fixes_for_mod
1984
1985   _do_column_fixes_for_mod($item);
1986
1987 Given an item hashref containing one or more
1988 columns to modify, fix up certain values.
1989 Specifically, set to 0 any passed value
1990 of C<notforloan>, C<damaged>, C<itemlost>, or
1991 C<withdrawn> that is either undefined or
1992 contains the empty string.
1993
1994 =cut
1995
1996 sub _do_column_fixes_for_mod {
1997     my $item = shift;
1998
1999     if (exists $item->{'notforloan'} and
2000         (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
2001         $item->{'notforloan'} = 0;
2002     }
2003     if (exists $item->{'damaged'} and
2004         (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
2005         $item->{'damaged'} = 0;
2006     }
2007     if (exists $item->{'itemlost'} and
2008         (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
2009         $item->{'itemlost'} = 0;
2010     }
2011     if (exists $item->{'withdrawn'} and
2012         (not defined $item->{'withdrawn'} or $item->{'withdrawn'} eq '')) {
2013         $item->{'withdrawn'} = 0;
2014     }
2015     if (exists $item->{'location'} && !exists $item->{'permanent_location'}) {
2016         $item->{'permanent_location'} = $item->{'location'};
2017     }
2018     if (exists $item->{'timestamp'}) {
2019         delete $item->{'timestamp'};
2020     }
2021 }
2022
2023 =head2 _get_single_item_column
2024
2025   _get_single_item_column($column, $itemnumber);
2026
2027 Retrieves the value of a single column from an C<items>
2028 row specified by C<$itemnumber>.
2029
2030 =cut
2031
2032 sub _get_single_item_column {
2033     my $column = shift;
2034     my $itemnumber = shift;
2035
2036     my $dbh = C4::Context->dbh;
2037     my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
2038     $sth->execute($itemnumber);
2039     my ($value) = $sth->fetchrow();
2040     return $value;
2041 }
2042
2043 =head2 _calc_items_cn_sort
2044
2045   _calc_items_cn_sort($item, $source_values);
2046
2047 Helper routine to calculate C<items.cn_sort>.
2048
2049 =cut
2050
2051 sub _calc_items_cn_sort {
2052     my $item = shift;
2053     my $source_values = shift;
2054
2055     $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
2056 }
2057
2058 =head2 _set_defaults_for_add
2059
2060   _set_defaults_for_add($item_hash);
2061
2062 Given an item hash representing an item to be added, set
2063 correct default values for columns whose default value
2064 is not handled by the DBMS.  This includes the following
2065 columns:
2066
2067 =over 2
2068
2069 =item *
2070
2071 C<items.dateaccessioned>
2072
2073 =item *
2074
2075 C<items.notforloan>
2076
2077 =item *
2078
2079 C<items.damaged>
2080
2081 =item *
2082
2083 C<items.itemlost>
2084
2085 =item *
2086
2087 C<items.withdrawn>
2088
2089 =back
2090
2091 =cut
2092
2093 sub _set_defaults_for_add {
2094     my $item = shift;
2095     $item->{dateaccessioned} ||= C4::Dates->new->output('iso');
2096     $item->{$_} ||= 0 for (qw( notforloan damaged itemlost withdrawn));
2097 }
2098
2099 =head2 _koha_new_item
2100
2101   my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
2102
2103 Perform the actual insert into the C<items> table.
2104
2105 =cut
2106
2107 sub _koha_new_item {
2108     my ( $item, $barcode ) = @_;
2109     my $dbh=C4::Context->dbh;
2110     my $error;
2111     my $query =
2112            "INSERT INTO items SET
2113             biblionumber        = ?,
2114             biblioitemnumber    = ?,
2115             barcode             = ?,
2116             dateaccessioned     = ?,
2117             booksellerid        = ?,
2118             homebranch          = ?,
2119             price               = ?,
2120             replacementprice    = ?,
2121             replacementpricedate = ?,
2122             datelastborrowed    = ?,
2123             datelastseen        = ?,
2124             stack               = ?,
2125             notforloan          = ?,
2126             damaged             = ?,
2127             itemlost            = ?,
2128             withdrawn            = ?,
2129             itemcallnumber      = ?,
2130             coded_location_qualifier = ?,
2131             restricted          = ?,
2132             itemnotes           = ?,
2133             holdingbranch       = ?,
2134             paidfor             = ?,
2135             location            = ?,
2136             permanent_location            = ?,
2137             onloan              = ?,
2138             issues              = ?,
2139             renewals            = ?,
2140             reserves            = ?,
2141             cn_source           = ?,
2142             cn_sort             = ?,
2143             ccode               = ?,
2144             itype               = ?,
2145             materials           = ?,
2146             uri = ?,
2147             enumchron           = ?,
2148             more_subfields_xml  = ?,
2149             copynumber          = ?,
2150             stocknumber         = ?
2151           ";
2152     my $sth = $dbh->prepare($query);
2153     my $today = C4::Dates->today('iso');
2154    $sth->execute(
2155             $item->{'biblionumber'},
2156             $item->{'biblioitemnumber'},
2157             $barcode,
2158             $item->{'dateaccessioned'},
2159             $item->{'booksellerid'},
2160             $item->{'homebranch'},
2161             $item->{'price'},
2162             $item->{'replacementprice'},
2163             $item->{'replacementpricedate'} || $today,
2164             $item->{datelastborrowed},
2165             $item->{datelastseen} || $today,
2166             $item->{stack},
2167             $item->{'notforloan'},
2168             $item->{'damaged'},
2169             $item->{'itemlost'},
2170             $item->{'withdrawn'},
2171             $item->{'itemcallnumber'},
2172             $item->{'coded_location_qualifier'},
2173             $item->{'restricted'},
2174             $item->{'itemnotes'},
2175             $item->{'holdingbranch'},
2176             $item->{'paidfor'},
2177             $item->{'location'},
2178             $item->{'permanent_location'},
2179             $item->{'onloan'},
2180             $item->{'issues'},
2181             $item->{'renewals'},
2182             $item->{'reserves'},
2183             $item->{'items.cn_source'},
2184             $item->{'items.cn_sort'},
2185             $item->{'ccode'},
2186             $item->{'itype'},
2187             $item->{'materials'},
2188             $item->{'uri'},
2189             $item->{'enumchron'},
2190             $item->{'more_subfields_xml'},
2191             $item->{'copynumber'},
2192             $item->{'stocknumber'},
2193     );
2194
2195     my $itemnumber;
2196     if ( defined $sth->errstr ) {
2197         $error.="ERROR in _koha_new_item $query".$sth->errstr;
2198     }
2199     else {
2200         $itemnumber = $dbh->{'mysql_insertid'};
2201     }
2202
2203     return ( $itemnumber, $error );
2204 }
2205
2206 =head2 MoveItemFromBiblio
2207
2208   MoveItemFromBiblio($itenumber, $frombiblio, $tobiblio);
2209
2210 Moves an item from a biblio to another
2211
2212 Returns undef if the move failed or the biblionumber of the destination record otherwise
2213
2214 =cut
2215
2216 sub MoveItemFromBiblio {
2217     my ($itemnumber, $frombiblio, $tobiblio) = @_;
2218     my $dbh = C4::Context->dbh;
2219     my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber = ?");
2220     $sth->execute( $tobiblio );
2221     my ( $tobiblioitem ) = $sth->fetchrow();
2222     $sth = $dbh->prepare("UPDATE items SET biblioitemnumber = ?, biblionumber = ? WHERE itemnumber = ? AND biblionumber = ?");
2223     my $return = $sth->execute($tobiblioitem, $tobiblio, $itemnumber, $frombiblio);
2224     if ($return == 1) {
2225         ModZebra( $tobiblio, "specialUpdate", "biblioserver" );
2226         ModZebra( $frombiblio, "specialUpdate", "biblioserver" );
2227             # Checking if the item we want to move is in an order
2228         require C4::Acquisition;
2229         my $order = C4::Acquisition::GetOrderFromItemnumber($itemnumber);
2230             if ($order) {
2231                     # Replacing the biblionumber within the order if necessary
2232                     $order->{'biblionumber'} = $tobiblio;
2233                 C4::Acquisition::ModOrder($order);
2234             }
2235         return $tobiblio;
2236         }
2237     return;
2238 }
2239
2240 =head2 DelItemCheck
2241
2242    DelItemCheck($dbh, $biblionumber, $itemnumber);
2243
2244 Exported function (core API) for deleting an item record in Koha if there no current issue.
2245
2246 =cut
2247
2248 sub DelItemCheck {
2249     my ( $dbh, $biblionumber, $itemnumber ) = @_;
2250     my $error;
2251
2252         my $countanalytics=GetAnalyticsCount($itemnumber);
2253
2254
2255     # check that there is no issue on this item before deletion.
2256     my $sth = $dbh->prepare(q{
2257         SELECT COUNT(*) FROM issues
2258         WHERE itemnumber = ?
2259     });
2260     $sth->execute($itemnumber);
2261     my ($onloan) = $sth->fetchrow;
2262
2263     my $item = GetItem($itemnumber);
2264
2265     if ($onloan){
2266         $error = "book_on_loan"
2267     }
2268     elsif ( !C4::Context->IsSuperLibrarian()
2269         and C4::Context->preference("IndependentBranches")
2270         and ( C4::Context->userenv->{branch} ne $item->{'homebranch'} ) )
2271     {
2272         $error = "not_same_branch";
2273     }
2274         else{
2275         # check it doesnt have a waiting reserve
2276         $sth = $dbh->prepare(q{
2277             SELECT COUNT(*) FROM reserves
2278             WHERE (found = 'W' OR found = 'T')
2279             AND itemnumber = ?
2280         });
2281         $sth->execute($itemnumber);
2282         my ($reserve) = $sth->fetchrow;
2283         if ($reserve){
2284             $error = "book_reserved";
2285         } elsif ($countanalytics > 0){
2286                 $error = "linked_analytics";
2287         } else {
2288             DelItem($dbh, $biblionumber, $itemnumber);
2289             return 1;
2290         }
2291     }
2292     return $error;
2293 }
2294
2295 =head2 _koha_modify_item
2296
2297   my ($itemnumber,$error) =_koha_modify_item( $item );
2298
2299 Perform the actual update of the C<items> row.  Note that this
2300 routine accepts a hashref specifying the columns to update.
2301
2302 =cut
2303
2304 sub _koha_modify_item {
2305     my ( $item ) = @_;
2306     my $dbh=C4::Context->dbh;
2307     my $error;
2308
2309     my $query = "UPDATE items SET ";
2310     my @bind;
2311     for my $key ( keys %$item ) {
2312         next if ( $key eq 'itemnumber' );
2313         $query.="$key=?,";
2314         push @bind, $item->{$key};
2315     }
2316     $query =~ s/,$//;
2317     $query .= " WHERE itemnumber=?";
2318     push @bind, $item->{'itemnumber'};
2319     my $sth = $dbh->prepare($query);
2320     $sth->execute(@bind);
2321     if ( $sth->err ) {
2322         $error.="ERROR in _koha_modify_item $query: ".$sth->errstr;
2323         warn $error;
2324     }
2325     return ($item->{'itemnumber'},$error);
2326 }
2327
2328 =head2 _koha_delete_item
2329
2330   _koha_delete_item( $dbh, $itemnum );
2331
2332 Internal function to delete an item record from the koha tables
2333
2334 =cut
2335
2336 sub _koha_delete_item {
2337     my ( $dbh, $itemnum ) = @_;
2338
2339     # save the deleted item to deleteditems table
2340     my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
2341     $sth->execute($itemnum);
2342     my $data = $sth->fetchrow_hashref();
2343     my $query = "INSERT INTO deleteditems SET ";
2344     my @bind  = ();
2345     foreach my $key ( keys %$data ) {
2346         next if ( $key eq 'timestamp' ); # timestamp will be set by db
2347         $query .= "$key = ?,";
2348         push( @bind, $data->{$key} );
2349     }
2350     $query =~ s/\,$//;
2351     $sth = $dbh->prepare($query);
2352     $sth->execute(@bind);
2353
2354     # delete from items table
2355     $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
2356     $sth->execute($itemnum);
2357     return;
2358 }
2359
2360 =head2 _marc_from_item_hash
2361
2362   my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
2363
2364 Given an item hash representing a complete item record,
2365 create a C<MARC::Record> object containing an embedded
2366 tag representing that item.
2367
2368 The third, optional parameter C<$unlinked_item_subfields> is
2369 an arrayref of subfields (not mapped to C<items> fields per the
2370 framework) to be added to the MARC representation
2371 of the item.
2372
2373 =cut
2374
2375 sub _marc_from_item_hash {
2376     my $item = shift;
2377     my $frameworkcode = shift;
2378     my $unlinked_item_subfields;
2379     if (@_) {
2380         $unlinked_item_subfields = shift;
2381     }
2382
2383     # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
2384     # Also, don't emit a subfield if the underlying field is blank.
2385     my $mungeditem = { map {  (defined($item->{$_}) and $item->{$_} ne '') ?
2386                                 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
2387                                 : ()  } keys %{ $item } };
2388
2389     my $item_marc = MARC::Record->new();
2390     foreach my $item_field ( keys %{$mungeditem} ) {
2391         my ( $tag, $subfield ) = GetMarcFromKohaField( $item_field, $frameworkcode );
2392         next unless defined $tag and defined $subfield;    # skip if not mapped to MARC field
2393         my @values = split(/\s?\|\s?/, $mungeditem->{$item_field}, -1);
2394         foreach my $value (@values){
2395             if ( my $field = $item_marc->field($tag) ) {
2396                     $field->add_subfields( $subfield => $value );
2397             } else {
2398                 my $add_subfields = [];
2399                 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2400                     $add_subfields = $unlinked_item_subfields;
2401             }
2402             $item_marc->add_fields( $tag, " ", " ", $subfield => $value, @$add_subfields );
2403             }
2404         }
2405     }
2406
2407     return $item_marc;
2408 }
2409
2410 =head2 _repack_item_errors
2411
2412 Add an error message hash generated by C<CheckItemPreSave>
2413 to a list of errors.
2414
2415 =cut
2416
2417 sub _repack_item_errors {
2418     my $item_sequence_num = shift;
2419     my $item_ref = shift;
2420     my $error_ref = shift;
2421
2422     my @repacked_errors = ();
2423
2424     foreach my $error_code (sort keys %{ $error_ref }) {
2425         my $repacked_error = {};
2426         $repacked_error->{'item_sequence'} = $item_sequence_num;
2427         $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
2428         $repacked_error->{'error_code'} = $error_code;
2429         $repacked_error->{'error_information'} = $error_ref->{$error_code};
2430         push @repacked_errors, $repacked_error;
2431     }
2432
2433     return @repacked_errors;
2434 }
2435
2436 =head2 _get_unlinked_item_subfields
2437
2438   my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
2439
2440 =cut
2441
2442 sub _get_unlinked_item_subfields {
2443     my $original_item_marc = shift;
2444     my $frameworkcode = shift;
2445
2446     my $marcstructure = GetMarcStructure(1, $frameworkcode);
2447
2448     # assume that this record has only one field, and that that
2449     # field contains only the item information
2450     my $subfields = [];
2451     my @fields = $original_item_marc->fields();
2452     if ($#fields > -1) {
2453         my $field = $fields[0];
2454             my $tag = $field->tag();
2455         foreach my $subfield ($field->subfields()) {
2456             if (defined $subfield->[1] and
2457                 $subfield->[1] ne '' and
2458                 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
2459                 push @$subfields, $subfield->[0] => $subfield->[1];
2460             }
2461         }
2462     }
2463     return $subfields;
2464 }
2465
2466 =head2 _get_unlinked_subfields_xml
2467
2468   my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
2469
2470 =cut
2471
2472 sub _get_unlinked_subfields_xml {
2473     my $unlinked_item_subfields = shift;
2474
2475     my $xml;
2476     if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2477         my $marc = MARC::Record->new();
2478         # use of tag 999 is arbitrary, and doesn't need to match the item tag
2479         # used in the framework
2480         $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
2481         $marc->encoding("UTF-8");
2482         $xml = $marc->as_xml("USMARC");
2483     }
2484
2485     return $xml;
2486 }
2487
2488 =head2 _parse_unlinked_item_subfields_from_xml
2489
2490   my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2491
2492 =cut
2493
2494 sub  _parse_unlinked_item_subfields_from_xml {
2495     my $xml = shift;
2496     require C4::Charset;
2497     return unless defined $xml and $xml ne "";
2498     my $marc = MARC::Record->new_from_xml(C4::Charset::StripNonXmlChars($xml),'UTF-8');
2499     my $unlinked_subfields = [];
2500     my @fields = $marc->fields();
2501     if ($#fields > -1) {
2502         foreach my $subfield ($fields[0]->subfields()) {
2503             push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2504         }
2505     }
2506     return $unlinked_subfields;
2507 }
2508
2509 =head2 GetAnalyticsCount
2510
2511   $count= &GetAnalyticsCount($itemnumber)
2512
2513 counts Usage of itemnumber in Analytical bibliorecords.
2514
2515 =cut
2516
2517 sub GetAnalyticsCount {
2518     my ($itemnumber) = @_;
2519     require C4::Search;
2520
2521     ### ZOOM search here
2522     my $query;
2523     $query= "hi=".$itemnumber;
2524             my ($err,$res,$result) = C4::Search::SimpleSearch($query,0,10);
2525     return ($result);
2526 }
2527
2528 =head2 GetItemHolds
2529
2530 =over 4
2531 $holds = &GetItemHolds($biblionumber, $itemnumber);
2532
2533 =back
2534
2535 This function return the count of holds with $biblionumber and $itemnumber
2536
2537 =cut
2538
2539 sub GetItemHolds {
2540     my ($biblionumber, $itemnumber) = @_;
2541     my $holds;
2542     my $dbh            = C4::Context->dbh;
2543     my $query          = "SELECT count(*)
2544         FROM  reserves
2545         WHERE biblionumber=? AND itemnumber=?";
2546     my $sth = $dbh->prepare($query);
2547     $sth->execute($biblionumber, $itemnumber);
2548     $holds = $sth->fetchrow;
2549     return $holds;
2550 }
2551
2552 # Return the list of the column names of items table
2553 sub _get_items_columns {
2554     my $dbh = C4::Context->dbh;
2555     my $sth = $dbh->column_info(undef, undef, 'items', '%');
2556     $sth->execute;
2557     my $results = $sth->fetchall_hashref('COLUMN_NAME');
2558     return keys %$results;
2559 }
2560
2561 =head2 SearchItems
2562
2563     my $items = SearchItems($field, $value);
2564
2565 SearchItems will search for items on a specific given field.
2566 For instance you can search all items with a specific stocknumber like this:
2567
2568     my $items = SearchItems('stocknumber', $stocknumber);
2569
2570 =cut
2571
2572 sub SearchItems {
2573     my ($field, $value) = @_;
2574
2575     my $dbh = C4::Context->dbh;
2576     my @columns = _get_items_columns;
2577     my $results = [];
2578     if(0 < grep /^$field$/, @columns) {
2579         my $query = "SELECT $field FROM items WHERE $field = ?";
2580         my $sth = $dbh->prepare( $query );
2581         $sth->execute( $value );
2582         $results = $sth->fetchall_arrayref({});
2583     }
2584     return $results;
2585 }
2586
2587
2588 =head1  OTHER FUNCTIONS
2589
2590 =head2 _find_value
2591
2592   ($indicators, $value) = _find_value($tag, $subfield, $record,$encoding);
2593
2594 Find the given $subfield in the given $tag in the given
2595 MARC::Record $record.  If the subfield is found, returns
2596 the (indicators, value) pair; otherwise, (undef, undef) is
2597 returned.
2598
2599 PROPOSITION :
2600 Such a function is used in addbiblio AND additem and serial-edit and maybe could be used in Authorities.
2601 I suggest we export it from this module.
2602
2603 =cut
2604
2605 sub _find_value {
2606     my ( $tagfield, $insubfield, $record, $encoding ) = @_;
2607     my @result;
2608     my $indicator;
2609     if ( $tagfield < 10 ) {
2610         if ( $record->field($tagfield) ) {
2611             push @result, $record->field($tagfield)->data();
2612         } else {
2613             push @result, "";
2614         }
2615     } else {
2616         foreach my $field ( $record->field($tagfield) ) {
2617             my @subfields = $field->subfields();
2618             foreach my $subfield (@subfields) {
2619                 if ( @$subfield[0] eq $insubfield ) {
2620                     push @result, @$subfield[1];
2621                     $indicator = $field->indicator(1) . $field->indicator(2);
2622                 }
2623             }
2624         }
2625     }
2626     return ( $indicator, @result );
2627 }
2628
2629
2630 =head2 PrepareItemrecordDisplay
2631
2632   PrepareItemrecordDisplay($itemrecord,$bibnum,$itemumber,$frameworkcode);
2633
2634 Returns a hash with all the fields for Display a given item data in a template
2635
2636 The $frameworkcode returns the item for the given frameworkcode, ONLY if bibnum is not provided
2637
2638 =cut
2639
2640 sub PrepareItemrecordDisplay {
2641
2642     my ( $bibnum, $itemnum, $defaultvalues, $frameworkcode ) = @_;
2643
2644     my $dbh = C4::Context->dbh;
2645     $frameworkcode = &GetFrameworkCode($bibnum) if $bibnum;
2646     my ( $itemtagfield, $itemtagsubfield ) = &GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
2647     my $tagslib = &GetMarcStructure( 1, $frameworkcode );
2648
2649     # return nothing if we don't have found an existing framework.
2650     return q{} unless $tagslib;
2651     my $itemrecord;
2652     if ($itemnum) {
2653         $itemrecord = C4::Items::GetMarcItem( $bibnum, $itemnum );
2654     }
2655     my @loop_data;
2656
2657     my $branch_limit = C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
2658     my $query = qq{
2659         SELECT authorised_value,lib FROM authorised_values
2660     };
2661     $query .= qq{
2662         LEFT JOIN authorised_values_branches ON ( id = av_id )
2663     } if $branch_limit;
2664     $query .= qq{
2665         WHERE category = ?
2666     };
2667     $query .= qq{ AND ( branchcode = ? OR branchcode IS NULL )} if $branch_limit;
2668     $query .= qq{ ORDER BY lib};
2669     my $authorised_values_sth = $dbh->prepare( $query );
2670     foreach my $tag ( sort keys %{$tagslib} ) {
2671         my $previous_tag = '';
2672         if ( $tag ne '' ) {
2673
2674             # loop through each subfield
2675             my $cntsubf;
2676             foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
2677                 next if ( subfield_is_koha_internal_p($subfield) );
2678                 next if ( $tagslib->{$tag}->{$subfield}->{'tab'} ne "10" );
2679                 my %subfield_data;
2680                 $subfield_data{tag}           = $tag;
2681                 $subfield_data{subfield}      = $subfield;
2682                 $subfield_data{countsubfield} = $cntsubf++;
2683                 $subfield_data{kohafield}     = $tagslib->{$tag}->{$subfield}->{'kohafield'};
2684                 $subfield_data{id}            = "tag_".$tag."_subfield_".$subfield."_".int(rand(1000000));
2685
2686                 #        $subfield_data{marc_lib}=$tagslib->{$tag}->{$subfield}->{lib};
2687                 $subfield_data{marc_lib}   = $tagslib->{$tag}->{$subfield}->{lib};
2688                 $subfield_data{mandatory}  = $tagslib->{$tag}->{$subfield}->{mandatory};
2689                 $subfield_data{repeatable} = $tagslib->{$tag}->{$subfield}->{repeatable};
2690                 $subfield_data{hidden}     = "display:none"
2691                   if ( ( $tagslib->{$tag}->{$subfield}->{hidden} > 4 )
2692                     || ( $tagslib->{$tag}->{$subfield}->{hidden} < -4 ) );
2693                 my ( $x, $defaultvalue );
2694                 if ($itemrecord) {
2695                     ( $x, $defaultvalue ) = _find_value( $tag, $subfield, $itemrecord );
2696                 }
2697                 $defaultvalue = $tagslib->{$tag}->{$subfield}->{defaultvalue} unless $defaultvalue;
2698                 if ( !defined $defaultvalue ) {
2699                     $defaultvalue = q||;
2700                 } else {
2701                     $defaultvalue =~ s/"/&quot;/g;
2702                 }
2703
2704                 # search for itemcallnumber if applicable
2705                 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.itemcallnumber'
2706                     && C4::Context->preference('itemcallnumber') ) {
2707                     my $CNtag      = substr( C4::Context->preference('itemcallnumber'), 0, 3 );
2708                     my $CNsubfield = substr( C4::Context->preference('itemcallnumber'), 3, 1 );
2709                     if ( $itemrecord and my $field = $itemrecord->field($CNtag) ) {
2710                         $defaultvalue = $field->subfield($CNsubfield);
2711                     }
2712                 }
2713                 if (   $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.itemcallnumber'
2714                     && $defaultvalues
2715                     && $defaultvalues->{'callnumber'} ) {
2716                     if( $itemrecord and $defaultvalues and not $itemrecord->field($subfield) ){
2717                         # if the item record exists, only use default value if the item has no callnumber
2718                         $defaultvalue = $defaultvalues->{callnumber};
2719                     } elsif ( !$itemrecord and $defaultvalues ) {
2720                         # if the item record *doesn't* exists, always use the default value
2721                         $defaultvalue = $defaultvalues->{callnumber};
2722                     }
2723                 }
2724                 if (   ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.holdingbranch' || $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.homebranch' )
2725                     && $defaultvalues
2726                     && $defaultvalues->{'branchcode'} ) {
2727                     if ( $itemrecord and $defaultvalues and not $itemrecord->field($subfield) ) {
2728                         $defaultvalue = $defaultvalues->{branchcode};
2729                     }
2730                 }
2731                 if (   ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.location' )
2732                     && $defaultvalues
2733                     && $defaultvalues->{'location'} ) {
2734
2735                     if ( $itemrecord and $defaultvalues and not $itemrecord->field($subfield) ) {
2736                         # if the item record exists, only use default value if the item has no locationr
2737                         $defaultvalue = $defaultvalues->{location};
2738                     } elsif ( !$itemrecord and $defaultvalues ) {
2739                         # if the item record *doesn't* exists, always use the default value
2740                         $defaultvalue = $defaultvalues->{location};
2741                     }
2742                 }
2743                 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
2744                     my @authorised_values;
2745                     my %authorised_lib;
2746
2747                     # builds list, depending on authorised value...
2748                     #---- branch
2749                     if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
2750                         if (   ( C4::Context->preference("IndependentBranches") )
2751                             && !C4::Context->IsSuperLibrarian() ) {
2752                             my $sth = $dbh->prepare( "SELECT branchcode,branchname FROM branches WHERE branchcode = ? ORDER BY branchname" );
2753                             $sth->execute( C4::Context->userenv->{branch} );
2754                             push @authorised_values, ""
2755                               unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2756                             while ( my ( $branchcode, $branchname ) = $sth->fetchrow_array ) {
2757                                 push @authorised_values, $branchcode;
2758                                 $authorised_lib{$branchcode} = $branchname;
2759                             }
2760                         } else {
2761                             my $sth = $dbh->prepare( "SELECT branchcode,branchname FROM branches ORDER BY branchname" );
2762                             $sth->execute;
2763                             push @authorised_values, ""
2764                               unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2765                             while ( my ( $branchcode, $branchname ) = $sth->fetchrow_array ) {
2766                                 push @authorised_values, $branchcode;
2767                                 $authorised_lib{$branchcode} = $branchname;
2768                             }
2769                         }
2770
2771                         $defaultvalue = C4::Context->userenv ? C4::Context->userenv->{branch} : undef;
2772                         if ( $defaultvalues and $defaultvalues->{branchcode} ) {
2773                             $defaultvalue = $defaultvalues->{branchcode};
2774                         }
2775
2776                         #----- itemtypes
2777                     } elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "itemtypes" ) {
2778                         my $sth = $dbh->prepare( "SELECT itemtype,description FROM itemtypes ORDER BY description" );
2779                         $sth->execute;
2780                         push @authorised_values, ""
2781                           unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2782                         while ( my ( $itemtype, $description ) = $sth->fetchrow_array ) {
2783                             push @authorised_values, $itemtype;
2784                             $authorised_lib{$itemtype} = $description;
2785                         }
2786                         #---- class_sources
2787                     } elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "cn_source" ) {
2788                         push @authorised_values, "" unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2789
2790                         my $class_sources = GetClassSources();
2791                         my $default_source = C4::Context->preference("DefaultClassificationSource");
2792
2793                         foreach my $class_source (sort keys %$class_sources) {
2794                             next unless $class_sources->{$class_source}->{'used'} or
2795                                         ($class_source eq $default_source);
2796                             push @authorised_values, $class_source;
2797                             $authorised_lib{$class_source} = $class_sources->{$class_source}->{'description'};
2798                         }
2799
2800                         $defaultvalue = $default_source;
2801
2802                         #---- "true" authorised value
2803                     } else {
2804                         $authorised_values_sth->execute(
2805                             $tagslib->{$tag}->{$subfield}->{authorised_value},
2806                             $branch_limit ? $branch_limit : ()
2807                         );
2808                         push @authorised_values, ""
2809                           unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2810                         while ( my ( $value, $lib ) = $authorised_values_sth->fetchrow_array ) {
2811                             push @authorised_values, $value;
2812                             $authorised_lib{$value} = $lib;
2813                         }
2814                     }
2815                     $subfield_data{marc_value} = CGI::scrolling_list(
2816                         -name     => 'field_value',
2817                         -values   => \@authorised_values,
2818                         -default  => "$defaultvalue",
2819                         -labels   => \%authorised_lib,
2820                         -size     => 1,
2821                         -tabindex => '',
2822                         -multiple => 0,
2823                     );
2824                 } elsif ( $tagslib->{$tag}->{$subfield}->{value_builder} ) {
2825                         # opening plugin
2826                         my $plugin = C4::Context->intranetdir . "/cataloguing/value_builder/" . $tagslib->{$tag}->{$subfield}->{'value_builder'};
2827                         if (do $plugin) {
2828                             my $extended_param = plugin_parameters( $dbh, undef, $tagslib, $subfield_data{id}, undef );
2829                             my ( $function_name, $javascript ) = plugin_javascript( $dbh, undef, $tagslib, $subfield_data{id}, undef );
2830                             $subfield_data{random}     = int(rand(1000000));    # why do we need 2 different randoms?
2831                             $subfield_data{marc_value} = qq[<input type="text" tabindex="1" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" maxlength="255"
2832                                 onfocus="Focus$function_name($subfield_data{random}, '$subfield_data{id}');"
2833                                  onblur=" Blur$function_name($subfield_data{random}, '$subfield_data{id}');" />
2834                                 <a href="#" class="buttonDot" onclick="Clic$function_name('$subfield_data{id}'); return false;" title="Tag Editor">...</a>
2835                                 $javascript];
2836                         } else {
2837                             warn "Plugin Failed: $plugin";
2838                             $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
2839                         }
2840                 }
2841                 elsif ( $tag eq '' ) {       # it's an hidden field
2842                     $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" />);
2843                 }
2844                 elsif ( $tagslib->{$tag}->{$subfield}->{'hidden'} ) {   # FIXME: shouldn't input type be "hidden" ?
2845                     $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" />);
2846                 }
2847                 elsif ( length($defaultvalue) > 100
2848                             or (C4::Context->preference("marcflavour") eq "UNIMARC" and
2849                                   300 <= $tag && $tag < 400 && $subfield eq 'a' )
2850                             or (C4::Context->preference("marcflavour") eq "MARC21"  and
2851                                   500 <= $tag && $tag < 600                     )
2852                           ) {
2853                     # oversize field (textarea)
2854                     $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");
2855                 } else {
2856                     $subfield_data{marc_value} = "<input type=\"text\" name=\"field_value\" value=\"$defaultvalue\" size=\"50\" maxlength=\"255\" />";
2857                 }
2858                 push( @loop_data, \%subfield_data );
2859             }
2860         }
2861     }
2862     my $itemnumber;
2863     if ( $itemrecord && $itemrecord->field($itemtagfield) ) {
2864         $itemnumber = $itemrecord->subfield( $itemtagfield, $itemtagsubfield );
2865     }
2866     return {
2867         'itemtagfield'    => $itemtagfield,
2868         'itemtagsubfield' => $itemtagsubfield,
2869         'itemnumber'      => $itemnumber,
2870         'iteminformation' => \@loop_data
2871     };
2872 }
2873
2874 1;