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