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