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