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