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