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