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