C4/Items.pm

   1 package C4::Items;
   2
   3 # Copyright 2007 LibLime, Inc.
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it under the
   8 # terms of the GNU General Public License as published by the Free Software
   9 # Foundation; either version 2 of the License, or (at your option) any later
  10 # version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along with
  17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  18 # Suite 330, Boston, MA  02111-1307 USA
  19
  20 use strict;
  21
  22 use C4::Context;
  23 use C4::Koha;
  24 use C4::Biblio;
  25 use C4::Dates qw/format_date format_date_in_iso/;
  26 use MARC::Record;
  27 use C4::ClassSource;
  28 use C4::Log;
  29 use C4::Branch;
  30 require C4::Reserves;
  31 use C4::Charset;
  32
  33 use vars qw($VERSION @ISA @EXPORT);
  34
  35 BEGIN {
  36     $VERSION = 3.01;
  37
  38         require Exporter;
  39     @ISA = qw( Exporter );
  40
  41     # function exports
  42     @EXPORT = qw(
  43         GetItem
  44         AddItemFromMarc
  45         AddItem
  46         AddItemBatchFromMarc
  47         ModItemFromMarc
  48         ModItem
  49         ModDateLastSeen
  50         ModItemTransfer
  51         DelItem
  52
  53         CheckItemPreSave
  54
  55         GetItemStatus
  56         GetItemLocation
  57         GetLostItems
  58         GetItemsForInventory
  59         GetItemsCount
  60         GetItemInfosOf
  61         GetItemsByBiblioitemnumber
  62         GetItemsInfo
  63         get_itemnumbers_of
  64         GetItemnumberFromBarcode
  65     );
  66 }
  67
  68 =head1 NAME
  69
  70 C4::Items - item management functions
  71
  72 =head1 DESCRIPTION
  73
  74 This module contains an API for manipulating item
  75 records in Koha, and is used by cataloguing, circulation,
  76 acquisitions, and serials management.
  77
  78 A Koha item record is stored in two places: the
  79 items table and embedded in a MARC tag in the XML
  80 version of the associated bib record in C<biblioitems.marcxml>.
  81 This is done to allow the item information to be readily
  82 indexed (e.g., by Zebra), but means that each item
  83 modification transaction must keep the items table
  84 and the MARC XML in sync at all times.
  85
  86 Consequently, all code that creates, modifies, or deletes
  87 item records B<must> use an appropriate function from
  88 C<C4::Items>.  If no existing function is suitable, it is
  89 better to add one to C<C4::Items> than to use add
  90 one-off SQL statements to add or modify items.
  91
  92 The items table will be considered authoritative.  In other
  93 words, if there is ever a discrepancy between the items
  94 table and the MARC XML, the items table should be considered
  95 accurate.
  96
  97 =head1 HISTORICAL NOTE
  98
  99 Most of the functions in C<C4::Items> were originally in
 100 the C<C4::Biblio> module.
 101
 102 =head1 CORE EXPORTED FUNCTIONS
 103
 104 The following functions are meant for use by users
 105 of C<C4::Items>
 106
 107 =cut
 108
 109 =head2 GetItem
 110
 111 =over 4
 112
 113 $item = GetItem($itemnumber,$barcode,$serial);
 114
 115 =back
 116
 117 Return item information, for a given itemnumber or barcode.
 118 The return value is a hashref mapping item column
 119 names to values.  If C<$serial> is true, include serial publication data.
 120
 121 =cut
 122
 123 sub GetItem {
 124     my ($itemnumber,$barcode, $serial) = @_;
 125     my $dbh = C4::Context->dbh;
 126         my $data;
 127     if ($itemnumber) {
 128         my $sth = $dbh->prepare("
 129             SELECT * FROM items
 130             WHERE itemnumber = ?");
 131         $sth->execute($itemnumber);
 132         $data = $sth->fetchrow_hashref;
 133     } else {
 134         my $sth = $dbh->prepare("
 135             SELECT * FROM items
 136             WHERE barcode = ?"
 137             );
 138         $sth->execute($barcode);
 139         $data = $sth->fetchrow_hashref;
 140     }
 141     if ( $serial) {
 142     my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=?");
 143         $ssth->execute($data->{'itemnumber'}) ;
 144         ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
 145                 warn $data->{'serialseq'} , $data->{'publisheddate'};
 146     }
 147         #if we don't have an items.itype, use biblioitems.itemtype.
 148         if( ! $data->{'itype'} ) {
 149                 my $sth = $dbh->prepare("SELECT itemtype FROM biblioitems  WHERE biblionumber = ?");
 150                 $sth->execute($data->{'biblionumber'});
 151                 ($data->{'itype'}) = $sth->fetchrow_array;
 152         }
 153     return $data;
 154 }    # sub GetItem
 155
 156 =head2 AddItemFromMarc
 157
 158 =over 4
 159
 160 my ($biblionumber, $biblioitemnumber, $itemnumber)
 161     = AddItemFromMarc($source_item_marc, $biblionumber);
 162
 163 =back
 164
 165 Given a MARC::Record object containing an embedded item
 166 record and a biblionumber, create a new item record.
 167
 168 =cut
 169
 170 sub AddItemFromMarc {
 171     my ( $source_item_marc, $biblionumber ) = @_;
 172     my $dbh = C4::Context->dbh;
 173
 174     # parse item hash from MARC
 175     my $frameworkcode = GetFrameworkCode( $biblionumber );
 176     my $item = &TransformMarcToKoha( $dbh, $source_item_marc, $frameworkcode );
 177     my $unlinked_item_subfields = _get_unlinked_item_subfields($source_item_marc, $frameworkcode);
 178     return AddItem($item, $biblionumber, $dbh, $frameworkcode, $unlinked_item_subfields);
 179 }
 180
 181 =head2 AddItem
 182
 183 =over 4
 184
 185 my ($biblionumber, $biblioitemnumber, $itemnumber)
 186     = AddItem($item, $biblionumber[, $dbh, $frameworkcode, $unlinked_item_subfields]);
 187
 188 =back
 189
 190 Given a hash containing item column names as keys,
 191 create a new Koha item record.
 192
 193 The first two optional parameters (C<$dbh> and C<$frameworkcode>)
 194 do not need to be supplied for general use; they exist
 195 simply to allow them to be picked up from AddItemFromMarc.
 196
 197 The final optional parameter, C<$unlinked_item_subfields>, contains
 198 an arrayref containing subfields present in the original MARC
 199 representation of the item (e.g., from the item editor) that are
 200 not mapped to C<items> columns directly but should instead
 201 be stored in C<items.more_subfields_xml> and included in
 202 the biblio items tag for display and indexing.
 203
 204 =cut
 205
 206 sub AddItem {
 207     my $item = shift;
 208     my $biblionumber = shift;
 209
 210     my $dbh           = @_ ? shift : C4::Context->dbh;
 211     my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
 212     my $unlinked_item_subfields;
 213     if (@_) {
 214         $unlinked_item_subfields = shift
 215     };
 216
 217     # needs old biblionumber and biblioitemnumber
 218     $item->{'biblionumber'} = $biblionumber;
 219     my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
 220     $sth->execute( $item->{'biblionumber'} );
 221     ($item->{'biblioitemnumber'}) = $sth->fetchrow;
 222
 223     _set_defaults_for_add($item);
 224     _set_derived_columns_for_add($item);
 225     $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
 226     # FIXME - checks here
 227         my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
 228     $item->{'itemnumber'} = $itemnumber;
 229
 230     # create MARC tag representing item and add to bib
 231     my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
 232     _add_item_field_to_biblio($new_item_marc, $item->{'biblionumber'}, $frameworkcode );
 233
 234     logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
 235
 236     return ($item->{biblionumber}, $item->{biblioitemnumber}, $itemnumber);
 237 }
 238
 239 =head2 AddItemBatchFromMarc
 240
 241 =over 4
 242
 243 ($itemnumber_ref, $error_ref) = AddItemBatchFromMarc($record, $biblionumber, $biblioitemnumber, $frameworkcode);
 244
 245 =back
 246
 247 Efficiently create item records from a MARC biblio record with
 248 embedded item fields.  This routine is suitable for batch jobs.
 249
 250 This API assumes that the bib record has already been
 251 saved to the C<biblio> and C<biblioitems> tables.  It does
 252 not expect that C<biblioitems.marc> and C<biblioitems.marcxml>
 253 are populated, but it will do so via a call to ModBibiloMarc.
 254
 255 The goal of this API is to have a similar effect to using AddBiblio
 256 and AddItems in succession, but without inefficient repeated
 257 parsing of the MARC XML bib record.
 258
 259 This function returns an arrayref of new itemsnumbers and an arrayref of item
 260 errors encountered during the processing.  Each entry in the errors
 261 list is a hashref containing the following keys:
 262
 263 =over 2
 264
 265 =item item_sequence
 266
 267 Sequence number of original item tag in the MARC record.
 268
 269 =item item_barcode
 270
 271 Item barcode, provide to assist in the construction of
 272 useful error messages.
 273
 274 =item error_condition
 275
 276 Code representing the error condition.  Can be 'duplicate_barcode',
 277 'invalid_homebranch', or 'invalid_holdingbranch'.
 278
 279 =item error_information
 280
 281 Additional information appropriate to the error condition.
 282
 283 =back
 284
 285 =cut
 286
 287 sub AddItemBatchFromMarc {
 288     my ($record, $biblionumber, $biblioitemnumber, $frameworkcode) = @_;
 289     my $error;
 290     my @itemnumbers = ();
 291     my @errors = ();
 292     my $dbh = C4::Context->dbh;
 293
 294     # loop through the item tags and start creating items
 295     my @bad_item_fields = ();
 296     my ($itemtag, $itemsubfield) = &GetMarcFromKohaField("items.itemnumber",'');
 297     my $item_sequence_num = 0;
 298     ITEMFIELD: foreach my $item_field ($record->field($itemtag)) {
 299         $item_sequence_num++;
 300         # we take the item field and stick it into a new
 301         # MARC record -- this is required so far because (FIXME)
 302         # TransformMarcToKoha requires a MARC::Record, not a MARC::Field
 303         # and there is no TransformMarcFieldToKoha
 304         my $temp_item_marc = MARC::Record->new();
 305         $temp_item_marc->append_fields($item_field);
 306
 307         # add biblionumber and biblioitemnumber
 308         my $item = TransformMarcToKoha( $dbh, $temp_item_marc, $frameworkcode, 'items' );
 309         my $unlinked_item_subfields = _get_unlinked_item_subfields($temp_item_marc, $frameworkcode);
 310         $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
 311         $item->{'biblionumber'} = $biblionumber;
 312         $item->{'biblioitemnumber'} = $biblioitemnumber;
 313
 314         # check for duplicate barcode
 315         my %item_errors = CheckItemPreSave($item);
 316         if (%item_errors) {
 317             push @errors, _repack_item_errors($item_sequence_num, $item, \%item_errors);
 318             push @bad_item_fields, $item_field;
 319             next ITEMFIELD;
 320         }
 321
 322         _set_defaults_for_add($item);
 323         _set_derived_columns_for_add($item);
 324         my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
 325         warn $error if $error;
 326         push @itemnumbers, $itemnumber; # FIXME not checking error
 327         $item->{'itemnumber'} = $itemnumber;
 328
 329         logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
 330
 331         my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
 332         $item_field->replace_with($new_item_marc->field($itemtag));
 333     }
 334
 335     # remove any MARC item fields for rejected items
 336     foreach my $item_field (@bad_item_fields) {
 337         $record->delete_field($item_field);
 338     }
 339
 340     # update the MARC biblio
 341     $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode );
 342
 343     return (\@itemnumbers, \@errors);
 344 }
 345
 346 =head2 ModItemFromMarc
 347
 348 =over 4
 349
 350 ModItemFromMarc($item_marc, $biblionumber, $itemnumber);
 351
 352 =back
 353
 354 This function updates an item record based on a supplied
 355 C<MARC::Record> object containing an embedded item field.
 356 This API is meant for the use of C<additem.pl>; for
 357 other purposes, C<ModItem> should be used.
 358
 359 =cut
 360
 361 sub ModItemFromMarc {
 362     my $item_marc = shift;
 363     my $biblionumber = shift;
 364     my $itemnumber = shift;
 365
 366     my $dbh = C4::Context->dbh;
 367     my $frameworkcode = GetFrameworkCode( $biblionumber );
 368     my $item = &TransformMarcToKoha( $dbh, $item_marc, $frameworkcode );
 369     my $unlinked_item_subfields = _get_unlinked_item_subfields($item_marc, $frameworkcode);
 370
 371     return ModItem($item, $biblionumber, $itemnumber, $dbh, $frameworkcode, $unlinked_item_subfields);
 372 }
 373
 374 =head2 ModItem
 375
 376 =over 4
 377
 378 ModItem({ column => $newvalue }, $biblionumber, $itemnumber[, $original_item_marc]);
 379
 380 =back
 381
 382 Change one or more columns in an item record and update
 383 the MARC representation of the item.
 384
 385 The first argument is a hashref mapping from item column
 386 names to the new values.  The second and third arguments
 387 are the biblionumber and itemnumber, respectively.
 388
 389 The fourth, optional parameter, C<$unlinked_item_subfields>, contains
 390 an arrayref containing subfields present in the original MARC
 391 representation of the item (e.g., from the item editor) that are
 392 not mapped to C<items> columns directly but should instead
 393 be stored in C<items.more_subfields_xml> and included in
 394 the biblio items tag for display and indexing.
 395
 396 If one of the changed columns is used to calculate
 397 the derived value of a column such as C<items.cn_sort>,
 398 this routine will perform the necessary calculation
 399 and set the value.
 400
 401 =cut
 402
 403 sub ModItem {
 404     my $item = shift;
 405     my $biblionumber = shift;
 406     my $itemnumber = shift;
 407
 408     # if $biblionumber is undefined, get it from the current item
 409     unless (defined $biblionumber) {
 410         $biblionumber = _get_single_item_column('biblionumber', $itemnumber);
 411     }
 412
 413     my $dbh           = @_ ? shift : C4::Context->dbh;
 414     my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
 415
 416     my $unlinked_item_subfields;
 417     if (@_) {
 418         $unlinked_item_subfields = shift;
 419         $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
 420     };
 421
 422     $item->{'itemnumber'} = $itemnumber or return undef;
 423     _set_derived_columns_for_mod($item);
 424     _do_column_fixes_for_mod($item);
 425     # FIXME add checks
 426     # duplicate barcode
 427     # attempt to change itemnumber
 428     # attempt to change biblionumber (if we want
 429     # an API to relink an item to a different bib,
 430     # it should be a separate function)
 431
 432     # update items table
 433     _koha_modify_item($item);
 434
 435     # update biblio MARC XML
 436     my $whole_item = GetItem($itemnumber) or die "FAILED GetItem($itemnumber)";
 437
 438     unless (defined $unlinked_item_subfields) {
 439         $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'});
 440     }
 441     my $new_item_marc = _marc_from_item_hash($whole_item, $frameworkcode, $unlinked_item_subfields)
 442         or die "FAILED _marc_from_item_hash($whole_item, $frameworkcode)";
 443
 444     _replace_item_field_in_biblio($new_item_marc, $biblionumber, $itemnumber, $frameworkcode);
 445         ($new_item_marc       eq '0') and die "$new_item_marc is '0', not hashref";  # logaction line would crash anyway
 446     logaction("CATALOGUING", "MODIFY", $itemnumber, $new_item_marc->as_formatted) if C4::Context->preference("CataloguingLog");
 447 }
 448
 449 =head2 ModItemTransfer
 450
 451 =over 4
 452
 453 ModItemTransfer($itenumber, $frombranch, $tobranch);
 454
 455 =back
 456
 457 Marks an item as being transferred from one branch
 458 to another.
 459
 460 =cut
 461
 462 sub ModItemTransfer {
 463     my ( $itemnumber, $frombranch, $tobranch ) = @_;
 464
 465     my $dbh = C4::Context->dbh;
 466
 467     #new entry in branchtransfers....
 468     my $sth = $dbh->prepare(
 469         "INSERT INTO branchtransfers (itemnumber, frombranch, datesent, tobranch)
 470         VALUES (?, ?, NOW(), ?)");
 471     $sth->execute($itemnumber, $frombranch, $tobranch);
 472
 473     ModItem({ holdingbranch => $tobranch }, undef, $itemnumber);
 474     ModDateLastSeen($itemnumber);
 475     return;
 476 }
 477
 478 =head2 ModDateLastSeen
 479
 480 =over 4
 481
 482 ModDateLastSeen($itemnum);
 483
 484 =back
 485
 486 Mark item as seen. Is called when an item is issued, returned or manually marked during inventory/stocktaking.
 487 C<$itemnum> is the item number
 488
 489 =cut
 490
 491 sub ModDateLastSeen {
 492     my ($itemnumber) = @_;
 493
 494     my $today = C4::Dates->new();
 495     ModItem({ itemlost => 0, datelastseen => $today->output("iso") }, undef, $itemnumber);
 496 }
 497
 498 =head2 DelItem
 499
 500 =over 4
 501
 502 DelItem($biblionumber, $itemnumber);
 503
 504 =back
 505
 506 Exported function (core API) for deleting an item record in Koha.
 507
 508 =cut
 509
 510 sub DelItem {
 511     my ( $dbh, $biblionumber, $itemnumber ) = @_;
 512
 513     # FIXME check the item has no current issues
 514
 515     _koha_delete_item( $dbh, $itemnumber );
 516
 517     # get the MARC record
 518     my $record = GetMarcBiblio($biblionumber);
 519     my $frameworkcode = GetFrameworkCode($biblionumber);
 520
 521     # backup the record
 522     my $copy2deleted = $dbh->prepare("UPDATE deleteditems SET marc=? WHERE itemnumber=?");
 523     $copy2deleted->execute( $record->as_usmarc(), $itemnumber );
 524
 525     #search item field code
 526     my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
 527     my @fields = $record->field($itemtag);
 528
 529     # delete the item specified
 530     foreach my $field (@fields) {
 531         if ( $field->subfield($itemsubfield) eq $itemnumber ) {
 532             $record->delete_field($field);
 533         }
 534     }
 535     &ModBiblioMarc( $record, $biblionumber, $frameworkcode );
 536     logaction("CATALOGUING", "DELETE", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
 537 }
 538
 539 =head2 CheckItemPreSave
 540
 541 =over 4
 542
 543     my $item_ref = TransformMarcToKoha($marc, 'items');
 544     # do stuff
 545     my %errors = CheckItemPreSave($item_ref);
 546     if (exists $errors{'duplicate_barcode'}) {
 547         print "item has duplicate barcode: ", $errors{'duplicate_barcode'}, "\n";
 548     } elsif (exists $errors{'invalid_homebranch'}) {
 549         print "item has invalid home branch: ", $errors{'invalid_homebranch'}, "\n";
 550     } elsif (exists $errors{'invalid_holdingbranch'}) {
 551         print "item has invalid holding branch: ", $errors{'invalid_holdingbranch'}, "\n";
 552     } else {
 553         print "item is OK";
 554     }
 555
 556 =back
 557
 558 Given a hashref containing item fields, determine if it can be
 559 inserted or updated in the database.  Specifically, checks for
 560 database integrity issues, and returns a hash containing any
 561 of the following keys, if applicable.
 562
 563 =over 2
 564
 565 =item duplicate_barcode
 566
 567 Barcode, if it duplicates one already found in the database.
 568
 569 =item invalid_homebranch
 570
 571 Home branch, if not defined in branches table.
 572
 573 =item invalid_holdingbranch
 574
 575 Holding branch, if not defined in branches table.
 576
 577 =back
 578
 579 This function does NOT implement any policy-related checks,
 580 e.g., whether current operator is allowed to save an
 581 item that has a given branch code.
 582
 583 =cut
 584
 585 sub CheckItemPreSave {
 586     my $item_ref = shift;
 587
 588     my %errors = ();
 589
 590     # check for duplicate barcode
 591     if (exists $item_ref->{'barcode'} and defined $item_ref->{'barcode'}) {
 592         my $existing_itemnumber = GetItemnumberFromBarcode($item_ref->{'barcode'});
 593         if ($existing_itemnumber) {
 594             if (!exists $item_ref->{'itemnumber'}                       # new item
 595                 or $item_ref->{'itemnumber'} != $existing_itemnumber) { # existing item
 596                 $errors{'duplicate_barcode'} = $item_ref->{'barcode'};
 597             }
 598         }
 599     }
 600
 601     # check for valid home branch
 602     if (exists $item_ref->{'homebranch'} and defined $item_ref->{'homebranch'}) {
 603         my $branch_name = GetBranchName($item_ref->{'homebranch'});
 604         unless (defined $branch_name) {
 605             # relies on fact that branches.branchname is a non-NULL column,
 606             # so GetBranchName returns undef only if branch does not exist
 607             $errors{'invalid_homebranch'} = $item_ref->{'homebranch'};
 608         }
 609     }
 610
 611     # check for valid holding branch
 612     if (exists $item_ref->{'holdingbranch'} and defined $item_ref->{'holdingbranch'}) {
 613         my $branch_name = GetBranchName($item_ref->{'holdingbranch'});
 614         unless (defined $branch_name) {
 615             # relies on fact that branches.branchname is a non-NULL column,
 616             # so GetBranchName returns undef only if branch does not exist
 617             $errors{'invalid_holdingbranch'} = $item_ref->{'holdingbranch'};
 618         }
 619     }
 620
 621     return %errors;
 622
 623 }
 624
 625 =head1 EXPORTED SPECIAL ACCESSOR FUNCTIONS
 626
 627 The following functions provide various ways of
 628 getting an item record, a set of item records, or
 629 lists of authorized values for certain item fields.
 630
 631 Some of the functions in this group are candidates
 632 for refactoring -- for example, some of the code
 633 in C<GetItemsByBiblioitemnumber> and C<GetItemsInfo>
 634 has copy-and-paste work.
 635
 636 =cut
 637
 638 =head2 GetItemStatus
 639
 640 =over 4
 641
 642 $itemstatushash = GetItemStatus($fwkcode);
 643
 644 =back
 645
 646 Returns a list of valid values for the
 647 C<items.notforloan> field.
 648
 649 NOTE: does B<not> return an individual item's
 650 status.
 651
 652 Can be MARC dependant.
 653 fwkcode is optional.
 654 But basically could be can be loan or not
 655 Create a status selector with the following code
 656
 657 =head3 in PERL SCRIPT
 658
 659 =over 4
 660
 661 my $itemstatushash = getitemstatus;
 662 my @itemstatusloop;
 663 foreach my $thisstatus (keys %$itemstatushash) {
 664     my %row =(value => $thisstatus,
 665                 statusname => $itemstatushash->{$thisstatus}->{'statusname'},
 666             );
 667     push @itemstatusloop, \%row;
 668 }
 669 $template->param(statusloop=>\@itemstatusloop);
 670
 671 =back
 672
 673 =head3 in TEMPLATE
 674
 675 =over 4
 676
 677 <select name="statusloop">
 678     <option value="">Default</option>
 679 <!-- TMPL_LOOP name="statusloop" -->
 680     <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="statusname" --></option>
 681 <!-- /TMPL_LOOP -->
 682 </select>
 683
 684 =back
 685
 686 =cut
 687
 688 sub GetItemStatus {
 689
 690     # returns a reference to a hash of references to status...
 691     my ($fwk) = @_;
 692     my %itemstatus;
 693     my $dbh = C4::Context->dbh;
 694     my $sth;
 695     $fwk = '' unless ($fwk);
 696     my ( $tag, $subfield ) =
 697       GetMarcFromKohaField( "items.notforloan", $fwk );
 698     if ( $tag and $subfield ) {
 699         my $sth =
 700           $dbh->prepare(
 701             "SELECT authorised_value
 702             FROM marc_subfield_structure
 703             WHERE tagfield=?
 704                 AND tagsubfield=?
 705                 AND frameworkcode=?
 706             "
 707           );
 708         $sth->execute( $tag, $subfield, $fwk );
 709         if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
 710             my $authvalsth =
 711               $dbh->prepare(
 712                 "SELECT authorised_value,lib
 713                 FROM authorised_values
 714                 WHERE category=?
 715                 ORDER BY lib
 716                 "
 717               );
 718             $authvalsth->execute($authorisedvaluecat);
 719             while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
 720                 $itemstatus{$authorisedvalue} = $lib;
 721             }
 722             $authvalsth->finish;
 723             return \%itemstatus;
 724             exit 1;
 725         }
 726         else {
 727
 728             #No authvalue list
 729             # build default
 730         }
 731         $sth->finish;
 732     }
 733
 734     #No authvalue list
 735     #build default
 736     $itemstatus{"1"} = "Not For Loan";
 737     return \%itemstatus;
 738 }
 739
 740 =head2 GetItemLocation
 741
 742 =over 4
 743
 744 $itemlochash = GetItemLocation($fwk);
 745
 746 =back
 747
 748 Returns a list of valid values for the
 749 C<items.location> field.
 750
 751 NOTE: does B<not> return an individual item's
 752 location.
 753
 754 where fwk stands for an optional framework code.
 755 Create a location selector with the following code
 756
 757 =head3 in PERL SCRIPT
 758
 759 =over 4
 760
 761 my $itemlochash = getitemlocation;
 762 my @itemlocloop;
 763 foreach my $thisloc (keys %$itemlochash) {
 764     my $selected = 1 if $thisbranch eq $branch;
 765     my %row =(locval => $thisloc,
 766                 selected => $selected,
 767                 locname => $itemlochash->{$thisloc},
 768             );
 769     push @itemlocloop, \%row;
 770 }
 771 $template->param(itemlocationloop => \@itemlocloop);
 772
 773 =back
 774
 775 =head3 in TEMPLATE
 776
 777 =over 4
 778
 779 <select name="location">
 780     <option value="">Default</option>
 781 <!-- TMPL_LOOP name="itemlocationloop" -->
 782     <option value="<!-- TMPL_VAR name="locval" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="locname" --></option>
 783 <!-- /TMPL_LOOP -->
 784 </select>
 785
 786 =back
 787
 788 =cut
 789
 790 sub GetItemLocation {
 791
 792     # returns a reference to a hash of references to location...
 793     my ($fwk) = @_;
 794     my %itemlocation;
 795     my $dbh = C4::Context->dbh;
 796     my $sth;
 797     $fwk = '' unless ($fwk);
 798     my ( $tag, $subfield ) =
 799       GetMarcFromKohaField( "items.location", $fwk );
 800     if ( $tag and $subfield ) {
 801         my $sth =
 802           $dbh->prepare(
 803             "SELECT authorised_value
 804             FROM marc_subfield_structure
 805             WHERE tagfield=?
 806                 AND tagsubfield=?
 807                 AND frameworkcode=?"
 808           );
 809         $sth->execute( $tag, $subfield, $fwk );
 810         if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
 811             my $authvalsth =
 812               $dbh->prepare(
 813                 "SELECT authorised_value,lib
 814                 FROM authorised_values
 815                 WHERE category=?
 816                 ORDER BY lib"
 817               );
 818             $authvalsth->execute($authorisedvaluecat);
 819             while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
 820                 $itemlocation{$authorisedvalue} = $lib;
 821             }
 822             $authvalsth->finish;
 823             return \%itemlocation;
 824             exit 1;
 825         }
 826         else {
 827
 828             #No authvalue list
 829             # build default
 830         }
 831         $sth->finish;
 832     }
 833
 834     #No authvalue list
 835     #build default
 836     $itemlocation{"1"} = "Not For Loan";
 837     return \%itemlocation;
 838 }
 839
 840 =head2 GetLostItems
 841
 842 =over 4
 843
 844 $items = GetLostItems($where,$orderby);
 845
 846 =back
 847
 848 This function get the items lost into C<$items>.
 849
 850 =over 2
 851
 852 =item input:
 853 C<$where> is a hashref. it containts a field of the items table as key
 854 and the value to match as value.
 855 C<$orderby> is a field of the items table.
 856
 857 =item return:
 858 C<$items> is a reference to an array full of hasref which keys are items' table column.
 859
 860 =item usage in the perl script:
 861
 862 my %where;
 863 $where{barcode} = 0001548;
 864 my $items = GetLostItems( \%where, "homebranch" );
 865 $template->param(itemsloop => $items);
 866
 867 =back
 868
 869 =cut
 870
 871 sub GetLostItems {
 872     # Getting input args.
 873     my $where   = shift;
 874     my $orderby = shift;
 875     my $dbh     = C4::Context->dbh;
 876
 877     my $query   = "
 878         SELECT *
 879         FROM   items
 880         WHERE  itemlost IS NOT NULL
 881           AND  itemlost <> 0
 882     ";
 883     foreach my $key (keys %$where) {
 884         $query .= " AND " . $key . " LIKE '%" . $where->{$key} . "%'";
 885     }
 886     $query .= " ORDER BY ".$orderby if defined $orderby;
 887
 888     my $sth = $dbh->prepare($query);
 889     $sth->execute;
 890     my @items;
 891     while ( my $row = $sth->fetchrow_hashref ){
 892         push @items, $row;
 893     }
 894     return \@items;
 895 }
 896
 897 =head2 GetItemsForInventory
 898
 899 =over 4
 900
 901 $itemlist = GetItemsForInventory($minlocation,$maxlocation,$datelastseen,$offset,$size)
 902
 903 =back
 904
 905 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
 906
 907 The sub returns a list of hashes, containing itemnumber, author, title, barcode & item callnumber.
 908 It is ordered by callnumber,title.
 909
 910 The minlocation & maxlocation parameters are used to specify a range of item callnumbers
 911 the datelastseen can be used to specify that you want to see items not seen since a past date only.
 912 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
 913
 914 =cut
 915
 916 sub GetItemsForInventory {
 917     my ( $minlocation, $maxlocation,$location, $itemtype, $datelastseen, $branch, $offset, $size ) = @_;
 918     my $dbh = C4::Context->dbh;
 919     my $sth;
 920     if ($datelastseen) {
 921         $datelastseen=format_date_in_iso($datelastseen);
 922         my $query =
 923                 "SELECT itemnumber,barcode,itemcallnumber,title,author,biblio.biblionumber,datelastseen
 924                  FROM items
 925                    LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
 926                    LEFT JOIN biblioitems on items.biblionumber=biblioitems.biblionumber
 927                  WHERE itemcallnumber>= ?
 928                    AND itemcallnumber <=?
 929                    AND (datelastseen< ? OR datelastseen IS NULL)";
 930         $query.= " AND items.location=".$dbh->quote($location) if $location;
 931         $query.= " AND items.homebranch=".$dbh->quote($branch) if $branch;
 932         $query.= " AND biblioitems.itemtype=".$dbh->quote($itemtype) if $itemtype;
 933         $query .= " ORDER BY itemcallnumber,title";
 934         $sth = $dbh->prepare($query);
 935         $sth->execute( $minlocation, $maxlocation, $datelastseen );
 936     }
 937     else {
 938         my $query ="
 939                 SELECT itemnumber,barcode,itemcallnumber,biblio.biblionumber,title,author,datelastseen
 940                 FROM items
 941                     LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
 942                    LEFT JOIN biblioitems on items.biblionumber=biblioitems.biblionumber
 943                 WHERE itemcallnumber>= ?
 944                   AND itemcallnumber <=?";
 945         $query.= " AND items.location=".$dbh->quote($location) if $location;
 946         $query.= " AND items.homebranch=".$dbh->quote($branch) if $branch;
 947         $query.= " AND biblioitems.itemtype=".$dbh->quote($itemtype) if $itemtype;
 948         $query .= " ORDER BY itemcallnumber,title";
 949         $sth = $dbh->prepare($query);
 950         $sth->execute( $minlocation, $maxlocation );
 951     }
 952     my @results;
 953     $size--;
 954     while ( my $row = $sth->fetchrow_hashref ) {
 955         $offset-- if ($offset);
 956         $row->{datelastseen}=format_date($row->{datelastseen});
 957         if ( ( !$offset ) && $size ) {
 958             push @results, $row;
 959             $size--;
 960         }
 961     }
 962     return \@results;
 963 }
 964
 965 =head2 GetItemsCount
 966
 967 =over 4
 968 $count = &GetItemsCount( $biblionumber);
 969
 970 =back
 971
 972 This function return count of item with $biblionumber
 973
 974 =cut
 975
 976 sub GetItemsCount {
 977     my ( $biblionumber ) = @_;
 978     my $dbh = C4::Context->dbh;
 979     my $query = "SELECT count(*)
 980           FROM  items
 981           WHERE biblionumber=?";
 982     my $sth = $dbh->prepare($query);
 983     $sth->execute($biblionumber);
 984     my $count = $sth->fetchrow;
 985     $sth->finish;
 986     return ($count);
 987 }
 988
 989 =head2 GetItemInfosOf
 990
 991 =over 4
 992
 993 GetItemInfosOf(@itemnumbers);
 994
 995 =back
 996
 997 =cut
 998
 999 sub GetItemInfosOf {
1000     my @itemnumbers = @_;
1001
1002     my $query = '
1003         SELECT *
1004         FROM items
1005         WHERE itemnumber IN (' . join( ',', @itemnumbers ) . ')
1006     ';
1007     return get_infos_of( $query, 'itemnumber' );
1008 }
1009
1010 =head2 GetItemsByBiblioitemnumber
1011
1012 =over 4
1013
1014 GetItemsByBiblioitemnumber($biblioitemnumber);
1015
1016 =back
1017
1018 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1019 Called by C<C4::XISBN>
1020
1021 =cut
1022
1023 sub GetItemsByBiblioitemnumber {
1024     my ( $bibitem ) = @_;
1025     my $dbh = C4::Context->dbh;
1026     my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1027     # Get all items attached to a biblioitem
1028     my $i = 0;
1029     my @results;
1030     $sth->execute($bibitem) || die $sth->errstr;
1031     while ( my $data = $sth->fetchrow_hashref ) {
1032         # Foreach item, get circulation information
1033         my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1034                                    WHERE itemnumber = ?
1035                                    AND issues.borrowernumber = borrowers.borrowernumber"
1036         );
1037         $sth2->execute( $data->{'itemnumber'} );
1038         if ( my $data2 = $sth2->fetchrow_hashref ) {
1039             # if item is out, set the due date and who it is out too
1040             $data->{'date_due'}   = $data2->{'date_due'};
1041             $data->{'cardnumber'} = $data2->{'cardnumber'};
1042             $data->{'borrowernumber'}   = $data2->{'borrowernumber'};
1043         }
1044         else {
1045             # set date_due to blank, so in the template we check itemlost, and wthdrawn
1046             $data->{'date_due'} = '';
1047         }    # else
1048         $sth2->finish;
1049         # Find the last 3 people who borrowed this item.
1050         my $query2 = "SELECT * FROM old_issues, borrowers WHERE itemnumber = ?
1051                       AND old_issues.borrowernumber = borrowers.borrowernumber
1052                       ORDER BY returndate desc,timestamp desc LIMIT 3";
1053         $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1054         $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1055         my $i2 = 0;
1056         while ( my $data2 = $sth2->fetchrow_hashref ) {
1057             $data->{"timestamp$i2"} = $data2->{'timestamp'};
1058             $data->{"card$i2"}      = $data2->{'cardnumber'};
1059             $data->{"borrower$i2"}  = $data2->{'borrowernumber'};
1060             $i2++;
1061         }
1062         $sth2->finish;
1063         push(@results,$data);
1064     }
1065     $sth->finish;
1066     return (\@results);
1067 }
1068
1069 =head2 GetItemsInfo
1070
1071 =over 4
1072
1073 @results = GetItemsInfo($biblionumber, $type);
1074
1075 =back
1076
1077 Returns information about books with the given biblionumber.
1078
1079 C<$type> may be either C<intra> or anything else. If it is not set to
1080 C<intra>, then the search will exclude lost, very overdue, and
1081 withdrawn items.
1082
1083 C<GetItemsInfo> returns a list of references-to-hash. Each element
1084 contains a number of keys. Most of them are table items from the
1085 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
1086 Koha database. Other keys include:
1087
1088 =over 2
1089
1090 =item C<$data-E<gt>{branchname}>
1091
1092 The name (not the code) of the branch to which the book belongs.
1093
1094 =item C<$data-E<gt>{datelastseen}>
1095
1096 This is simply C<items.datelastseen>, except that while the date is
1097 stored in YYYY-MM-DD format in the database, here it is converted to
1098 DD/MM/YYYY format. A NULL date is returned as C<//>.
1099
1100 =item C<$data-E<gt>{datedue}>
1101
1102 =item C<$data-E<gt>{class}>
1103
1104 This is the concatenation of C<biblioitems.classification>, the book's
1105 Dewey code, and C<biblioitems.subclass>.
1106
1107 =item C<$data-E<gt>{ocount}>
1108
1109 I think this is the number of copies of the book available.
1110
1111 =item C<$data-E<gt>{order}>
1112
1113 If this is set, it is set to C<One Order>.
1114
1115 =back
1116
1117 =cut
1118
1119 sub GetItemsInfo {
1120     my ( $biblionumber, $type ) = @_;
1121     my $dbh   = C4::Context->dbh;
1122     my $query = "SELECT *,items.notforloan as itemnotforloan
1123                  FROM items
1124                  LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1125                  LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
1126     $query .=  (C4::Context->preference('item-level_itypes')) ?
1127                      " LEFT JOIN itemtypes on items.itype = itemtypes.itemtype "
1128                     : " LEFT JOIN itemtypes on biblioitems.itemtype = itemtypes.itemtype ";
1129     $query .= "WHERE items.biblionumber = ? ORDER BY items.dateaccessioned desc" ;
1130     my $sth = $dbh->prepare($query);
1131     $sth->execute($biblionumber);
1132     my $i = 0;
1133     my @results;
1134     my ( $date_due, $count_reserves, $serial );
1135
1136     my $isth    = $dbh->prepare(
1137         "SELECT issues.*,borrowers.cardnumber,borrowers.surname,borrowers.firstname,borrowers.branchcode as bcode
1138         FROM   issues LEFT JOIN borrowers ON issues.borrowernumber=borrowers.borrowernumber
1139         WHERE  itemnumber = ?"
1140        );
1141         my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=? ");
1142         while ( my $data = $sth->fetchrow_hashref ) {
1143         my $datedue = '';
1144         $isth->execute( $data->{'itemnumber'} );
1145         if ( my $idata = $isth->fetchrow_hashref ) {
1146             $data->{borrowernumber} = $idata->{borrowernumber};
1147             $data->{cardnumber}     = $idata->{cardnumber};
1148             $data->{surname}     = $idata->{surname};
1149             $data->{firstname}     = $idata->{firstname};
1150             $datedue                = $idata->{'date_due'};
1151         if (C4::Context->preference("IndependantBranches")){
1152         my $userenv = C4::Context->userenv;
1153         if ( ($userenv) && ( $userenv->{flags} != 1 ) ) {
1154             $data->{'NOTSAMEBRANCH'} = 1 if ($idata->{'bcode'} ne $userenv->{branch});
1155         }
1156         }
1157         }
1158                 if ( $data->{'serial'}) {
1159                         $ssth->execute($data->{'itemnumber'}) ;
1160                         ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
1161                         $serial = 1;
1162         }
1163                 if ( $datedue eq '' ) {
1164             my ( $restype, $reserves ) =
1165               C4::Reserves::CheckReserves( $data->{'itemnumber'} );
1166             if ($restype) {
1167                 $count_reserves = $restype;
1168             }
1169         }
1170         $isth->finish;
1171         $ssth->finish;
1172         #get branch information.....
1173         my $bsth = $dbh->prepare(
1174             "SELECT * FROM branches WHERE branchcode = ?
1175         "
1176         );
1177         $bsth->execute( $data->{'holdingbranch'} );
1178         if ( my $bdata = $bsth->fetchrow_hashref ) {
1179             $data->{'branchname'} = $bdata->{'branchname'};
1180         }
1181         $data->{'datedue'}        = $datedue;
1182         $data->{'count_reserves'} = $count_reserves;
1183
1184         # get notforloan complete status if applicable
1185         my $sthnflstatus = $dbh->prepare(
1186             'SELECT authorised_value
1187             FROM   marc_subfield_structure
1188             WHERE  kohafield="items.notforloan"
1189         '
1190         );
1191
1192         $sthnflstatus->execute;
1193         my ($authorised_valuecode) = $sthnflstatus->fetchrow;
1194         if ($authorised_valuecode) {
1195             $sthnflstatus = $dbh->prepare(
1196                 "SELECT lib FROM authorised_values
1197                  WHERE  category=?
1198                  AND authorised_value=?"
1199             );
1200             $sthnflstatus->execute( $authorised_valuecode,
1201                 $data->{itemnotforloan} );
1202             my ($lib) = $sthnflstatus->fetchrow;
1203             $data->{notforloanvalue} = $lib;
1204         }
1205
1206         # my stack procedures
1207         my $stackstatus = $dbh->prepare(
1208             'SELECT authorised_value
1209              FROM   marc_subfield_structure
1210              WHERE  kohafield="items.stack"
1211         '
1212         );
1213         $stackstatus->execute;
1214
1215         ($authorised_valuecode) = $stackstatus->fetchrow;
1216         if ($authorised_valuecode) {
1217             $stackstatus = $dbh->prepare(
1218                 "SELECT lib
1219                  FROM   authorised_values
1220                  WHERE  category=?
1221                  AND    authorised_value=?
1222             "
1223             );
1224             $stackstatus->execute( $authorised_valuecode, $data->{stack} );
1225             my ($lib) = $stackstatus->fetchrow;
1226             $data->{stack} = $lib;
1227         }
1228         # Find the last 3 people who borrowed this item.
1229         my $sth2 = $dbh->prepare("SELECT * FROM old_issues,borrowers
1230                                     WHERE itemnumber = ?
1231                                     AND old_issues.borrowernumber = borrowers.borrowernumber
1232                                     LIMIT 3");
1233         $sth2->execute($data->{'itemnumber'});
1234         my $ii = 0;
1235         while (my $data2 = $sth2->fetchrow_hashref()) {
1236             $data->{"timestamp$ii"} = $data2->{'timestamp'} if $data2->{'timestamp'};
1237             $data->{"card$ii"}      = $data2->{'cardnumber'} if $data2->{'cardnumber'};
1238             $data->{"borrower$ii"}  = $data2->{'borrowernumber'} if $data2->{'borrowernumber'};
1239             $ii++;
1240         }
1241
1242         $results[$i] = $data;
1243         $i++;
1244     }
1245     $sth->finish;
1246         if($serial) {
1247                 return( sort { $b->{'publisheddate'} cmp $a->{'publisheddate'} } @results );
1248         } else {
1249         return (@results);
1250         }
1251 }
1252
1253 =head2 get_itemnumbers_of
1254
1255 =over 4
1256
1257 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1258
1259 =back
1260
1261 Given a list of biblionumbers, return the list of corresponding itemnumbers
1262 for each biblionumber.
1263
1264 Return a reference on a hash where keys are biblionumbers and values are
1265 references on array of itemnumbers.
1266
1267 =cut
1268
1269 sub get_itemnumbers_of {
1270     my @biblionumbers = @_;
1271
1272     my $dbh = C4::Context->dbh;
1273
1274     my $query = '
1275         SELECT itemnumber,
1276             biblionumber
1277         FROM items
1278         WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1279     ';
1280     my $sth = $dbh->prepare($query);
1281     $sth->execute(@biblionumbers);
1282
1283     my %itemnumbers_of;
1284
1285     while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1286         push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1287     }
1288
1289     return \%itemnumbers_of;
1290 }
1291
1292 =head2 GetItemnumberFromBarcode
1293
1294 =over 4
1295
1296 $result = GetItemnumberFromBarcode($barcode);
1297
1298 =back
1299
1300 =cut
1301
1302 sub GetItemnumberFromBarcode {
1303     my ($barcode) = @_;
1304     my $dbh = C4::Context->dbh;
1305
1306     my $rq =
1307       $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1308     $rq->execute($barcode);
1309     my ($result) = $rq->fetchrow;
1310     return ($result);
1311 }
1312
1313 =head1 LIMITED USE FUNCTIONS
1314
1315 The following functions, while part of the public API,
1316 are not exported.  This is generally because they are
1317 meant to be used by only one script for a specific
1318 purpose, and should not be used in any other context
1319 without careful thought.
1320
1321 =cut
1322
1323 =head2 GetMarcItem
1324
1325 =over 4
1326
1327 my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1328
1329 =back
1330
1331 Returns MARC::Record of the item passed in parameter.
1332 This function is meant for use only in C<cataloguing/additem.pl>,
1333 where it is needed to support that script's MARC-like
1334 editor.
1335
1336 =cut
1337
1338 sub GetMarcItem {
1339     my ( $biblionumber, $itemnumber ) = @_;
1340
1341     # GetMarcItem has been revised so that it does the following:
1342     #  1. Gets the item information from the items table.
1343     #  2. Converts it to a MARC field for storage in the bib record.
1344     #
1345     # The previous behavior was:
1346     #  1. Get the bib record.
1347     #  2. Return the MARC tag corresponding to the item record.
1348     #
1349     # The difference is that one treats the items row as authoritative,
1350     # while the other treats the MARC representation as authoritative
1351     # under certain circumstances.
1352
1353     my $itemrecord = GetItem($itemnumber);
1354
1355     # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1356     # Also, don't emit a subfield if the underlying field is blank.
1357     my $mungeditem = { map {  $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : ()  } keys %{ $itemrecord } };
1358     my $itemmarc = TransformKohaToMarc($mungeditem);
1359
1360     my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1361     if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1362         my @fields = $itemmarc->fields();
1363         if ($#fields > -1) {
1364             $fields[0]->add_subfields(@$unlinked_item_subfields);
1365         }
1366     }
1367
1368     return $itemmarc;
1369
1370 }
1371
1372 =head1 PRIVATE FUNCTIONS AND VARIABLES
1373
1374 The following functions are not meant to be called
1375 directly, but are documented in order to explain
1376 the inner workings of C<C4::Items>.
1377
1378 =cut
1379
1380 =head2 %derived_columns
1381
1382 This hash keeps track of item columns that
1383 are strictly derived from other columns in
1384 the item record and are not meant to be set
1385 independently.
1386
1387 Each key in the hash should be the name of a
1388 column (as named by TransformMarcToKoha).  Each
1389 value should be hashref whose keys are the
1390 columns on which the derived column depends.  The
1391 hashref should also contain a 'BUILDER' key
1392 that is a reference to a sub that calculates
1393 the derived value.
1394
1395 =cut
1396
1397 my %derived_columns = (
1398     'items.cn_sort' => {
1399         'itemcallnumber' => 1,
1400         'items.cn_source' => 1,
1401         'BUILDER' => \&_calc_items_cn_sort,
1402     }
1403 );
1404
1405 =head2 _set_derived_columns_for_add
1406
1407 =over 4
1408
1409 _set_derived_column_for_add($item);
1410
1411 =back
1412
1413 Given an item hash representing a new item to be added,
1414 calculate any derived columns.  Currently the only
1415 such column is C<items.cn_sort>.
1416
1417 =cut
1418
1419 sub _set_derived_columns_for_add {
1420     my $item = shift;
1421
1422     foreach my $column (keys %derived_columns) {
1423         my $builder = $derived_columns{$column}->{'BUILDER'};
1424         my $source_values = {};
1425         foreach my $source_column (keys %{ $derived_columns{$column} }) {
1426             next if $source_column eq 'BUILDER';
1427             $source_values->{$source_column} = $item->{$source_column};
1428         }
1429         $builder->($item, $source_values);
1430     }
1431 }
1432
1433 =head2 _set_derived_columns_for_mod
1434
1435 =over 4
1436
1437 _set_derived_column_for_mod($item);
1438
1439 =back
1440
1441 Given an item hash representing a new item to be modified.
1442 calculate any derived columns.  Currently the only
1443 such column is C<items.cn_sort>.
1444
1445 This routine differs from C<_set_derived_columns_for_add>
1446 in that it needs to handle partial item records.  In other
1447 words, the caller of C<ModItem> may have supplied only one
1448 or two columns to be changed, so this function needs to
1449 determine whether any of the columns to be changed affect
1450 any of the derived columns.  Also, if a derived column
1451 depends on more than one column, but the caller is not
1452 changing all of then, this routine retrieves the unchanged
1453 values from the database in order to ensure a correct
1454 calculation.
1455
1456 =cut
1457
1458 sub _set_derived_columns_for_mod {
1459     my $item = shift;
1460
1461     foreach my $column (keys %derived_columns) {
1462         my $builder = $derived_columns{$column}->{'BUILDER'};
1463         my $source_values = {};
1464         my %missing_sources = ();
1465         my $must_recalc = 0;
1466         foreach my $source_column (keys %{ $derived_columns{$column} }) {
1467             next if $source_column eq 'BUILDER';
1468             if (exists $item->{$source_column}) {
1469                 $must_recalc = 1;
1470                 $source_values->{$source_column} = $item->{$source_column};
1471             } else {
1472                 $missing_sources{$source_column} = 1;
1473             }
1474         }
1475         if ($must_recalc) {
1476             foreach my $source_column (keys %missing_sources) {
1477                 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
1478             }
1479             $builder->($item, $source_values);
1480         }
1481     }
1482 }
1483
1484 =head2 _do_column_fixes_for_mod
1485
1486 =over 4
1487
1488 _do_column_fixes_for_mod($item);
1489
1490 =back
1491
1492 Given an item hashref containing one or more
1493 columns to modify, fix up certain values.
1494 Specifically, set to 0 any passed value
1495 of C<notforloan>, C<damaged>, C<itemlost>, or
1496 C<wthdrawn> that is either undefined or
1497 contains the empty string.
1498
1499 =cut
1500
1501 sub _do_column_fixes_for_mod {
1502     my $item = shift;
1503
1504     if (exists $item->{'notforloan'} and
1505         (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
1506         $item->{'notforloan'} = 0;
1507     }
1508     if (exists $item->{'damaged'} and
1509         (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
1510         $item->{'damaged'} = 0;
1511     }
1512     if (exists $item->{'itemlost'} and
1513         (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
1514         $item->{'itemlost'} = 0;
1515     }
1516     if (exists $item->{'wthdrawn'} and
1517         (not defined $item->{'wthdrawn'} or $item->{'wthdrawn'} eq '')) {
1518         $item->{'wthdrawn'} = 0;
1519     }
1520 }
1521
1522 =head2 _get_single_item_column
1523
1524 =over 4
1525
1526 _get_single_item_column($column, $itemnumber);
1527
1528 =back
1529
1530 Retrieves the value of a single column from an C<items>
1531 row specified by C<$itemnumber>.
1532
1533 =cut
1534
1535 sub _get_single_item_column {
1536     my $column = shift;
1537     my $itemnumber = shift;
1538
1539     my $dbh = C4::Context->dbh;
1540     my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
1541     $sth->execute($itemnumber);
1542     my ($value) = $sth->fetchrow();
1543     return $value;
1544 }
1545
1546 =head2 _calc_items_cn_sort
1547
1548 =over 4
1549
1550 _calc_items_cn_sort($item, $source_values);
1551
1552 =back
1553
1554 Helper routine to calculate C<items.cn_sort>.
1555
1556 =cut
1557
1558 sub _calc_items_cn_sort {
1559     my $item = shift;
1560     my $source_values = shift;
1561
1562     $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
1563 }
1564
1565 =head2 _set_defaults_for_add
1566
1567 =over 4
1568
1569 _set_defaults_for_add($item_hash);
1570
1571 =back
1572
1573 Given an item hash representing an item to be added, set
1574 correct default values for columns whose default value
1575 is not handled by the DBMS.  This includes the following
1576 columns:
1577
1578 =over 2
1579
1580 =item *
1581
1582 C<items.dateaccessioned>
1583
1584 =item *
1585
1586 C<items.notforloan>
1587
1588 =item *
1589
1590 C<items.damaged>
1591
1592 =item *
1593
1594 C<items.itemlost>
1595
1596 =item *
1597
1598 C<items.wthdrawn>
1599
1600 =back
1601
1602 =cut
1603
1604 sub _set_defaults_for_add {
1605     my $item = shift;
1606
1607     # if dateaccessioned is provided, use it. Otherwise, set to NOW()
1608     if (!(exists $item->{'dateaccessioned'}) ||
1609          ($item->{'dateaccessioned'} eq '')) {
1610         # FIXME add check for invalid date
1611         my $today = C4::Dates->new();
1612         $item->{'dateaccessioned'} =  $today->output("iso"); #TODO: check time issues
1613     }
1614
1615     # various item status fields cannot be null
1616     $item->{'notforloan'} = 0 unless exists $item->{'notforloan'} and defined $item->{'notforloan'} and $item->{'notforloan'} ne '';
1617     $item->{'damaged'}    = 0 unless exists $item->{'damaged'}    and defined $item->{'damaged'}    and $item->{'damaged'} ne '';
1618     $item->{'itemlost'}   = 0 unless exists $item->{'itemlost'}   and defined $item->{'itemlost'}   and $item->{'itemlost'} ne '';
1619     $item->{'wthdrawn'}   = 0 unless exists $item->{'wthdrawn'}   and defined $item->{'wthdrawn'}   and $item->{'wthdrawn'} ne '';
1620 }
1621
1622 =head2 _koha_new_item
1623
1624 =over 4
1625
1626 my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
1627
1628 =back
1629
1630 Perform the actual insert into the C<items> table.
1631
1632 =cut
1633
1634 sub _koha_new_item {
1635     my ( $item, $barcode ) = @_;
1636     my $dbh=C4::Context->dbh;
1637     my $error;
1638     my $query =
1639            "INSERT INTO items SET
1640             biblionumber        = ?,
1641             biblioitemnumber    = ?,
1642             barcode             = ?,
1643             dateaccessioned     = ?,
1644             booksellerid        = ?,
1645             homebranch          = ?,
1646             price               = ?,
1647             replacementprice    = ?,
1648             replacementpricedate = NOW(),
1649             datelastborrowed    = ?,
1650             datelastseen        = NOW(),
1651             stack               = ?,
1652             notforloan          = ?,
1653             damaged             = ?,
1654             itemlost            = ?,
1655             wthdrawn            = ?,
1656             itemcallnumber      = ?,
1657             restricted          = ?,
1658             itemnotes           = ?,
1659             holdingbranch       = ?,
1660             paidfor             = ?,
1661             location            = ?,
1662             onloan              = ?,
1663             issues              = ?,
1664             renewals            = ?,
1665             reserves            = ?,
1666             cn_source           = ?,
1667             cn_sort             = ?,
1668             ccode               = ?,
1669             itype               = ?,
1670             materials           = ?,
1671                         uri                 = ?,
1672             more_subfields_xml  = ?
1673           ";
1674     my $sth = $dbh->prepare($query);
1675    $sth->execute(
1676             $item->{'biblionumber'},
1677             $item->{'biblioitemnumber'},
1678             $barcode,
1679             $item->{'dateaccessioned'},
1680             $item->{'booksellerid'},
1681             $item->{'homebranch'},
1682             $item->{'price'},
1683             $item->{'replacementprice'},
1684             $item->{datelastborrowed},
1685             $item->{stack},
1686             $item->{'notforloan'},
1687             $item->{'damaged'},
1688             $item->{'itemlost'},
1689             $item->{'wthdrawn'},
1690             $item->{'itemcallnumber'},
1691             $item->{'restricted'},
1692             $item->{'itemnotes'},
1693             $item->{'holdingbranch'},
1694             $item->{'paidfor'},
1695             $item->{'location'},
1696             $item->{'onloan'},
1697             $item->{'issues'},
1698             $item->{'renewals'},
1699             $item->{'reserves'},
1700             $item->{'items.cn_source'},
1701             $item->{'items.cn_sort'},
1702             $item->{'ccode'},
1703             $item->{'itype'},
1704             $item->{'materials'},
1705             $item->{'uri'},
1706             $item->{'more_subfields_xml'},
1707     );
1708     my $itemnumber = $dbh->{'mysql_insertid'};
1709     if ( defined $sth->errstr ) {
1710         $error.="ERROR in _koha_new_item $query".$sth->errstr;
1711     }
1712     $sth->finish();
1713     return ( $itemnumber, $error );
1714 }
1715
1716 =head2 _koha_modify_item
1717
1718 =over 4
1719
1720 my ($itemnumber,$error) =_koha_modify_item( $item );
1721
1722 =back
1723
1724 Perform the actual update of the C<items> row.  Note that this
1725 routine accepts a hashref specifying the columns to update.
1726
1727 =cut
1728
1729 sub _koha_modify_item {
1730     my ( $item ) = @_;
1731     my $dbh=C4::Context->dbh;
1732     my $error;
1733
1734     my $query = "UPDATE items SET ";
1735     my @bind;
1736     for my $key ( keys %$item ) {
1737         $query.="$key=?,";
1738         push @bind, $item->{$key};
1739     }
1740     $query =~ s/,$//;
1741     $query .= " WHERE itemnumber=?";
1742     push @bind, $item->{'itemnumber'};
1743     my $sth = C4::Context->dbh->prepare($query);
1744     $sth->execute(@bind);
1745     if ( C4::Context->dbh->errstr ) {
1746         $error.="ERROR in _koha_modify_item $query".$dbh->errstr;
1747         warn $error;
1748     }
1749     $sth->finish();
1750     return ($item->{'itemnumber'},$error);
1751 }
1752
1753 =head2 _koha_delete_item
1754
1755 =over 4
1756
1757 _koha_delete_item( $dbh, $itemnum );
1758
1759 =back
1760
1761 Internal function to delete an item record from the koha tables
1762
1763 =cut
1764
1765 sub _koha_delete_item {
1766     my ( $dbh, $itemnum ) = @_;
1767
1768     # save the deleted item to deleteditems table
1769     my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
1770     $sth->execute($itemnum);
1771     my $data = $sth->fetchrow_hashref();
1772     $sth->finish();
1773     my $query = "INSERT INTO deleteditems SET ";
1774     my @bind  = ();
1775     foreach my $key ( keys %$data ) {
1776         $query .= "$key = ?,";
1777         push( @bind, $data->{$key} );
1778     }
1779     $query =~ s/\,$//;
1780     $sth = $dbh->prepare($query);
1781     $sth->execute(@bind);
1782     $sth->finish();
1783
1784     # delete from items table
1785     $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
1786     $sth->execute($itemnum);
1787     $sth->finish();
1788     return undef;
1789 }
1790
1791 =head2 _marc_from_item_hash
1792
1793 =over 4
1794
1795 my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
1796
1797 =back
1798
1799 Given an item hash representing a complete item record,
1800 create a C<MARC::Record> object containing an embedded
1801 tag representing that item.
1802
1803 The third, optional parameter C<$unlinked_item_subfields> is
1804 an arrayref of subfields (not mapped to C<items> fields per the
1805 framework) to be added to the MARC representation
1806 of the item.
1807
1808 =cut
1809
1810 sub _marc_from_item_hash {
1811     my $item = shift;
1812     my $frameworkcode = shift;
1813     my $unlinked_item_subfields;
1814     if (@_) {
1815         $unlinked_item_subfields = shift;
1816     }
1817
1818     # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
1819     # Also, don't emit a subfield if the underlying field is blank.
1820     my $mungeditem = { map {  (defined($item->{$_}) and $item->{$_} ne '') ?
1821                                 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
1822                                 : ()  } keys %{ $item } };
1823
1824     my $item_marc = MARC::Record->new();
1825     foreach my $item_field (keys %{ $mungeditem }) {
1826         my ($tag, $subfield) = GetMarcFromKohaField($item_field, $frameworkcode);
1827         next unless defined $tag and defined $subfield; # skip if not mapped to MARC field
1828         if (my $field = $item_marc->field($tag)) {
1829             $field->add_subfields($subfield => $mungeditem->{$item_field});
1830         } else {
1831             my $add_subfields = [];
1832             if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
1833                 $add_subfields = $unlinked_item_subfields;
1834             }
1835             $item_marc->add_fields( $tag, " ", " ", $subfield =>  $mungeditem->{$item_field}, @$add_subfields);
1836         }
1837     }
1838
1839     return $item_marc;
1840 }
1841
1842 =head2 _add_item_field_to_biblio
1843
1844 =over 4
1845
1846 _add_item_field_to_biblio($item_marc, $biblionumber, $frameworkcode);
1847
1848 =back
1849
1850 Adds the fields from a MARC record containing the
1851 representation of a Koha item record to the MARC
1852 biblio record.  The input C<$item_marc> record
1853 is expect to contain just one field, the embedded
1854 item information field.
1855
1856 =cut
1857
1858 sub _add_item_field_to_biblio {
1859     my ($item_marc, $biblionumber, $frameworkcode) = @_;
1860
1861     my $biblio_marc = GetMarcBiblio($biblionumber);
1862
1863     foreach my $field ($item_marc->fields()) {
1864         $biblio_marc->append_fields($field);
1865     }
1866
1867     ModBiblioMarc($biblio_marc, $biblionumber, $frameworkcode);
1868 }
1869
1870 =head2 _replace_item_field_in_biblio
1871
1872 =over
1873
1874 &_replace_item_field_in_biblio($item_marc, $biblionumber, $itemnumber, $frameworkcode)
1875
1876 =back
1877
1878 Given a MARC::Record C<$item_marc> containing one tag with the MARC
1879 representation of the item, examine the biblio MARC
1880 for the corresponding tag for that item and
1881 replace it with the tag from C<$item_marc>.
1882
1883 =cut
1884
1885 sub _replace_item_field_in_biblio {
1886     my ($ItemRecord, $biblionumber, $itemnumber, $frameworkcode) = @_;
1887     my $dbh = C4::Context->dbh;
1888
1889     # get complete MARC record & replace the item field by the new one
1890     my $completeRecord = GetMarcBiblio($biblionumber);
1891     my ($itemtag,$itemsubfield) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
1892     my $itemField = $ItemRecord->field($itemtag);
1893     my @items = $completeRecord->field($itemtag);
1894     my $found = 0;
1895     foreach (@items) {
1896         if ($_->subfield($itemsubfield) eq $itemnumber) {
1897             $_->replace_with($itemField);
1898             $found = 1;
1899         }
1900     }
1901
1902     unless ($found) {
1903         # If we haven't found the matching field,
1904         # just add it.  However, this means that
1905         # there is likely a bug.
1906         $completeRecord->append_fields($itemField);
1907     }
1908
1909     # save the record
1910     ModBiblioMarc($completeRecord, $biblionumber, $frameworkcode);
1911 }
1912
1913 =head2 _repack_item_errors
1914
1915 Add an error message hash generated by C<CheckItemPreSave>
1916 to a list of errors.
1917
1918 =cut
1919
1920 sub _repack_item_errors {
1921     my $item_sequence_num = shift;
1922     my $item_ref = shift;
1923     my $error_ref = shift;
1924
1925     my @repacked_errors = ();
1926
1927     foreach my $error_code (sort keys %{ $error_ref }) {
1928         my $repacked_error = {};
1929         $repacked_error->{'item_sequence'} = $item_sequence_num;
1930         $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
1931         $repacked_error->{'error_code'} = $error_code;
1932         $repacked_error->{'error_information'} = $error_ref->{$error_code};
1933         push @repacked_errors, $repacked_error;
1934     }
1935
1936     return @repacked_errors;
1937 }
1938
1939 =head2 _get_unlinked_item_subfields
1940
1941 =over 4
1942
1943 my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
1944
1945 =back
1946
1947 =cut
1948
1949 sub _get_unlinked_item_subfields {
1950     my $original_item_marc = shift;
1951     my $frameworkcode = shift;
1952
1953     my $marcstructure = GetMarcStructure(1, $frameworkcode);
1954
1955     # assume that this record has only one field, and that that
1956     # field contains only the item information
1957     my $subfields = [];
1958     my @fields = $original_item_marc->fields();
1959     if ($#fields > -1) {
1960         my $field = $fields[0];
1961             my $tag = $field->tag();
1962         foreach my $subfield ($field->subfields()) {
1963             if (defined $subfield->[1] and
1964                 $subfield->[1] ne '' and
1965                 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
1966                 push @$subfields, $subfield->[0] => $subfield->[1];
1967             }
1968         }
1969     }
1970     return $subfields;
1971 }
1972
1973 =head2 _get_unlinked_subfields_xml
1974
1975 =over 4
1976
1977 my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
1978
1979 =back
1980
1981 =cut
1982
1983 sub _get_unlinked_subfields_xml {
1984     my $unlinked_item_subfields = shift;
1985
1986     my $xml;
1987     if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
1988         my $marc = MARC::Record->new();
1989         # use of tag 999 is arbitrary, and doesn't need to match the item tag
1990         # used in the framework
1991         $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
1992         $xml = $marc->as_xml();
1993     }
1994
1995     return $xml;
1996 }
1997
1998 =head2 _parse_unlinked_item_subfields_from_xml
1999
2000 =over 4
2001
2002 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2003
2004 =back
2005
2006 =cut
2007
2008 sub  _parse_unlinked_item_subfields_from_xml {
2009     my $xml = shift;
2010
2011     return unless defined $xml and $xml ne "";
2012     my $marc = MARC::Record->new_from_xml(StripNonXmlChars($xml), 'UTF-8', C4::Context->preference("marcflavour"));
2013     my $unlinked_subfields = [];
2014     my @fields = $marc->fields();
2015     if ($#fields > -1) {
2016         foreach my $subfield ($fields[0]->subfields()) {
2017             push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2018         }
2019     }
2020     return $unlinked_subfields;
2021 }
2022
2023 1;