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