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 gets a list of lost items.
 849
 850 =over 2
 851
 852 =item input:
 853
 854 C<$where> is a hashref. it containts a field of the items table as key
 855 and the value to match as value. For example:
 856
 857 { barcode    => 'abc123',
 858   homebranch => 'CPL',    }
 859
 860 C<$orderby> is a field of the items table by which the resultset
 861 should be orderd.
 862
 863 =item return:
 864
 865 C<$items> is a reference to an array full of hashrefs with columns
 866 from the "items" table as keys.
 867
 868 =item usage in the perl script:
 869
 870 my $where = { barcode => '0001548' };
 871 my $items = GetLostItems( $where, "homebranch" );
 872 $template->param( itemsloop => $items );
 873
 874 =back
 875
 876 =cut
 877
 878 sub GetLostItems {
 879     # Getting input args.
 880     my $where   = shift;
 881     my $orderby = shift;
 882     my $dbh     = C4::Context->dbh;
 883
 884     my $query   = "
 885         SELECT *
 886         FROM   items, biblio, authorised_values
 887         WHERE
 888                         items.biblionumber = biblio.biblionumber
 889                         AND items.itemlost = authorised_values.authorised_value
 890                         AND authorised_values.category = 'LOST'
 891                 AND itemlost IS NOT NULL
 892                 AND itemlost <> 0
 893
 894     ";
 895     my @query_parameters;
 896     foreach my $key (keys %$where) {
 897         $query .= " AND $key LIKE ?";
 898         push @query_parameters, "%$where->{$key}%";
 899     }
 900     if ( defined $orderby ) {
 901         $query .= ' ORDER BY ?';
 902         push @query_parameters, $orderby;
 903     }
 904
 905     my $sth = $dbh->prepare($query);
 906     $sth->execute( @query_parameters );
 907     my $items;
 908     while ( my $row = $sth->fetchrow_hashref ){
 909         push @$items, $row;
 910     }
 911     return $items;
 912 }
 913
 914 =head2 GetItemsForInventory
 915
 916 =over 4
 917
 918 $itemlist = GetItemsForInventory($minlocation,$maxlocation,$datelastseen,$offset,$size)
 919
 920 =back
 921
 922 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
 923
 924 The sub returns a list of hashes, containing itemnumber, author, title, barcode & item callnumber.
 925 It is ordered by callnumber,title.
 926
 927 The minlocation & maxlocation parameters are used to specify a range of item callnumbers
 928 the datelastseen can be used to specify that you want to see items not seen since a past date only.
 929 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
 930
 931 =cut
 932
 933 sub GetItemsForInventory {
 934     my ( $minlocation, $maxlocation,$location, $itemtype, $datelastseen, $branch, $offset, $size ) = @_;
 935     my $dbh = C4::Context->dbh;
 936     my $sth;
 937     if ($datelastseen) {
 938         $datelastseen=format_date_in_iso($datelastseen);
 939         my $query =
 940                 "SELECT itemnumber,barcode,itemcallnumber,title,author,biblio.biblionumber,datelastseen
 941                  FROM items
 942                    LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
 943                    LEFT JOIN biblioitems on items.biblionumber=biblioitems.biblionumber
 944                  WHERE itemcallnumber>= ?
 945                    AND itemcallnumber <=?
 946                    AND (datelastseen< ? OR datelastseen IS NULL)";
 947         $query.= " AND items.location=".$dbh->quote($location) if $location;
 948         $query.= " AND items.homebranch=".$dbh->quote($branch) if $branch;
 949         $query.= " AND biblioitems.itemtype=".$dbh->quote($itemtype) if $itemtype;
 950         $query .= " ORDER BY itemcallnumber,title";
 951         $sth = $dbh->prepare($query);
 952         $sth->execute( $minlocation, $maxlocation, $datelastseen );
 953     }
 954     else {
 955         my $query ="
 956                 SELECT itemnumber,barcode,itemcallnumber,biblio.biblionumber,title,author,datelastseen
 957                 FROM items
 958                     LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
 959                    LEFT JOIN biblioitems on items.biblionumber=biblioitems.biblionumber
 960                 WHERE itemcallnumber>= ?
 961                   AND itemcallnumber <=?";
 962         $query.= " AND items.location=".$dbh->quote($location) if $location;
 963         $query.= " AND items.homebranch=".$dbh->quote($branch) if $branch;
 964         $query.= " AND biblioitems.itemtype=".$dbh->quote($itemtype) if $itemtype;
 965         $query .= " ORDER BY itemcallnumber,title";
 966         $sth = $dbh->prepare($query);
 967         $sth->execute( $minlocation, $maxlocation );
 968     }
 969     my @results;
 970     $size--;
 971     while ( my $row = $sth->fetchrow_hashref ) {
 972         $offset-- if ($offset);
 973         $row->{datelastseen}=format_date($row->{datelastseen});
 974         if ( ( !$offset ) && $size ) {
 975             push @results, $row;
 976             $size--;
 977         }
 978     }
 979     return \@results;
 980 }
 981
 982 =head2 GetItemsCount
 983
 984 =over 4
 985 $count = &GetItemsCount( $biblionumber);
 986
 987 =back
 988
 989 This function return count of item with $biblionumber
 990
 991 =cut
 992
 993 sub GetItemsCount {
 994     my ( $biblionumber ) = @_;
 995     my $dbh = C4::Context->dbh;
 996     my $query = "SELECT count(*)
 997           FROM  items
 998           WHERE biblionumber=?";
 999     my $sth = $dbh->prepare($query);
1000     $sth->execute($biblionumber);
1001     my $count = $sth->fetchrow;
1002     $sth->finish;
1003     return ($count);
1004 }
1005
1006 =head2 GetItemInfosOf
1007
1008 =over 4
1009
1010 GetItemInfosOf(@itemnumbers);
1011
1012 =back
1013
1014 =cut
1015
1016 sub GetItemInfosOf {
1017     my @itemnumbers = @_;
1018
1019     my $query = '
1020         SELECT *
1021         FROM items
1022         WHERE itemnumber IN (' . join( ',', @itemnumbers ) . ')
1023     ';
1024     return get_infos_of( $query, 'itemnumber' );
1025 }
1026
1027 =head2 GetItemsByBiblioitemnumber
1028
1029 =over 4
1030
1031 GetItemsByBiblioitemnumber($biblioitemnumber);
1032
1033 =back
1034
1035 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1036 Called by C<C4::XISBN>
1037
1038 =cut
1039
1040 sub GetItemsByBiblioitemnumber {
1041     my ( $bibitem ) = @_;
1042     my $dbh = C4::Context->dbh;
1043     my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1044     # Get all items attached to a biblioitem
1045     my $i = 0;
1046     my @results;
1047     $sth->execute($bibitem) || die $sth->errstr;
1048     while ( my $data = $sth->fetchrow_hashref ) {
1049         # Foreach item, get circulation information
1050         my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1051                                    WHERE itemnumber = ?
1052                                    AND issues.borrowernumber = borrowers.borrowernumber"
1053         );
1054         $sth2->execute( $data->{'itemnumber'} );
1055         if ( my $data2 = $sth2->fetchrow_hashref ) {
1056             # if item is out, set the due date and who it is out too
1057             $data->{'date_due'}   = $data2->{'date_due'};
1058             $data->{'cardnumber'} = $data2->{'cardnumber'};
1059             $data->{'borrowernumber'}   = $data2->{'borrowernumber'};
1060         }
1061         else {
1062             # set date_due to blank, so in the template we check itemlost, and wthdrawn
1063             $data->{'date_due'} = '';
1064         }    # else
1065         $sth2->finish;
1066         # Find the last 3 people who borrowed this item.
1067         my $query2 = "SELECT * FROM old_issues, borrowers WHERE itemnumber = ?
1068                       AND old_issues.borrowernumber = borrowers.borrowernumber
1069                       ORDER BY returndate desc,timestamp desc LIMIT 3";
1070         $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1071         $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1072         my $i2 = 0;
1073         while ( my $data2 = $sth2->fetchrow_hashref ) {
1074             $data->{"timestamp$i2"} = $data2->{'timestamp'};
1075             $data->{"card$i2"}      = $data2->{'cardnumber'};
1076             $data->{"borrower$i2"}  = $data2->{'borrowernumber'};
1077             $i2++;
1078         }
1079         $sth2->finish;
1080         push(@results,$data);
1081     }
1082     $sth->finish;
1083     return (\@results);
1084 }
1085
1086 =head2 GetItemsInfo
1087
1088 =over 4
1089
1090 @results = GetItemsInfo($biblionumber, $type);
1091
1092 =back
1093
1094 Returns information about books with the given biblionumber.
1095
1096 C<$type> may be either C<intra> or anything else. If it is not set to
1097 C<intra>, then the search will exclude lost, very overdue, and
1098 withdrawn items.
1099
1100 C<GetItemsInfo> returns a list of references-to-hash. Each element
1101 contains a number of keys. Most of them are table items from the
1102 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
1103 Koha database. Other keys include:
1104
1105 =over 2
1106
1107 =item C<$data-E<gt>{branchname}>
1108
1109 The name (not the code) of the branch to which the book belongs.
1110
1111 =item C<$data-E<gt>{datelastseen}>
1112
1113 This is simply C<items.datelastseen>, except that while the date is
1114 stored in YYYY-MM-DD format in the database, here it is converted to
1115 DD/MM/YYYY format. A NULL date is returned as C<//>.
1116
1117 =item C<$data-E<gt>{datedue}>
1118
1119 =item C<$data-E<gt>{class}>
1120
1121 This is the concatenation of C<biblioitems.classification>, the book's
1122 Dewey code, and C<biblioitems.subclass>.
1123
1124 =item C<$data-E<gt>{ocount}>
1125
1126 I think this is the number of copies of the book available.
1127
1128 =item C<$data-E<gt>{order}>
1129
1130 If this is set, it is set to C<One Order>.
1131
1132 =back
1133
1134 =cut
1135
1136 sub GetItemsInfo {
1137     my ( $biblionumber, $type ) = @_;
1138     my $dbh   = C4::Context->dbh;
1139     my $query = "SELECT *,items.notforloan as itemnotforloan
1140                  FROM items
1141                  LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1142                  LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
1143     $query .=  (C4::Context->preference('item-level_itypes')) ?
1144                      " LEFT JOIN itemtypes on items.itype = itemtypes.itemtype "
1145                     : " LEFT JOIN itemtypes on biblioitems.itemtype = itemtypes.itemtype ";
1146     $query .= "WHERE items.biblionumber = ? ORDER BY items.dateaccessioned desc" ;
1147     my $sth = $dbh->prepare($query);
1148     $sth->execute($biblionumber);
1149     my $i = 0;
1150     my @results;
1151     my ( $date_due, $count_reserves, $serial );
1152
1153     my $isth    = $dbh->prepare(
1154         "SELECT issues.*,borrowers.cardnumber,borrowers.surname,borrowers.firstname,borrowers.branchcode as bcode
1155         FROM   issues LEFT JOIN borrowers ON issues.borrowernumber=borrowers.borrowernumber
1156         WHERE  itemnumber = ?"
1157        );
1158         my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=? ");
1159         while ( my $data = $sth->fetchrow_hashref ) {
1160         my $datedue = '';
1161         $isth->execute( $data->{'itemnumber'} );
1162         if ( my $idata = $isth->fetchrow_hashref ) {
1163             $data->{borrowernumber} = $idata->{borrowernumber};
1164             $data->{cardnumber}     = $idata->{cardnumber};
1165             $data->{surname}     = $idata->{surname};
1166             $data->{firstname}     = $idata->{firstname};
1167             $datedue                = $idata->{'date_due'};
1168         if (C4::Context->preference("IndependantBranches")){
1169         my $userenv = C4::Context->userenv;
1170         if ( ($userenv) && ( $userenv->{flags} != 1 ) ) {
1171             $data->{'NOTSAMEBRANCH'} = 1 if ($idata->{'bcode'} ne $userenv->{branch});
1172         }
1173         }
1174         }
1175                 if ( $data->{'serial'}) {
1176                         $ssth->execute($data->{'itemnumber'}) ;
1177                         ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
1178                         $serial = 1;
1179         }
1180                 if ( $datedue eq '' ) {
1181             my ( $restype, $reserves ) =
1182               C4::Reserves::CheckReserves( $data->{'itemnumber'} );
1183             if ($restype) {
1184                 $count_reserves = $restype;
1185             }
1186         }
1187         $isth->finish;
1188         $ssth->finish;
1189         #get branch information.....
1190         my $bsth = $dbh->prepare(
1191             "SELECT * FROM branches WHERE branchcode = ?
1192         "
1193         );
1194         $bsth->execute( $data->{'holdingbranch'} );
1195         if ( my $bdata = $bsth->fetchrow_hashref ) {
1196             $data->{'branchname'} = $bdata->{'branchname'};
1197         }
1198         $data->{'datedue'}        = $datedue;
1199         $data->{'count_reserves'} = $count_reserves;
1200
1201         # get notforloan complete status if applicable
1202         my $sthnflstatus = $dbh->prepare(
1203             'SELECT authorised_value
1204             FROM   marc_subfield_structure
1205             WHERE  kohafield="items.notforloan"
1206         '
1207         );
1208
1209         $sthnflstatus->execute;
1210         my ($authorised_valuecode) = $sthnflstatus->fetchrow;
1211         if ($authorised_valuecode) {
1212             $sthnflstatus = $dbh->prepare(
1213                 "SELECT lib FROM authorised_values
1214                  WHERE  category=?
1215                  AND authorised_value=?"
1216             );
1217             $sthnflstatus->execute( $authorised_valuecode,
1218                 $data->{itemnotforloan} );
1219             my ($lib) = $sthnflstatus->fetchrow;
1220             $data->{notforloanvalue} = $lib;
1221         }
1222
1223         # my stack procedures
1224         my $stackstatus = $dbh->prepare(
1225             'SELECT authorised_value
1226              FROM   marc_subfield_structure
1227              WHERE  kohafield="items.stack"
1228         '
1229         );
1230         $stackstatus->execute;
1231
1232         ($authorised_valuecode) = $stackstatus->fetchrow;
1233         if ($authorised_valuecode) {
1234             $stackstatus = $dbh->prepare(
1235                 "SELECT lib
1236                  FROM   authorised_values
1237                  WHERE  category=?
1238                  AND    authorised_value=?
1239             "
1240             );
1241             $stackstatus->execute( $authorised_valuecode, $data->{stack} );
1242             my ($lib) = $stackstatus->fetchrow;
1243             $data->{stack} = $lib;
1244         }
1245         # Find the last 3 people who borrowed this item.
1246         my $sth2 = $dbh->prepare("SELECT * FROM old_issues,borrowers
1247                                     WHERE itemnumber = ?
1248                                     AND old_issues.borrowernumber = borrowers.borrowernumber
1249                                     LIMIT 3");
1250         $sth2->execute($data->{'itemnumber'});
1251         my $ii = 0;
1252         while (my $data2 = $sth2->fetchrow_hashref()) {
1253             $data->{"timestamp$ii"} = $data2->{'timestamp'} if $data2->{'timestamp'};
1254             $data->{"card$ii"}      = $data2->{'cardnumber'} if $data2->{'cardnumber'};
1255             $data->{"borrower$ii"}  = $data2->{'borrowernumber'} if $data2->{'borrowernumber'};
1256             $ii++;
1257         }
1258
1259         $results[$i] = $data;
1260         $i++;
1261     }
1262     $sth->finish;
1263         if($serial) {
1264                 return( sort { $b->{'publisheddate'} cmp $a->{'publisheddate'} } @results );
1265         } else {
1266         return (@results);
1267         }
1268 }
1269
1270 =head2 get_itemnumbers_of
1271
1272 =over 4
1273
1274 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1275
1276 =back
1277
1278 Given a list of biblionumbers, return the list of corresponding itemnumbers
1279 for each biblionumber.
1280
1281 Return a reference on a hash where keys are biblionumbers and values are
1282 references on array of itemnumbers.
1283
1284 =cut
1285
1286 sub get_itemnumbers_of {
1287     my @biblionumbers = @_;
1288
1289     my $dbh = C4::Context->dbh;
1290
1291     my $query = '
1292         SELECT itemnumber,
1293             biblionumber
1294         FROM items
1295         WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1296     ';
1297     my $sth = $dbh->prepare($query);
1298     $sth->execute(@biblionumbers);
1299
1300     my %itemnumbers_of;
1301
1302     while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1303         push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1304     }
1305
1306     return \%itemnumbers_of;
1307 }
1308
1309 =head2 GetItemnumberFromBarcode
1310
1311 =over 4
1312
1313 $result = GetItemnumberFromBarcode($barcode);
1314
1315 =back
1316
1317 =cut
1318
1319 sub GetItemnumberFromBarcode {
1320     my ($barcode) = @_;
1321     my $dbh = C4::Context->dbh;
1322
1323     my $rq =
1324       $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1325     $rq->execute($barcode);
1326     my ($result) = $rq->fetchrow;
1327     return ($result);
1328 }
1329
1330 =head3 get_item_authorised_values
1331
1332   find the types and values for all authorised values assigned to this item.
1333
1334   parameters:
1335     itemnumber
1336
1337   returns: a hashref malling the authorised value to the value set for this itemnumber
1338
1339     $authorised_values = {
1340              'CCODE'      => undef,
1341              'DAMAGED'    => '0',
1342              'LOC'        => '3',
1343              'LOST'       => '0'
1344              'NOT_LOAN'   => '0',
1345              'RESTRICTED' => undef,
1346              'STACK'      => undef,
1347              'WITHDRAWN'  => '0',
1348              'branches'   => 'CPL',
1349              'cn_source'  => undef,
1350              'itemtypes'  => 'SER',
1351            };
1352
1353    Notes: see C4::Biblio::get_biblio_authorised_values for a similar method at the biblio level.
1354
1355 =cut
1356
1357 sub get_item_authorised_values {
1358     my $itemnumber = shift;
1359
1360     # assume that these entries in the authorised_value table are item level.
1361     my $query = q(SELECT distinct authorised_value, kohafield
1362                     FROM marc_subfield_structure
1363                     WHERE kohafield like 'item%'
1364                       AND authorised_value != '' );
1365
1366     my $itemlevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
1367     my $iteminfo = GetItem( $itemnumber );
1368     # warn( Data::Dumper->Dump( [ $itemlevel_authorised_values ], [ 'itemlevel_authorised_values' ] ) );
1369     my $return;
1370     foreach my $this_authorised_value ( keys %$itemlevel_authorised_values ) {
1371         my $field = $itemlevel_authorised_values->{ $this_authorised_value }->{'kohafield'};
1372         $field =~ s/^items\.//;
1373         if ( exists $iteminfo->{ $field } ) {
1374             $return->{ $this_authorised_value } = $iteminfo->{ $field };
1375         }
1376     }
1377     # warn( Data::Dumper->Dump( [ $return ], [ 'return' ] ) );
1378     return $return;
1379 }
1380
1381 =head3 get_authorised_value_images
1382
1383   find a list of icons that are appropriate for display based on the
1384   authorised values for a biblio.
1385
1386   parameters: listref of authorised values, such as comes from
1387     get_item_ahtorised_values or
1388     from C4::Biblio::get_biblio_authorised_values
1389
1390   returns: listref of hashrefs for each image. Each hashref looks like
1391     this:
1392
1393       { imageurl => '/intranet-tmpl/prog/img/itemtypeimg/npl/WEB.gif',
1394         label    => '',
1395         category => '',
1396         value    => '', }
1397
1398   Notes: Currently, I put on the full path to the images on the staff
1399   side. This should either be configurable or not done at all. Since I
1400   have to deal with 'intranet' or 'opac' in
1401   get_biblio_authorised_values, perhaps I should be passing it in.
1402
1403 =cut
1404
1405 sub get_authorised_value_images {
1406     my $authorised_values = shift;
1407
1408     my @imagelist;
1409
1410     my $authorised_value_list = GetAuthorisedValues();
1411     # warn ( Data::Dumper->Dump( [ $authorised_value_list ], [ 'authorised_value_list' ] ) );
1412     foreach my $this_authorised_value ( @$authorised_value_list ) {
1413         if ( exists $authorised_values->{ $this_authorised_value->{'category'} }
1414              && $authorised_values->{ $this_authorised_value->{'category'} } eq $this_authorised_value->{'authorised_value'} ) {
1415             # warn ( Data::Dumper->Dump( [ $this_authorised_value ], [ 'this_authorised_value' ] ) );
1416             if ( defined $this_authorised_value->{'imageurl'} ) {
1417                 push @imagelist, { imageurl => C4::Koha::getitemtypeimagesrc( 'intranet' ) . '/' . $this_authorised_value->{'imageurl'},
1418                                    label    => $this_authorised_value->{'lib'},
1419                                    category => $this_authorised_value->{'category'},
1420                                    value    => $this_authorised_value->{'authorised_value'}, };
1421             }
1422         }
1423     }
1424
1425     # warn ( Data::Dumper->Dump( [ \@imagelist ], [ 'imagelist' ] ) );
1426     return \@imagelist;
1427
1428 }
1429
1430 =head1 LIMITED USE FUNCTIONS
1431
1432 The following functions, while part of the public API,
1433 are not exported.  This is generally because they are
1434 meant to be used by only one script for a specific
1435 purpose, and should not be used in any other context
1436 without careful thought.
1437
1438 =cut
1439
1440 =head2 GetMarcItem
1441
1442 =over 4
1443
1444 my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1445
1446 =back
1447
1448 Returns MARC::Record of the item passed in parameter.
1449 This function is meant for use only in C<cataloguing/additem.pl>,
1450 where it is needed to support that script's MARC-like
1451 editor.
1452
1453 =cut
1454
1455 sub GetMarcItem {
1456     my ( $biblionumber, $itemnumber ) = @_;
1457
1458     # GetMarcItem has been revised so that it does the following:
1459     #  1. Gets the item information from the items table.
1460     #  2. Converts it to a MARC field for storage in the bib record.
1461     #
1462     # The previous behavior was:
1463     #  1. Get the bib record.
1464     #  2. Return the MARC tag corresponding to the item record.
1465     #
1466     # The difference is that one treats the items row as authoritative,
1467     # while the other treats the MARC representation as authoritative
1468     # under certain circumstances.
1469
1470     my $itemrecord = GetItem($itemnumber);
1471
1472     # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1473     # Also, don't emit a subfield if the underlying field is blank.
1474     my $mungeditem = { map {  $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : ()  } keys %{ $itemrecord } };
1475     my $itemmarc = TransformKohaToMarc($mungeditem);
1476
1477     my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1478     if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1479         my @fields = $itemmarc->fields();
1480         if ($#fields > -1) {
1481             $fields[0]->add_subfields(@$unlinked_item_subfields);
1482         }
1483     }
1484
1485     return $itemmarc;
1486
1487 }
1488
1489 =head1 PRIVATE FUNCTIONS AND VARIABLES
1490
1491 The following functions are not meant to be called
1492 directly, but are documented in order to explain
1493 the inner workings of C<C4::Items>.
1494
1495 =cut
1496
1497 =head2 %derived_columns
1498
1499 This hash keeps track of item columns that
1500 are strictly derived from other columns in
1501 the item record and are not meant to be set
1502 independently.
1503
1504 Each key in the hash should be the name of a
1505 column (as named by TransformMarcToKoha).  Each
1506 value should be hashref whose keys are the
1507 columns on which the derived column depends.  The
1508 hashref should also contain a 'BUILDER' key
1509 that is a reference to a sub that calculates
1510 the derived value.
1511
1512 =cut
1513
1514 my %derived_columns = (
1515     'items.cn_sort' => {
1516         'itemcallnumber' => 1,
1517         'items.cn_source' => 1,
1518         'BUILDER' => \&_calc_items_cn_sort,
1519     }
1520 );
1521
1522 =head2 _set_derived_columns_for_add
1523
1524 =over 4
1525
1526 _set_derived_column_for_add($item);
1527
1528 =back
1529
1530 Given an item hash representing a new item to be added,
1531 calculate any derived columns.  Currently the only
1532 such column is C<items.cn_sort>.
1533
1534 =cut
1535
1536 sub _set_derived_columns_for_add {
1537     my $item = shift;
1538
1539     foreach my $column (keys %derived_columns) {
1540         my $builder = $derived_columns{$column}->{'BUILDER'};
1541         my $source_values = {};
1542         foreach my $source_column (keys %{ $derived_columns{$column} }) {
1543             next if $source_column eq 'BUILDER';
1544             $source_values->{$source_column} = $item->{$source_column};
1545         }
1546         $builder->($item, $source_values);
1547     }
1548 }
1549
1550 =head2 _set_derived_columns_for_mod
1551
1552 =over 4
1553
1554 _set_derived_column_for_mod($item);
1555
1556 =back
1557
1558 Given an item hash representing a new item to be modified.
1559 calculate any derived columns.  Currently the only
1560 such column is C<items.cn_sort>.
1561
1562 This routine differs from C<_set_derived_columns_for_add>
1563 in that it needs to handle partial item records.  In other
1564 words, the caller of C<ModItem> may have supplied only one
1565 or two columns to be changed, so this function needs to
1566 determine whether any of the columns to be changed affect
1567 any of the derived columns.  Also, if a derived column
1568 depends on more than one column, but the caller is not
1569 changing all of then, this routine retrieves the unchanged
1570 values from the database in order to ensure a correct
1571 calculation.
1572
1573 =cut
1574
1575 sub _set_derived_columns_for_mod {
1576     my $item = shift;
1577
1578     foreach my $column (keys %derived_columns) {
1579         my $builder = $derived_columns{$column}->{'BUILDER'};
1580         my $source_values = {};
1581         my %missing_sources = ();
1582         my $must_recalc = 0;
1583         foreach my $source_column (keys %{ $derived_columns{$column} }) {
1584             next if $source_column eq 'BUILDER';
1585             if (exists $item->{$source_column}) {
1586                 $must_recalc = 1;
1587                 $source_values->{$source_column} = $item->{$source_column};
1588             } else {
1589                 $missing_sources{$source_column} = 1;
1590             }
1591         }
1592         if ($must_recalc) {
1593             foreach my $source_column (keys %missing_sources) {
1594                 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
1595             }
1596             $builder->($item, $source_values);
1597         }
1598     }
1599 }
1600
1601 =head2 _do_column_fixes_for_mod
1602
1603 =over 4
1604
1605 _do_column_fixes_for_mod($item);
1606
1607 =back
1608
1609 Given an item hashref containing one or more
1610 columns to modify, fix up certain values.
1611 Specifically, set to 0 any passed value
1612 of C<notforloan>, C<damaged>, C<itemlost>, or
1613 C<wthdrawn> that is either undefined or
1614 contains the empty string.
1615
1616 =cut
1617
1618 sub _do_column_fixes_for_mod {
1619     my $item = shift;
1620
1621     if (exists $item->{'notforloan'} and
1622         (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
1623         $item->{'notforloan'} = 0;
1624     }
1625     if (exists $item->{'damaged'} and
1626         (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
1627         $item->{'damaged'} = 0;
1628     }
1629     if (exists $item->{'itemlost'} and
1630         (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
1631         $item->{'itemlost'} = 0;
1632     }
1633     if (exists $item->{'wthdrawn'} and
1634         (not defined $item->{'wthdrawn'} or $item->{'wthdrawn'} eq '')) {
1635         $item->{'wthdrawn'} = 0;
1636     }
1637 }
1638
1639 =head2 _get_single_item_column
1640
1641 =over 4
1642
1643 _get_single_item_column($column, $itemnumber);
1644
1645 =back
1646
1647 Retrieves the value of a single column from an C<items>
1648 row specified by C<$itemnumber>.
1649
1650 =cut
1651
1652 sub _get_single_item_column {
1653     my $column = shift;
1654     my $itemnumber = shift;
1655
1656     my $dbh = C4::Context->dbh;
1657     my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
1658     $sth->execute($itemnumber);
1659     my ($value) = $sth->fetchrow();
1660     return $value;
1661 }
1662
1663 =head2 _calc_items_cn_sort
1664
1665 =over 4
1666
1667 _calc_items_cn_sort($item, $source_values);
1668
1669 =back
1670
1671 Helper routine to calculate C<items.cn_sort>.
1672
1673 =cut
1674
1675 sub _calc_items_cn_sort {
1676     my $item = shift;
1677     my $source_values = shift;
1678
1679     $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
1680 }
1681
1682 =head2 _set_defaults_for_add
1683
1684 =over 4
1685
1686 _set_defaults_for_add($item_hash);
1687
1688 =back
1689
1690 Given an item hash representing an item to be added, set
1691 correct default values for columns whose default value
1692 is not handled by the DBMS.  This includes the following
1693 columns:
1694
1695 =over 2
1696
1697 =item *
1698
1699 C<items.dateaccessioned>
1700
1701 =item *
1702
1703 C<items.notforloan>
1704
1705 =item *
1706
1707 C<items.damaged>
1708
1709 =item *
1710
1711 C<items.itemlost>
1712
1713 =item *
1714
1715 C<items.wthdrawn>
1716
1717 =back
1718
1719 =cut
1720
1721 sub _set_defaults_for_add {
1722     my $item = shift;
1723
1724     # if dateaccessioned is provided, use it. Otherwise, set to NOW()
1725     if (!(exists $item->{'dateaccessioned'}) ||
1726          ($item->{'dateaccessioned'} eq '')) {
1727         # FIXME add check for invalid date
1728         my $today = C4::Dates->new();
1729         $item->{'dateaccessioned'} =  $today->output("iso"); #TODO: check time issues
1730     }
1731
1732     # various item status fields cannot be null
1733     $item->{'notforloan'} = 0 unless exists $item->{'notforloan'} and defined $item->{'notforloan'} and $item->{'notforloan'} ne '';
1734     $item->{'damaged'}    = 0 unless exists $item->{'damaged'}    and defined $item->{'damaged'}    and $item->{'damaged'} ne '';
1735     $item->{'itemlost'}   = 0 unless exists $item->{'itemlost'}   and defined $item->{'itemlost'}   and $item->{'itemlost'} ne '';
1736     $item->{'wthdrawn'}   = 0 unless exists $item->{'wthdrawn'}   and defined $item->{'wthdrawn'}   and $item->{'wthdrawn'} ne '';
1737 }
1738
1739 =head2 _koha_new_item
1740
1741 =over 4
1742
1743 my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
1744
1745 =back
1746
1747 Perform the actual insert into the C<items> table.
1748
1749 =cut
1750
1751 sub _koha_new_item {
1752     my ( $item, $barcode ) = @_;
1753     my $dbh=C4::Context->dbh;
1754     my $error;
1755     my $query =
1756            "INSERT INTO items SET
1757             biblionumber        = ?,
1758             biblioitemnumber    = ?,
1759             barcode             = ?,
1760             dateaccessioned     = ?,
1761             booksellerid        = ?,
1762             homebranch          = ?,
1763             price               = ?,
1764             replacementprice    = ?,
1765             replacementpricedate = NOW(),
1766             datelastborrowed    = ?,
1767             datelastseen        = NOW(),
1768             stack               = ?,
1769             notforloan          = ?,
1770             damaged             = ?,
1771             itemlost            = ?,
1772             wthdrawn            = ?,
1773             itemcallnumber      = ?,
1774             restricted          = ?,
1775             itemnotes           = ?,
1776             holdingbranch       = ?,
1777             paidfor             = ?,
1778             location            = ?,
1779             onloan              = ?,
1780             issues              = ?,
1781             renewals            = ?,
1782             reserves            = ?,
1783             cn_source           = ?,
1784             cn_sort             = ?,
1785             ccode               = ?,
1786             itype               = ?,
1787             materials           = ?,
1788                         uri                 = ?,
1789             enumchron           = ?,
1790                         more_subfields_xml  = ?
1791           ";
1792     my $sth = $dbh->prepare($query);
1793    $sth->execute(
1794             $item->{'biblionumber'},
1795             $item->{'biblioitemnumber'},
1796             $barcode,
1797             $item->{'dateaccessioned'},
1798             $item->{'booksellerid'},
1799             $item->{'homebranch'},
1800             $item->{'price'},
1801             $item->{'replacementprice'},
1802             $item->{datelastborrowed},
1803             $item->{stack},
1804             $item->{'notforloan'},
1805             $item->{'damaged'},
1806             $item->{'itemlost'},
1807             $item->{'wthdrawn'},
1808             $item->{'itemcallnumber'},
1809             $item->{'restricted'},
1810             $item->{'itemnotes'},
1811             $item->{'holdingbranch'},
1812             $item->{'paidfor'},
1813             $item->{'location'},
1814             $item->{'onloan'},
1815             $item->{'issues'},
1816             $item->{'renewals'},
1817             $item->{'reserves'},
1818             $item->{'items.cn_source'},
1819             $item->{'items.cn_sort'},
1820             $item->{'ccode'},
1821             $item->{'itype'},
1822             $item->{'materials'},
1823             $item->{'uri'},
1824             $item->{'enumchron'},
1825                         $item->{'more_subfields_xml'},
1826     );
1827     my $itemnumber = $dbh->{'mysql_insertid'};
1828     if ( defined $sth->errstr ) {
1829         $error.="ERROR in _koha_new_item $query".$sth->errstr;
1830     }
1831     $sth->finish();
1832     return ( $itemnumber, $error );
1833 }
1834
1835 =head2 _koha_modify_item
1836
1837 =over 4
1838
1839 my ($itemnumber,$error) =_koha_modify_item( $item );
1840
1841 =back
1842
1843 Perform the actual update of the C<items> row.  Note that this
1844 routine accepts a hashref specifying the columns to update.
1845
1846 =cut
1847
1848 sub _koha_modify_item {
1849     my ( $item ) = @_;
1850     my $dbh=C4::Context->dbh;
1851     my $error;
1852
1853     my $query = "UPDATE items SET ";
1854     my @bind;
1855     for my $key ( keys %$item ) {
1856         $query.="$key=?,";
1857         push @bind, $item->{$key};
1858     }
1859     $query =~ s/,$//;
1860     $query .= " WHERE itemnumber=?";
1861     push @bind, $item->{'itemnumber'};
1862     my $sth = C4::Context->dbh->prepare($query);
1863     $sth->execute(@bind);
1864     if ( C4::Context->dbh->errstr ) {
1865         $error.="ERROR in _koha_modify_item $query".$dbh->errstr;
1866         warn $error;
1867     }
1868     $sth->finish();
1869     return ($item->{'itemnumber'},$error);
1870 }
1871
1872 =head2 _koha_delete_item
1873
1874 =over 4
1875
1876 _koha_delete_item( $dbh, $itemnum );
1877
1878 =back
1879
1880 Internal function to delete an item record from the koha tables
1881
1882 =cut
1883
1884 sub _koha_delete_item {
1885     my ( $dbh, $itemnum ) = @_;
1886
1887     # save the deleted item to deleteditems table
1888     my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
1889     $sth->execute($itemnum);
1890     my $data = $sth->fetchrow_hashref();
1891     $sth->finish();
1892     my $query = "INSERT INTO deleteditems SET ";
1893     my @bind  = ();
1894     foreach my $key ( keys %$data ) {
1895         $query .= "$key = ?,";
1896         push( @bind, $data->{$key} );
1897     }
1898     $query =~ s/\,$//;
1899     $sth = $dbh->prepare($query);
1900     $sth->execute(@bind);
1901     $sth->finish();
1902
1903     # delete from items table
1904     $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
1905     $sth->execute($itemnum);
1906     $sth->finish();
1907     return undef;
1908 }
1909
1910 =head2 _marc_from_item_hash
1911
1912 =over 4
1913
1914 my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
1915
1916 =back
1917
1918 Given an item hash representing a complete item record,
1919 create a C<MARC::Record> object containing an embedded
1920 tag representing that item.
1921
1922 The third, optional parameter C<$unlinked_item_subfields> is
1923 an arrayref of subfields (not mapped to C<items> fields per the
1924 framework) to be added to the MARC representation
1925 of the item.
1926
1927 =cut
1928
1929 sub _marc_from_item_hash {
1930     my $item = shift;
1931     my $frameworkcode = shift;
1932     my $unlinked_item_subfields;
1933     if (@_) {
1934         $unlinked_item_subfields = shift;
1935     }
1936
1937     # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
1938     # Also, don't emit a subfield if the underlying field is blank.
1939     my $mungeditem = { map {  (defined($item->{$_}) and $item->{$_} ne '') ?
1940                                 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
1941                                 : ()  } keys %{ $item } };
1942
1943     my $item_marc = MARC::Record->new();
1944     foreach my $item_field (keys %{ $mungeditem }) {
1945         my ($tag, $subfield) = GetMarcFromKohaField($item_field, $frameworkcode);
1946         next unless defined $tag and defined $subfield; # skip if not mapped to MARC field
1947         if (my $field = $item_marc->field($tag)) {
1948             $field->add_subfields($subfield => $mungeditem->{$item_field});
1949         } else {
1950             my $add_subfields = [];
1951             if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
1952                 $add_subfields = $unlinked_item_subfields;
1953             }
1954             $item_marc->add_fields( $tag, " ", " ", $subfield =>  $mungeditem->{$item_field}, @$add_subfields);
1955         }
1956     }
1957
1958     return $item_marc;
1959 }
1960
1961 =head2 _add_item_field_to_biblio
1962
1963 =over 4
1964
1965 _add_item_field_to_biblio($item_marc, $biblionumber, $frameworkcode);
1966
1967 =back
1968
1969 Adds the fields from a MARC record containing the
1970 representation of a Koha item record to the MARC
1971 biblio record.  The input C<$item_marc> record
1972 is expect to contain just one field, the embedded
1973 item information field.
1974
1975 =cut
1976
1977 sub _add_item_field_to_biblio {
1978     my ($item_marc, $biblionumber, $frameworkcode) = @_;
1979
1980     my $biblio_marc = GetMarcBiblio($biblionumber);
1981     foreach my $field ($item_marc->fields()) {
1982         $biblio_marc->append_fields($field);
1983     }
1984
1985     ModBiblioMarc($biblio_marc, $biblionumber, $frameworkcode);
1986 }
1987
1988 =head2 _replace_item_field_in_biblio
1989
1990 =over
1991
1992 &_replace_item_field_in_biblio($item_marc, $biblionumber, $itemnumber, $frameworkcode)
1993
1994 =back
1995
1996 Given a MARC::Record C<$item_marc> containing one tag with the MARC
1997 representation of the item, examine the biblio MARC
1998 for the corresponding tag for that item and
1999 replace it with the tag from C<$item_marc>.
2000
2001 =cut
2002
2003 sub _replace_item_field_in_biblio {
2004     my ($ItemRecord, $biblionumber, $itemnumber, $frameworkcode) = @_;
2005     my $dbh = C4::Context->dbh;
2006
2007     # get complete MARC record & replace the item field by the new one
2008     my $completeRecord = GetMarcBiblio($biblionumber);
2009     my ($itemtag,$itemsubfield) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
2010     my $itemField = $ItemRecord->field($itemtag);
2011     my @items = $completeRecord->field($itemtag);
2012     my $found = 0;
2013     foreach (@items) {
2014         if ($_->subfield($itemsubfield) eq $itemnumber) {
2015             $_->replace_with($itemField);
2016             $found = 1;
2017         }
2018     }
2019
2020     unless ($found) {
2021         # If we haven't found the matching field,
2022         # just add it.  However, this means that
2023         # there is likely a bug.
2024         $completeRecord->append_fields($itemField);
2025     }
2026
2027     # save the record
2028     ModBiblioMarc($completeRecord, $biblionumber, $frameworkcode);
2029 }
2030
2031 =head2 _repack_item_errors
2032
2033 Add an error message hash generated by C<CheckItemPreSave>
2034 to a list of errors.
2035
2036 =cut
2037
2038 sub _repack_item_errors {
2039     my $item_sequence_num = shift;
2040     my $item_ref = shift;
2041     my $error_ref = shift;
2042
2043     my @repacked_errors = ();
2044
2045     foreach my $error_code (sort keys %{ $error_ref }) {
2046         my $repacked_error = {};
2047         $repacked_error->{'item_sequence'} = $item_sequence_num;
2048         $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
2049         $repacked_error->{'error_code'} = $error_code;
2050         $repacked_error->{'error_information'} = $error_ref->{$error_code};
2051         push @repacked_errors, $repacked_error;
2052     }
2053
2054     return @repacked_errors;
2055 }
2056
2057 =head2 _get_unlinked_item_subfields
2058
2059 =over 4
2060
2061 my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
2062
2063 =back
2064
2065 =cut
2066
2067 sub _get_unlinked_item_subfields {
2068     my $original_item_marc = shift;
2069     my $frameworkcode = shift;
2070
2071     my $marcstructure = GetMarcStructure(1, $frameworkcode);
2072
2073     # assume that this record has only one field, and that that
2074     # field contains only the item information
2075     my $subfields = [];
2076     my @fields = $original_item_marc->fields();
2077     if ($#fields > -1) {
2078         my $field = $fields[0];
2079             my $tag = $field->tag();
2080         foreach my $subfield ($field->subfields()) {
2081             if (defined $subfield->[1] and
2082                 $subfield->[1] ne '' and
2083                 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
2084                 push @$subfields, $subfield->[0] => $subfield->[1];
2085             }
2086         }
2087     }
2088     return $subfields;
2089 }
2090
2091 =head2 _get_unlinked_subfields_xml
2092
2093 =over 4
2094
2095 my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
2096
2097 =back
2098
2099 =cut
2100
2101 sub _get_unlinked_subfields_xml {
2102     my $unlinked_item_subfields = shift;
2103
2104     my $xml;
2105     if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2106         my $marc = MARC::Record->new();
2107         # use of tag 999 is arbitrary, and doesn't need to match the item tag
2108         # used in the framework
2109         $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
2110         $marc->encoding("UTF-8");
2111         $xml = $marc->as_xml("USMARC");
2112     }
2113
2114     return $xml;
2115 }
2116
2117 =head2 _parse_unlinked_item_subfields_from_xml
2118
2119 =over 4
2120
2121 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2122
2123 =back
2124
2125 =cut
2126
2127 sub  _parse_unlinked_item_subfields_from_xml {
2128     my $xml = shift;
2129
2130     return unless defined $xml and $xml ne "";
2131     my $marc = MARC::Record->new_from_xml(StripNonXmlChars($xml),'UTF-8');
2132     my $unlinked_subfields = [];
2133     my @fields = $marc->fields();
2134     if ($#fields > -1) {
2135         foreach my $subfield ($fields[0]->subfields()) {
2136             push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2137         }
2138     }
2139     return $unlinked_subfields;
2140 }
2141
2142 1;