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