3 # Copyright 2007 LibLime, Inc.
4 # Parts Copyright Biblibre 2010
6 # This file is part of Koha.
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
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.
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.
22 #use warnings; FIXME - Bug 2505
28 use C4::Dates qw/format_date format_date_in_iso/;
32 use List::MoreUtils qw/any/;
33 use Data::Dumper; # used as part of logging item record changes, not just for
34 # debugging; so please don't remove this
36 use vars qw($VERSION @ISA @EXPORT);
39 $VERSION = 3.07.00.049;
42 @ISA = qw( Exporter );
65 GetItemsByBiblioitemnumber
69 GetItemnumbersForBiblio
71 get_hostitemnumbers_of
72 GetItemnumberFromBarcode
73 GetBarcodeFromItemnumber
87 PrepareItemrecordDisplay
94 C4::Items - item management functions
98 This module contains an API for manipulating item
99 records in Koha, and is used by cataloguing, circulation,
100 acquisitions, and serials management.
102 A Koha item record is stored in two places: the
103 items table and embedded in a MARC tag in the XML
104 version of the associated bib record in C<biblioitems.marcxml>.
105 This is done to allow the item information to be readily
106 indexed (e.g., by Zebra), but means that each item
107 modification transaction must keep the items table
108 and the MARC XML in sync at all times.
110 Consequently, all code that creates, modifies, or deletes
111 item records B<must> use an appropriate function from
112 C<C4::Items>. If no existing function is suitable, it is
113 better to add one to C<C4::Items> than to use add
114 one-off SQL statements to add or modify items.
116 The items table will be considered authoritative. In other
117 words, if there is ever a discrepancy between the items
118 table and the MARC XML, the items table should be considered
121 =head1 HISTORICAL NOTE
123 Most of the functions in C<C4::Items> were originally in
124 the C<C4::Biblio> module.
126 =head1 CORE EXPORTED FUNCTIONS
128 The following functions are meant for use by users
135 $item = GetItem($itemnumber,$barcode,$serial);
137 Return item information, for a given itemnumber or barcode.
138 The return value is a hashref mapping item column
139 names to values. If C<$serial> is true, include serial publication data.
144 my ($itemnumber,$barcode, $serial) = @_;
145 my $dbh = C4::Context->dbh;
148 my $sth = $dbh->prepare("
150 WHERE itemnumber = ?");
151 $sth->execute($itemnumber);
152 $data = $sth->fetchrow_hashref;
154 my $sth = $dbh->prepare("
158 $sth->execute($barcode);
159 $data = $sth->fetchrow_hashref;
162 my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=?");
163 $ssth->execute($data->{'itemnumber'}) ;
164 ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
166 #if we don't have an items.itype, use biblioitems.itemtype.
167 if( ! $data->{'itype'} ) {
168 my $sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
169 $sth->execute($data->{'biblionumber'});
170 ($data->{'itype'}) = $sth->fetchrow_array;
177 CartToShelf($itemnumber);
179 Set the current shelving location of the item record
180 to its stored permanent shelving location. This is
181 primarily used to indicate when an item whose current
182 location is a special processing ('PROC') or shelving cart
183 ('CART') location is back in the stacks.
188 my ( $itemnumber ) = @_;
190 unless ( $itemnumber ) {
191 croak "FAILED CartToShelf() - no itemnumber supplied";
194 my $item = GetItem($itemnumber);
195 if ( $item->{location} eq 'CART' ) {
196 $item->{location} = $item->{permanent_location};
197 ModItem($item, undef, $itemnumber);
203 ShelfToCart($itemnumber);
205 Set the current shelving location of the item
206 to shelving cart ('CART').
211 my ( $itemnumber ) = @_;
213 unless ( $itemnumber ) {
214 croak "FAILED ShelfToCart() - no itemnumber supplied";
217 my $item = GetItem($itemnumber);
218 $item->{'location'} = 'CART';
219 ModItem($item, undef, $itemnumber);
222 =head2 AddItemFromMarc
224 my ($biblionumber, $biblioitemnumber, $itemnumber)
225 = AddItemFromMarc($source_item_marc, $biblionumber);
227 Given a MARC::Record object containing an embedded item
228 record and a biblionumber, create a new item record.
232 sub AddItemFromMarc {
233 my ( $source_item_marc, $biblionumber ) = @_;
234 my $dbh = C4::Context->dbh;
236 # parse item hash from MARC
237 my $frameworkcode = GetFrameworkCode( $biblionumber );
238 my ($itemtag,$itemsubfield)=GetMarcFromKohaField("items.itemnumber",$frameworkcode);
240 my $localitemmarc=MARC::Record->new;
241 $localitemmarc->append_fields($source_item_marc->field($itemtag));
242 my $item = &TransformMarcToKoha( $dbh, $localitemmarc, $frameworkcode ,'items');
243 my $unlinked_item_subfields = _get_unlinked_item_subfields($localitemmarc, $frameworkcode);
244 return AddItem($item, $biblionumber, $dbh, $frameworkcode, $unlinked_item_subfields);
249 my ($biblionumber, $biblioitemnumber, $itemnumber)
250 = AddItem($item, $biblionumber[, $dbh, $frameworkcode, $unlinked_item_subfields]);
252 Given a hash containing item column names as keys,
253 create a new Koha item record.
255 The first two optional parameters (C<$dbh> and C<$frameworkcode>)
256 do not need to be supplied for general use; they exist
257 simply to allow them to be picked up from AddItemFromMarc.
259 The final optional parameter, C<$unlinked_item_subfields>, contains
260 an arrayref containing subfields present in the original MARC
261 representation of the item (e.g., from the item editor) that are
262 not mapped to C<items> columns directly but should instead
263 be stored in C<items.more_subfields_xml> and included in
264 the biblio items tag for display and indexing.
270 my $biblionumber = shift;
272 my $dbh = @_ ? shift : C4::Context->dbh;
273 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
274 my $unlinked_item_subfields;
276 $unlinked_item_subfields = shift
279 # needs old biblionumber and biblioitemnumber
280 $item->{'biblionumber'} = $biblionumber;
281 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
282 $sth->execute( $item->{'biblionumber'} );
283 ($item->{'biblioitemnumber'}) = $sth->fetchrow;
285 _set_defaults_for_add($item);
286 _set_derived_columns_for_add($item);
287 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
288 # FIXME - checks here
289 unless ( $item->{itype} ) { # default to biblioitem.itemtype if no itype
290 my $itype_sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
291 $itype_sth->execute( $item->{'biblionumber'} );
292 ( $item->{'itype'} ) = $itype_sth->fetchrow_array;
295 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
296 $item->{'itemnumber'} = $itemnumber;
298 ModZebra( $item->{biblionumber}, "specialUpdate", "biblioserver", undef, undef );
300 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
302 return ($item->{biblionumber}, $item->{biblioitemnumber}, $itemnumber);
305 =head2 AddItemBatchFromMarc
307 ($itemnumber_ref, $error_ref) = AddItemBatchFromMarc($record,
308 $biblionumber, $biblioitemnumber, $frameworkcode);
310 Efficiently create item records from a MARC biblio record with
311 embedded item fields. This routine is suitable for batch jobs.
313 This API assumes that the bib record has already been
314 saved to the C<biblio> and C<biblioitems> tables. It does
315 not expect that C<biblioitems.marc> and C<biblioitems.marcxml>
316 are populated, but it will do so via a call to ModBibiloMarc.
318 The goal of this API is to have a similar effect to using AddBiblio
319 and AddItems in succession, but without inefficient repeated
320 parsing of the MARC XML bib record.
322 This function returns an arrayref of new itemsnumbers and an arrayref of item
323 errors encountered during the processing. Each entry in the errors
324 list is a hashref containing the following keys:
330 Sequence number of original item tag in the MARC record.
334 Item barcode, provide to assist in the construction of
335 useful error messages.
339 Code representing the error condition. Can be 'duplicate_barcode',
340 'invalid_homebranch', or 'invalid_holdingbranch'.
342 =item error_information
344 Additional information appropriate to the error condition.
350 sub AddItemBatchFromMarc {
351 my ($record, $biblionumber, $biblioitemnumber, $frameworkcode) = @_;
353 my @itemnumbers = ();
355 my $dbh = C4::Context->dbh;
357 # We modify the record, so lets work on a clone so we don't change the
359 $record = $record->clone();
360 # loop through the item tags and start creating items
361 my @bad_item_fields = ();
362 my ($itemtag, $itemsubfield) = &GetMarcFromKohaField("items.itemnumber",'');
363 my $item_sequence_num = 0;
364 ITEMFIELD: foreach my $item_field ($record->field($itemtag)) {
365 $item_sequence_num++;
366 # we take the item field and stick it into a new
367 # MARC record -- this is required so far because (FIXME)
368 # TransformMarcToKoha requires a MARC::Record, not a MARC::Field
369 # and there is no TransformMarcFieldToKoha
370 my $temp_item_marc = MARC::Record->new();
371 $temp_item_marc->append_fields($item_field);
373 # add biblionumber and biblioitemnumber
374 my $item = TransformMarcToKoha( $dbh, $temp_item_marc, $frameworkcode, 'items' );
375 my $unlinked_item_subfields = _get_unlinked_item_subfields($temp_item_marc, $frameworkcode);
376 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
377 $item->{'biblionumber'} = $biblionumber;
378 $item->{'biblioitemnumber'} = $biblioitemnumber;
380 # check for duplicate barcode
381 my %item_errors = CheckItemPreSave($item);
383 push @errors, _repack_item_errors($item_sequence_num, $item, \%item_errors);
384 push @bad_item_fields, $item_field;
388 _set_defaults_for_add($item);
389 _set_derived_columns_for_add($item);
390 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
391 warn $error if $error;
392 push @itemnumbers, $itemnumber; # FIXME not checking error
393 $item->{'itemnumber'} = $itemnumber;
395 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
397 my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
398 $item_field->replace_with($new_item_marc->field($itemtag));
401 # remove any MARC item fields for rejected items
402 foreach my $item_field (@bad_item_fields) {
403 $record->delete_field($item_field);
406 # update the MARC biblio
407 # $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode );
409 return (\@itemnumbers, \@errors);
412 =head2 ModItemFromMarc
414 ModItemFromMarc($item_marc, $biblionumber, $itemnumber);
416 This function updates an item record based on a supplied
417 C<MARC::Record> object containing an embedded item field.
418 This API is meant for the use of C<additem.pl>; for
419 other purposes, C<ModItem> should be used.
421 This function uses the hash %default_values_for_mod_from_marc,
422 which contains default values for item fields to
423 apply when modifying an item. This is needed beccause
424 if an item field's value is cleared, TransformMarcToKoha
425 does not include the column in the
426 hash that's passed to ModItem, which without
427 use of this hash makes it impossible to clear
428 an item field's value. See bug 2466.
430 Note that only columns that can be directly
431 changed from the cataloging and serials
432 item editors are included in this hash.
438 my %default_values_for_mod_from_marc = (
440 booksellerid => undef,
442 'items.cn_source' => undef,
443 coded_location_qualifier => undef,
446 # dateaccessioned => undef,
448 holdingbranch => undef,
450 itemcallnumber => undef,
455 permanent_location => undef,
460 replacementprice => undef,
461 replacementpricedate => undef,
464 stocknumber => undef,
469 sub ModItemFromMarc {
470 my $item_marc = shift;
471 my $biblionumber = shift;
472 my $itemnumber = shift;
474 my $dbh = C4::Context->dbh;
475 my $frameworkcode = GetFrameworkCode($biblionumber);
476 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
478 my $localitemmarc = MARC::Record->new;
479 $localitemmarc->append_fields( $item_marc->field($itemtag) );
480 my $item = &TransformMarcToKoha( $dbh, $localitemmarc, $frameworkcode, 'items' );
481 foreach my $item_field ( keys %default_values_for_mod_from_marc ) {
482 $item->{$item_field} = $default_values_for_mod_from_marc{$item_field} unless (exists $item->{$item_field});
484 my $unlinked_item_subfields = _get_unlinked_item_subfields( $localitemmarc, $frameworkcode );
486 ModItem($item, $biblionumber, $itemnumber, $dbh, $frameworkcode, $unlinked_item_subfields);
492 ModItem({ column => $newvalue }, $biblionumber, $itemnumber);
494 Change one or more columns in an item record and update
495 the MARC representation of the item.
497 The first argument is a hashref mapping from item column
498 names to the new values. The second and third arguments
499 are the biblionumber and itemnumber, respectively.
501 The fourth, optional parameter, C<$unlinked_item_subfields>, contains
502 an arrayref containing subfields present in the original MARC
503 representation of the item (e.g., from the item editor) that are
504 not mapped to C<items> columns directly but should instead
505 be stored in C<items.more_subfields_xml> and included in
506 the biblio items tag for display and indexing.
508 If one of the changed columns is used to calculate
509 the derived value of a column such as C<items.cn_sort>,
510 this routine will perform the necessary calculation
517 my $biblionumber = shift;
518 my $itemnumber = shift;
520 # if $biblionumber is undefined, get it from the current item
521 unless (defined $biblionumber) {
522 $biblionumber = _get_single_item_column('biblionumber', $itemnumber);
525 my $dbh = @_ ? shift : C4::Context->dbh;
526 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
528 my $unlinked_item_subfields;
530 $unlinked_item_subfields = shift;
531 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
534 $item->{'itemnumber'} = $itemnumber or return;
536 $item->{onloan} = undef if $item->{itemlost};
538 _set_derived_columns_for_mod($item);
539 _do_column_fixes_for_mod($item);
542 # attempt to change itemnumber
543 # attempt to change biblionumber (if we want
544 # an API to relink an item to a different bib,
545 # it should be a separate function)
548 _koha_modify_item($item);
550 # request that bib be reindexed so that searching on current
551 # item status is possible
552 ModZebra( $biblionumber, "specialUpdate", "biblioserver", undef, undef );
554 logaction("CATALOGUING", "MODIFY", $itemnumber, Dumper($item)) if C4::Context->preference("CataloguingLog");
557 =head2 ModItemTransfer
559 ModItemTransfer($itenumber, $frombranch, $tobranch);
561 Marks an item as being transferred from one branch
566 sub ModItemTransfer {
567 my ( $itemnumber, $frombranch, $tobranch ) = @_;
569 my $dbh = C4::Context->dbh;
571 # Remove the 'shelving cart' location status if it is being used.
572 CartToShelf( $itemnumber ) if ( C4::Context->preference("ReturnToShelvingCart") );
574 #new entry in branchtransfers....
575 my $sth = $dbh->prepare(
576 "INSERT INTO branchtransfers (itemnumber, frombranch, datesent, tobranch)
577 VALUES (?, ?, NOW(), ?)");
578 $sth->execute($itemnumber, $frombranch, $tobranch);
580 ModItem({ holdingbranch => $tobranch }, undef, $itemnumber);
581 ModDateLastSeen($itemnumber);
585 =head2 ModDateLastSeen
587 ModDateLastSeen($itemnum);
589 Mark item as seen. Is called when an item is issued, returned or manually marked during inventory/stocktaking.
590 C<$itemnum> is the item number
594 sub ModDateLastSeen {
595 my ($itemnumber) = @_;
597 my $today = C4::Dates->new();
598 ModItem({ itemlost => 0, datelastseen => $today->output("iso") }, undef, $itemnumber);
603 DelItem($dbh, $biblionumber, $itemnumber);
605 Exported function (core API) for deleting an item record in Koha.
610 my ( $dbh, $biblionumber, $itemnumber ) = @_;
612 # FIXME check the item has no current issues
614 _koha_delete_item( $dbh, $itemnumber );
616 # get the MARC record
617 my $record = GetMarcBiblio($biblionumber);
618 ModZebra( $biblionumber, "specialUpdate", "biblioserver", undef, undef );
621 my $copy2deleted = $dbh->prepare("UPDATE deleteditems SET marc=? WHERE itemnumber=?");
622 $copy2deleted->execute( $record->as_usmarc(), $itemnumber );
623 # This last update statement makes that the timestamp column in deleteditems is updated too. If you remove these lines, please add a line to update the timestamp separately. See Bugzilla report 7146 and Biblio.pm (DelBiblio).
625 #search item field code
626 logaction("CATALOGUING", "DELETE", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
629 =head2 CheckItemPreSave
631 my $item_ref = TransformMarcToKoha($marc, 'items');
633 my %errors = CheckItemPreSave($item_ref);
634 if (exists $errors{'duplicate_barcode'}) {
635 print "item has duplicate barcode: ", $errors{'duplicate_barcode'}, "\n";
636 } elsif (exists $errors{'invalid_homebranch'}) {
637 print "item has invalid home branch: ", $errors{'invalid_homebranch'}, "\n";
638 } elsif (exists $errors{'invalid_holdingbranch'}) {
639 print "item has invalid holding branch: ", $errors{'invalid_holdingbranch'}, "\n";
644 Given a hashref containing item fields, determine if it can be
645 inserted or updated in the database. Specifically, checks for
646 database integrity issues, and returns a hash containing any
647 of the following keys, if applicable.
651 =item duplicate_barcode
653 Barcode, if it duplicates one already found in the database.
655 =item invalid_homebranch
657 Home branch, if not defined in branches table.
659 =item invalid_holdingbranch
661 Holding branch, if not defined in branches table.
665 This function does NOT implement any policy-related checks,
666 e.g., whether current operator is allowed to save an
667 item that has a given branch code.
671 sub CheckItemPreSave {
672 my $item_ref = shift;
677 # check for duplicate barcode
678 if (exists $item_ref->{'barcode'} and defined $item_ref->{'barcode'}) {
679 my $existing_itemnumber = GetItemnumberFromBarcode($item_ref->{'barcode'});
680 if ($existing_itemnumber) {
681 if (!exists $item_ref->{'itemnumber'} # new item
682 or $item_ref->{'itemnumber'} != $existing_itemnumber) { # existing item
683 $errors{'duplicate_barcode'} = $item_ref->{'barcode'};
688 # check for valid home branch
689 if (exists $item_ref->{'homebranch'} and defined $item_ref->{'homebranch'}) {
690 my $branch_name = C4::Branch::GetBranchName($item_ref->{'homebranch'});
691 unless (defined $branch_name) {
692 # relies on fact that branches.branchname is a non-NULL column,
693 # so GetBranchName returns undef only if branch does not exist
694 $errors{'invalid_homebranch'} = $item_ref->{'homebranch'};
698 # check for valid holding branch
699 if (exists $item_ref->{'holdingbranch'} and defined $item_ref->{'holdingbranch'}) {
700 my $branch_name = C4::Branch::GetBranchName($item_ref->{'holdingbranch'});
701 unless (defined $branch_name) {
702 # relies on fact that branches.branchname is a non-NULL column,
703 # so GetBranchName returns undef only if branch does not exist
704 $errors{'invalid_holdingbranch'} = $item_ref->{'holdingbranch'};
712 =head1 EXPORTED SPECIAL ACCESSOR FUNCTIONS
714 The following functions provide various ways of
715 getting an item record, a set of item records, or
716 lists of authorized values for certain item fields.
718 Some of the functions in this group are candidates
719 for refactoring -- for example, some of the code
720 in C<GetItemsByBiblioitemnumber> and C<GetItemsInfo>
721 has copy-and-paste work.
727 $itemstatushash = GetItemStatus($fwkcode);
729 Returns a list of valid values for the
730 C<items.notforloan> field.
732 NOTE: does B<not> return an individual item's
735 Can be MARC dependant.
737 But basically could be can be loan or not
738 Create a status selector with the following code
740 =head3 in PERL SCRIPT
742 my $itemstatushash = getitemstatus;
744 foreach my $thisstatus (keys %$itemstatushash) {
745 my %row =(value => $thisstatus,
746 statusname => $itemstatushash->{$thisstatus}->{'statusname'},
748 push @itemstatusloop, \%row;
750 $template->param(statusloop=>\@itemstatusloop);
754 <select name="statusloop">
755 <option value="">Default</option>
756 <!-- TMPL_LOOP name="statusloop" -->
757 <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="statusname" --></option>
765 # returns a reference to a hash of references to status...
768 my $dbh = C4::Context->dbh;
770 $fwk = '' unless ($fwk);
771 my ( $tag, $subfield ) =
772 GetMarcFromKohaField( "items.notforloan", $fwk );
773 if ( $tag and $subfield ) {
776 "SELECT authorised_value
777 FROM marc_subfield_structure
783 $sth->execute( $tag, $subfield, $fwk );
784 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
787 "SELECT authorised_value,lib
788 FROM authorised_values
793 $authvalsth->execute($authorisedvaluecat);
794 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
795 $itemstatus{$authorisedvalue} = $lib;
809 $itemstatus{"1"} = "Not For Loan";
813 =head2 GetItemLocation
815 $itemlochash = GetItemLocation($fwk);
817 Returns a list of valid values for the
818 C<items.location> field.
820 NOTE: does B<not> return an individual item's
823 where fwk stands for an optional framework code.
824 Create a location selector with the following code
826 =head3 in PERL SCRIPT
828 my $itemlochash = getitemlocation;
830 foreach my $thisloc (keys %$itemlochash) {
831 my $selected = 1 if $thisbranch eq $branch;
832 my %row =(locval => $thisloc,
833 selected => $selected,
834 locname => $itemlochash->{$thisloc},
836 push @itemlocloop, \%row;
838 $template->param(itemlocationloop => \@itemlocloop);
842 <select name="location">
843 <option value="">Default</option>
844 <!-- TMPL_LOOP name="itemlocationloop" -->
845 <option value="<!-- TMPL_VAR name="locval" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="locname" --></option>
851 sub GetItemLocation {
853 # returns a reference to a hash of references to location...
856 my $dbh = C4::Context->dbh;
858 $fwk = '' unless ($fwk);
859 my ( $tag, $subfield ) =
860 GetMarcFromKohaField( "items.location", $fwk );
861 if ( $tag and $subfield ) {
864 "SELECT authorised_value
865 FROM marc_subfield_structure
870 $sth->execute( $tag, $subfield, $fwk );
871 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
874 "SELECT authorised_value,lib
875 FROM authorised_values
879 $authvalsth->execute($authorisedvaluecat);
880 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
881 $itemlocation{$authorisedvalue} = $lib;
883 return \%itemlocation;
895 $itemlocation{"1"} = "Not For Loan";
896 return \%itemlocation;
901 $items = GetLostItems( $where, $orderby );
903 This function gets a list of lost items.
909 C<$where> is a hashref. it containts a field of the items table as key
910 and the value to match as value. For example:
912 { barcode => 'abc123',
913 homebranch => 'CPL', }
915 C<$orderby> is a field of the items table by which the resultset
920 C<$items> is a reference to an array full of hashrefs with columns
921 from the "items" table as keys.
923 =item usage in the perl script:
925 my $where = { barcode => '0001548' };
926 my $items = GetLostItems( $where, "homebranch" );
927 $template->param( itemsloop => $items );
934 # Getting input args.
937 my $dbh = C4::Context->dbh;
940 SELECT title, author, lib, itemlost, authorised_value, barcode, datelastseen, price, replacementprice, homebranch,
941 itype, itemtype, holdingbranch, location, itemnotes, items.biblionumber as biblionumber
943 LEFT JOIN biblio ON (items.biblionumber = biblio.biblionumber)
944 LEFT JOIN biblioitems ON (items.biblionumber = biblioitems.biblionumber)
945 LEFT JOIN authorised_values ON (items.itemlost = authorised_values.authorised_value)
947 authorised_values.category = 'LOST'
948 AND itemlost IS NOT NULL
951 my @query_parameters;
952 foreach my $key (keys %$where) {
953 $query .= " AND $key LIKE ?";
954 push @query_parameters, "%$where->{$key}%";
956 my @ordervalues = qw/title author homebranch itype barcode price replacementprice lib datelastseen location/;
958 if ( defined $orderby && grep($orderby, @ordervalues)) {
959 $query .= ' ORDER BY '.$orderby;
962 my $sth = $dbh->prepare($query);
963 $sth->execute( @query_parameters );
965 while ( my $row = $sth->fetchrow_hashref ){
971 =head2 GetItemsForInventory
973 $itemlist = GetItemsForInventory($minlocation, $maxlocation,
974 $location, $itemtype $datelastseen, $branch,
975 $offset, $size, $statushash);
977 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
979 The sub returns a reference to a list of hashes, each containing
980 itemnumber, author, title, barcode, item callnumber, and date last
981 seen. It is ordered by callnumber then title.
983 The required minlocation & maxlocation parameters are used to specify a range of item callnumbers
984 the datelastseen can be used to specify that you want to see items not seen since a past date only.
985 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
986 $statushash requires a hashref that has the authorized values fieldname (intems.notforloan, etc...) as keys, and an arrayref of statuscodes we are searching for as values.
990 sub GetItemsForInventory {
991 my ( $minlocation, $maxlocation,$location, $itemtype, $ignoreissued, $datelastseen, $branchcode, $branch, $offset, $size, $statushash ) = @_;
992 my $dbh = C4::Context->dbh;
993 my ( @bind_params, @where_strings );
995 my $query = <<'END_SQL';
996 SELECT items.itemnumber, barcode, itemcallnumber, title, author, biblio.biblionumber, datelastseen
998 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
999 LEFT JOIN biblioitems on items.biblionumber = biblioitems.biblionumber
1002 for my $authvfield (keys %$statushash){
1003 if ( scalar @{$statushash->{$authvfield}} > 0 ){
1004 my $joinedvals = join ',', @{$statushash->{$authvfield}};
1005 push @where_strings, "$authvfield in (" . $joinedvals . ")";
1011 push @where_strings, 'itemcallnumber >= ?';
1012 push @bind_params, $minlocation;
1016 push @where_strings, 'itemcallnumber <= ?';
1017 push @bind_params, $maxlocation;
1020 if ($datelastseen) {
1021 $datelastseen = format_date_in_iso($datelastseen);
1022 push @where_strings, '(datelastseen < ? OR datelastseen IS NULL)';
1023 push @bind_params, $datelastseen;
1027 push @where_strings, 'items.location = ?';
1028 push @bind_params, $location;
1031 if ( $branchcode ) {
1032 if($branch eq "homebranch"){
1033 push @where_strings, 'items.homebranch = ?';
1035 push @where_strings, 'items.holdingbranch = ?';
1037 push @bind_params, $branchcode;
1041 push @where_strings, 'biblioitems.itemtype = ?';
1042 push @bind_params, $itemtype;
1045 if ( $ignoreissued) {
1046 $query .= "LEFT JOIN issues ON items.itemnumber = issues.itemnumber ";
1047 push @where_strings, 'issues.date_due IS NULL';
1050 if ( @where_strings ) {
1052 $query .= join ' AND ', @where_strings;
1054 $query .= ' ORDER BY items.cn_sort, itemcallnumber, title';
1055 my $sth = $dbh->prepare($query);
1056 $sth->execute( @bind_params );
1060 while ( my $row = $sth->fetchrow_hashref ) {
1061 $offset-- if ($offset);
1062 $row->{datelastseen}=format_date($row->{datelastseen});
1063 if ( ( !$offset ) && $size ) {
1064 push @results, $row;
1071 =head2 GetItemsCount
1073 $count = &GetItemsCount( $biblionumber);
1075 This function return count of item with $biblionumber
1080 my ( $biblionumber ) = @_;
1081 my $dbh = C4::Context->dbh;
1082 my $query = "SELECT count(*)
1084 WHERE biblionumber=?";
1085 my $sth = $dbh->prepare($query);
1086 $sth->execute($biblionumber);
1087 my $count = $sth->fetchrow;
1091 =head2 GetItemInfosOf
1093 GetItemInfosOf(@itemnumbers);
1097 sub GetItemInfosOf {
1098 my @itemnumbers = @_;
1103 WHERE itemnumber IN (' . join( ',', @itemnumbers ) . ')
1105 return get_infos_of( $query, 'itemnumber' );
1108 =head2 GetItemsByBiblioitemnumber
1110 GetItemsByBiblioitemnumber($biblioitemnumber);
1112 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1113 Called by C<C4::XISBN>
1117 sub GetItemsByBiblioitemnumber {
1118 my ( $bibitem ) = @_;
1119 my $dbh = C4::Context->dbh;
1120 my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1121 # Get all items attached to a biblioitem
1124 $sth->execute($bibitem) || die $sth->errstr;
1125 while ( my $data = $sth->fetchrow_hashref ) {
1126 # Foreach item, get circulation information
1127 my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1128 WHERE itemnumber = ?
1129 AND issues.borrowernumber = borrowers.borrowernumber"
1131 $sth2->execute( $data->{'itemnumber'} );
1132 if ( my $data2 = $sth2->fetchrow_hashref ) {
1133 # if item is out, set the due date and who it is out too
1134 $data->{'date_due'} = $data2->{'date_due'};
1135 $data->{'cardnumber'} = $data2->{'cardnumber'};
1136 $data->{'borrowernumber'} = $data2->{'borrowernumber'};
1139 # set date_due to blank, so in the template we check itemlost, and wthdrawn
1140 $data->{'date_due'} = '';
1142 # Find the last 3 people who borrowed this item.
1143 my $query2 = "SELECT * FROM old_issues, borrowers WHERE itemnumber = ?
1144 AND old_issues.borrowernumber = borrowers.borrowernumber
1145 ORDER BY returndate desc,timestamp desc LIMIT 3";
1146 $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1147 $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1149 while ( my $data2 = $sth2->fetchrow_hashref ) {
1150 $data->{"timestamp$i2"} = $data2->{'timestamp'};
1151 $data->{"card$i2"} = $data2->{'cardnumber'};
1152 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
1155 push(@results,$data);
1162 @results = GetItemsInfo($biblionumber);
1164 Returns information about items with the given biblionumber.
1166 C<GetItemsInfo> returns a list of references-to-hash. Each element
1167 contains a number of keys. Most of them are attributes from the
1168 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
1169 Koha database. Other keys include:
1173 =item C<$data-E<gt>{branchname}>
1175 The name (not the code) of the branch to which the book belongs.
1177 =item C<$data-E<gt>{datelastseen}>
1179 This is simply C<items.datelastseen>, except that while the date is
1180 stored in YYYY-MM-DD format in the database, here it is converted to
1181 DD/MM/YYYY format. A NULL date is returned as C<//>.
1183 =item C<$data-E<gt>{datedue}>
1185 =item C<$data-E<gt>{class}>
1187 This is the concatenation of C<biblioitems.classification>, the book's
1188 Dewey code, and C<biblioitems.subclass>.
1190 =item C<$data-E<gt>{ocount}>
1192 I think this is the number of copies of the book available.
1194 =item C<$data-E<gt>{order}>
1196 If this is set, it is set to C<One Order>.
1203 my ( $biblionumber ) = @_;
1204 my $dbh = C4::Context->dbh;
1205 # note biblioitems.* must be avoided to prevent large marc and marcxml fields from killing performance.
1211 biblioitems.itemtype,
1214 biblioitems.publicationyear,
1215 biblioitems.publishercode,
1216 biblioitems.volumedate,
1217 biblioitems.volumedesc,
1220 items.notforloan as itemnotforloan,
1221 itemtypes.description,
1222 itemtypes.notforloan as notforloan_per_itemtype,
1225 holding.opac_info as branch_opac_info
1227 LEFT JOIN branches AS holding ON items.holdingbranch = holding.branchcode
1228 LEFT JOIN branches AS home ON items.homebranch=home.branchcode
1229 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1230 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1231 LEFT JOIN itemtypes ON itemtypes.itemtype = "
1232 . (C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype');
1233 $query .= " WHERE items.biblionumber = ? ORDER BY home.branchname, items.enumchron, LPAD( items.copynumber, 8, '0' ), items.dateaccessioned DESC" ;
1234 my $sth = $dbh->prepare($query);
1235 $sth->execute($biblionumber);
1240 my $isth = $dbh->prepare(
1241 "SELECT issues.*,borrowers.cardnumber,borrowers.surname,borrowers.firstname,borrowers.branchcode as bcode
1242 FROM issues LEFT JOIN borrowers ON issues.borrowernumber=borrowers.borrowernumber
1243 WHERE itemnumber = ?"
1245 my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=? ");
1246 while ( my $data = $sth->fetchrow_hashref ) {
1248 $isth->execute( $data->{'itemnumber'} );
1249 if ( my $idata = $isth->fetchrow_hashref ) {
1250 $data->{borrowernumber} = $idata->{borrowernumber};
1251 $data->{cardnumber} = $idata->{cardnumber};
1252 $data->{surname} = $idata->{surname};
1253 $data->{firstname} = $idata->{firstname};
1254 $data->{lastreneweddate} = $idata->{lastreneweddate};
1255 $datedue = $idata->{'date_due'};
1256 if (C4::Context->preference("IndependantBranches")){
1257 my $userenv = C4::Context->userenv;
1258 if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
1259 $data->{'NOTSAMEBRANCH'} = 1 if ($idata->{'bcode'} ne $userenv->{branch});
1263 if ( $data->{'serial'}) {
1264 $ssth->execute($data->{'itemnumber'}) ;
1265 ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
1268 #get branch information.....
1269 my $bsth = $dbh->prepare(
1270 "SELECT * FROM branches WHERE branchcode = ?
1273 $bsth->execute( $data->{'holdingbranch'} );
1274 if ( my $bdata = $bsth->fetchrow_hashref ) {
1275 $data->{'branchname'} = $bdata->{'branchname'};
1277 $data->{'datedue'} = $datedue;
1279 # get notforloan complete status if applicable
1280 if ( my $code = C4::Koha::GetAuthValCode( 'items.notforloan', $data->{frameworkcode} ) ) {
1281 $data->{notforloanvalue} = C4::Koha::GetAuthorisedValueByCode( $code, $data->{itemnotforloan} );
1284 # get restricted status and description if applicable
1285 if ( my $code = C4::Koha::GetAuthValCode( 'items.restricted', $data->{frameworkcode} ) ) {
1286 $data->{restricted} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{restricted} );
1287 $data->{restrictedopac} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{restricted}, 'opac' );
1290 # my stack procedures
1291 if ( my $code = C4::Koha::GetAuthValCode( 'items.stack', $data->{frameworkcode} ) ) {
1292 $data->{stack} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{stack} );
1294 # Find the last 3 people who borrowed this item.
1295 my $sth2 = $dbh->prepare("SELECT * FROM old_issues,borrowers
1296 WHERE itemnumber = ?
1297 AND old_issues.borrowernumber = borrowers.borrowernumber
1298 ORDER BY returndate DESC
1300 $sth2->execute($data->{'itemnumber'});
1302 while (my $data2 = $sth2->fetchrow_hashref()) {
1303 $data->{"timestamp$ii"} = $data2->{'timestamp'} if $data2->{'timestamp'};
1304 $data->{"card$ii"} = $data2->{'cardnumber'} if $data2->{'cardnumber'};
1305 $data->{"borrower$ii"} = $data2->{'borrowernumber'} if $data2->{'borrowernumber'};
1309 $results[$i] = $data;
1313 return( sort { ($b->{'publisheddate'} || $b->{'enumchron'}) cmp ($a->{'publisheddate'} || $a->{'enumchron'}) } @results );
1319 =head2 GetItemsLocationInfo
1321 my @itemlocinfo = GetItemsLocationInfo($biblionumber);
1323 Returns the branch names, shelving location and itemcallnumber for each item attached to the biblio in question
1325 C<GetItemsInfo> returns a list of references-to-hash. Data returned:
1329 =item C<$data-E<gt>{homebranch}>
1331 Branch Name of the item's homebranch
1333 =item C<$data-E<gt>{holdingbranch}>
1335 Branch Name of the item's holdingbranch
1337 =item C<$data-E<gt>{location}>
1339 Item's shelving location code
1341 =item C<$data-E<gt>{location_intranet}>
1343 The intranet description for the Shelving Location as set in authorised_values 'LOC'
1345 =item C<$data-E<gt>{location_opac}>
1347 The OPAC description for the Shelving Location as set in authorised_values 'LOC'. Falls back to intranet description if no OPAC
1350 =item C<$data-E<gt>{itemcallnumber}>
1352 Item's itemcallnumber
1354 =item C<$data-E<gt>{cn_sort}>
1356 Item's call number normalized for sorting
1362 sub GetItemsLocationInfo {
1363 my $biblionumber = shift;
1366 my $dbh = C4::Context->dbh;
1367 my $query = "SELECT a.branchname as homebranch, b.branchname as holdingbranch,
1368 location, itemcallnumber, cn_sort
1369 FROM items, branches as a, branches as b
1370 WHERE homebranch = a.branchcode AND holdingbranch = b.branchcode
1371 AND biblionumber = ?
1372 ORDER BY cn_sort ASC";
1373 my $sth = $dbh->prepare($query);
1374 $sth->execute($biblionumber);
1376 while ( my $data = $sth->fetchrow_hashref ) {
1377 $data->{location_intranet} = GetKohaAuthorisedValueLib('LOC', $data->{location});
1378 $data->{location_opac}= GetKohaAuthorisedValueLib('LOC', $data->{location}, 1);
1379 push @results, $data;
1384 =head2 GetHostItemsInfo
1386 $hostiteminfo = GetHostItemsInfo($hostfield);
1387 Returns the iteminfo for items linked to records via a host field
1391 sub GetHostItemsInfo {
1393 my @returnitemsInfo;
1395 if (C4::Context->preference('marcflavour') eq 'MARC21' ||
1396 C4::Context->preference('marcflavour') eq 'NORMARC'){
1397 foreach my $hostfield ( $record->field('773') ) {
1398 my $hostbiblionumber = $hostfield->subfield("0");
1399 my $linkeditemnumber = $hostfield->subfield("9");
1400 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1401 foreach my $hostitemInfo (@hostitemInfos){
1402 if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1403 push (@returnitemsInfo,$hostitemInfo);
1408 } elsif ( C4::Context->preference('marcflavour') eq 'UNIMARC'){
1409 foreach my $hostfield ( $record->field('461') ) {
1410 my $hostbiblionumber = $hostfield->subfield("0");
1411 my $linkeditemnumber = $hostfield->subfield("9");
1412 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1413 foreach my $hostitemInfo (@hostitemInfos){
1414 if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1415 push (@returnitemsInfo,$hostitemInfo);
1421 return @returnitemsInfo;
1425 =head2 GetLastAcquisitions
1427 my $lastacq = GetLastAcquisitions({'branches' => ('branch1','branch2'),
1428 'itemtypes' => ('BK','BD')}, 10);
1432 sub GetLastAcquisitions {
1433 my ($data,$max) = @_;
1435 my $itemtype = C4::Context->preference('item-level_itypes') ? 'itype' : 'itemtype';
1437 my $number_of_branches = @{$data->{branches}};
1438 my $number_of_itemtypes = @{$data->{itemtypes}};
1441 my @where = ('WHERE 1 ');
1442 $number_of_branches and push @where
1443 , 'AND holdingbranch IN ('
1444 , join(',', ('?') x $number_of_branches )
1448 $number_of_itemtypes and push @where
1449 , "AND $itemtype IN ("
1450 , join(',', ('?') x $number_of_itemtypes )
1454 my $query = "SELECT biblio.biblionumber as biblionumber, title, dateaccessioned
1455 FROM items RIGHT JOIN biblio ON (items.biblionumber=biblio.biblionumber)
1456 RIGHT JOIN biblioitems ON (items.biblioitemnumber=biblioitems.biblioitemnumber)
1458 GROUP BY biblio.biblionumber
1459 ORDER BY dateaccessioned DESC LIMIT $max";
1461 my $dbh = C4::Context->dbh;
1462 my $sth = $dbh->prepare($query);
1464 $sth->execute((@{$data->{branches}}, @{$data->{itemtypes}}));
1467 while( my $row = $sth->fetchrow_hashref){
1468 push @results, {date => $row->{dateaccessioned}
1469 , biblionumber => $row->{biblionumber}
1470 , title => $row->{title}};
1476 =head2 GetItemnumbersForBiblio
1478 my $itemnumbers = GetItemnumbersForBiblio($biblionumber);
1480 Given a single biblionumber, return an arrayref of all the corresponding itemnumbers
1484 sub GetItemnumbersForBiblio {
1485 my $biblionumber = shift;
1487 my $dbh = C4::Context->dbh;
1488 my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber = ?");
1489 $sth->execute($biblionumber);
1490 while (my $result = $sth->fetchrow_hashref) {
1491 push @items, $result->{'itemnumber'};
1496 =head2 get_itemnumbers_of
1498 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1500 Given a list of biblionumbers, return the list of corresponding itemnumbers
1501 for each biblionumber.
1503 Return a reference on a hash where keys are biblionumbers and values are
1504 references on array of itemnumbers.
1508 sub get_itemnumbers_of {
1509 my @biblionumbers = @_;
1511 my $dbh = C4::Context->dbh;
1517 WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1519 my $sth = $dbh->prepare($query);
1520 $sth->execute(@biblionumbers);
1524 while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1525 push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1528 return \%itemnumbers_of;
1531 =head2 get_hostitemnumbers_of
1533 my @itemnumbers_of = get_hostitemnumbers_of($biblionumber);
1535 Given a biblionumber, return the list of corresponding itemnumbers that are linked to it via host fields
1537 Return a reference on a hash where key is a biblionumber and values are
1538 references on array of itemnumbers.
1543 sub get_hostitemnumbers_of {
1544 my ($biblionumber) = @_;
1545 my $marcrecord = GetMarcBiblio($biblionumber);
1546 my (@returnhostitemnumbers,$tag, $biblio_s, $item_s);
1548 my $marcflavor = C4::Context->preference('marcflavour');
1549 if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1553 } elsif ($marcflavor eq 'UNIMARC') {
1559 foreach my $hostfield ( $marcrecord->field($tag) ) {
1560 my $hostbiblionumber = $hostfield->subfield($biblio_s);
1561 my $linkeditemnumber = $hostfield->subfield($item_s);
1563 if (my $itemnumbers = get_itemnumbers_of($hostbiblionumber)->{$hostbiblionumber})
1565 @itemnumbers = @$itemnumbers;
1567 foreach my $itemnumber (@itemnumbers){
1568 if ($itemnumber eq $linkeditemnumber){
1569 push (@returnhostitemnumbers,$itemnumber);
1574 return @returnhostitemnumbers;
1578 =head2 GetItemnumberFromBarcode
1580 $result = GetItemnumberFromBarcode($barcode);
1584 sub GetItemnumberFromBarcode {
1586 my $dbh = C4::Context->dbh;
1589 $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1590 $rq->execute($barcode);
1591 my ($result) = $rq->fetchrow;
1595 =head2 GetBarcodeFromItemnumber
1597 $result = GetBarcodeFromItemnumber($itemnumber);
1601 sub GetBarcodeFromItemnumber {
1602 my ($itemnumber) = @_;
1603 my $dbh = C4::Context->dbh;
1606 $dbh->prepare("SELECT barcode FROM items WHERE items.itemnumber=?");
1607 $rq->execute($itemnumber);
1608 my ($result) = $rq->fetchrow;
1612 =head2 GetHiddenItemnumbers
1616 $result = GetHiddenItemnumbers(@items);
1622 sub GetHiddenItemnumbers {
1626 my $yaml = C4::Context->preference('OpacHiddenItems');
1627 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1630 $hidingrules = YAML::Load($yaml);
1633 warn "Unable to parse OpacHiddenItems syspref : $@";
1636 my $dbh = C4::Context->dbh;
1639 foreach my $item (@items) {
1641 # We check each rule
1642 foreach my $field (keys %$hidingrules) {
1644 if (exists $item->{$field}) {
1645 $val = $item->{$field};
1648 my $query = "SELECT $field from items where itemnumber = ?";
1649 $val = $dbh->selectrow_array($query, undef, $item->{'itemnumber'});
1651 $val = '' unless defined $val;
1653 # If the results matches the values in the yaml file
1654 if (any { $val eq $_ } @{$hidingrules->{$field}}) {
1656 # We add the itemnumber to the list
1657 push @resultitems, $item->{'itemnumber'};
1659 # If at least one rule matched for an item, no need to test the others
1664 return @resultitems;
1667 =head3 get_item_authorised_values
1669 find the types and values for all authorised values assigned to this item.
1671 parameters: itemnumber
1673 returns: a hashref malling the authorised value to the value set for this itemnumber
1675 $authorised_values = {
1681 'RESTRICTED' => undef,
1684 'branches' => 'CPL',
1685 'cn_source' => undef,
1686 'itemtypes' => 'SER',
1689 Notes: see C4::Biblio::get_biblio_authorised_values for a similar method at the biblio level.
1693 sub get_item_authorised_values {
1694 my $itemnumber = shift;
1696 # assume that these entries in the authorised_value table are item level.
1697 my $query = q(SELECT distinct authorised_value, kohafield
1698 FROM marc_subfield_structure
1699 WHERE kohafield like 'item%'
1700 AND authorised_value != '' );
1702 my $itemlevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
1703 my $iteminfo = GetItem( $itemnumber );
1704 # warn( Data::Dumper->Dump( [ $itemlevel_authorised_values ], [ 'itemlevel_authorised_values' ] ) );
1706 foreach my $this_authorised_value ( keys %$itemlevel_authorised_values ) {
1707 my $field = $itemlevel_authorised_values->{ $this_authorised_value }->{'kohafield'};
1708 $field =~ s/^items\.//;
1709 if ( exists $iteminfo->{ $field } ) {
1710 $return->{ $this_authorised_value } = $iteminfo->{ $field };
1713 # warn( Data::Dumper->Dump( [ $return ], [ 'return' ] ) );
1717 =head3 get_authorised_value_images
1719 find a list of icons that are appropriate for display based on the
1720 authorised values for a biblio.
1722 parameters: listref of authorised values, such as comes from
1723 get_item_authorised_values or
1724 from C4::Biblio::get_biblio_authorised_values
1726 returns: listref of hashrefs for each image. Each hashref looks like this:
1728 { imageurl => '/intranet-tmpl/prog/img/itemtypeimg/npl/WEB.gif',
1733 Notes: Currently, I put on the full path to the images on the staff
1734 side. This should either be configurable or not done at all. Since I
1735 have to deal with 'intranet' or 'opac' in
1736 get_biblio_authorised_values, perhaps I should be passing it in.
1740 sub get_authorised_value_images {
1741 my $authorised_values = shift;
1745 my $authorised_value_list = GetAuthorisedValues();
1746 # warn ( Data::Dumper->Dump( [ $authorised_value_list ], [ 'authorised_value_list' ] ) );
1747 foreach my $this_authorised_value ( @$authorised_value_list ) {
1748 if ( exists $authorised_values->{ $this_authorised_value->{'category'} }
1749 && $authorised_values->{ $this_authorised_value->{'category'} } eq $this_authorised_value->{'authorised_value'} ) {
1750 # warn ( Data::Dumper->Dump( [ $this_authorised_value ], [ 'this_authorised_value' ] ) );
1751 if ( defined $this_authorised_value->{'imageurl'} ) {
1752 push @imagelist, { imageurl => C4::Koha::getitemtypeimagelocation( 'intranet', $this_authorised_value->{'imageurl'} ),
1753 label => $this_authorised_value->{'lib'},
1754 category => $this_authorised_value->{'category'},
1755 value => $this_authorised_value->{'authorised_value'}, };
1760 # warn ( Data::Dumper->Dump( [ \@imagelist ], [ 'imagelist' ] ) );
1765 =head1 LIMITED USE FUNCTIONS
1767 The following functions, while part of the public API,
1768 are not exported. This is generally because they are
1769 meant to be used by only one script for a specific
1770 purpose, and should not be used in any other context
1771 without careful thought.
1777 my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1779 Returns MARC::Record of the item passed in parameter.
1780 This function is meant for use only in C<cataloguing/additem.pl>,
1781 where it is needed to support that script's MARC-like
1787 my ( $biblionumber, $itemnumber ) = @_;
1789 # GetMarcItem has been revised so that it does the following:
1790 # 1. Gets the item information from the items table.
1791 # 2. Converts it to a MARC field for storage in the bib record.
1793 # The previous behavior was:
1794 # 1. Get the bib record.
1795 # 2. Return the MARC tag corresponding to the item record.
1797 # The difference is that one treats the items row as authoritative,
1798 # while the other treats the MARC representation as authoritative
1799 # under certain circumstances.
1801 my $itemrecord = GetItem($itemnumber);
1803 # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1804 # Also, don't emit a subfield if the underlying field is blank.
1807 return Item2Marc($itemrecord,$biblionumber);
1811 my ($itemrecord,$biblionumber)=@_;
1814 defined($itemrecord->{$_}) && $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : ()
1815 } keys %{ $itemrecord }
1817 my $itemmarc = TransformKohaToMarc($mungeditem);
1818 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",GetFrameworkCode($biblionumber)||'');
1820 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1821 if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1822 foreach my $field ($itemmarc->field($itemtag)){
1823 $field->add_subfields(@$unlinked_item_subfields);
1829 =head1 PRIVATE FUNCTIONS AND VARIABLES
1831 The following functions are not meant to be called
1832 directly, but are documented in order to explain
1833 the inner workings of C<C4::Items>.
1837 =head2 %derived_columns
1839 This hash keeps track of item columns that
1840 are strictly derived from other columns in
1841 the item record and are not meant to be set
1844 Each key in the hash should be the name of a
1845 column (as named by TransformMarcToKoha). Each
1846 value should be hashref whose keys are the
1847 columns on which the derived column depends. The
1848 hashref should also contain a 'BUILDER' key
1849 that is a reference to a sub that calculates
1854 my %derived_columns = (
1855 'items.cn_sort' => {
1856 'itemcallnumber' => 1,
1857 'items.cn_source' => 1,
1858 'BUILDER' => \&_calc_items_cn_sort,
1862 =head2 _set_derived_columns_for_add
1864 _set_derived_column_for_add($item);
1866 Given an item hash representing a new item to be added,
1867 calculate any derived columns. Currently the only
1868 such column is C<items.cn_sort>.
1872 sub _set_derived_columns_for_add {
1875 foreach my $column (keys %derived_columns) {
1876 my $builder = $derived_columns{$column}->{'BUILDER'};
1877 my $source_values = {};
1878 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1879 next if $source_column eq 'BUILDER';
1880 $source_values->{$source_column} = $item->{$source_column};
1882 $builder->($item, $source_values);
1886 =head2 _set_derived_columns_for_mod
1888 _set_derived_column_for_mod($item);
1890 Given an item hash representing a new item to be modified.
1891 calculate any derived columns. Currently the only
1892 such column is C<items.cn_sort>.
1894 This routine differs from C<_set_derived_columns_for_add>
1895 in that it needs to handle partial item records. In other
1896 words, the caller of C<ModItem> may have supplied only one
1897 or two columns to be changed, so this function needs to
1898 determine whether any of the columns to be changed affect
1899 any of the derived columns. Also, if a derived column
1900 depends on more than one column, but the caller is not
1901 changing all of then, this routine retrieves the unchanged
1902 values from the database in order to ensure a correct
1907 sub _set_derived_columns_for_mod {
1910 foreach my $column (keys %derived_columns) {
1911 my $builder = $derived_columns{$column}->{'BUILDER'};
1912 my $source_values = {};
1913 my %missing_sources = ();
1914 my $must_recalc = 0;
1915 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1916 next if $source_column eq 'BUILDER';
1917 if (exists $item->{$source_column}) {
1919 $source_values->{$source_column} = $item->{$source_column};
1921 $missing_sources{$source_column} = 1;
1925 foreach my $source_column (keys %missing_sources) {
1926 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
1928 $builder->($item, $source_values);
1933 =head2 _do_column_fixes_for_mod
1935 _do_column_fixes_for_mod($item);
1937 Given an item hashref containing one or more
1938 columns to modify, fix up certain values.
1939 Specifically, set to 0 any passed value
1940 of C<notforloan>, C<damaged>, C<itemlost>, or
1941 C<wthdrawn> that is either undefined or
1942 contains the empty string.
1946 sub _do_column_fixes_for_mod {
1949 if (exists $item->{'notforloan'} and
1950 (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
1951 $item->{'notforloan'} = 0;
1953 if (exists $item->{'damaged'} and
1954 (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
1955 $item->{'damaged'} = 0;
1957 if (exists $item->{'itemlost'} and
1958 (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
1959 $item->{'itemlost'} = 0;
1961 if (exists $item->{'wthdrawn'} and
1962 (not defined $item->{'wthdrawn'} or $item->{'wthdrawn'} eq '')) {
1963 $item->{'wthdrawn'} = 0;
1965 if (exists $item->{'location'} && !exists $item->{'permanent_location'}) {
1966 $item->{'permanent_location'} = $item->{'location'};
1968 if (exists $item->{'timestamp'}) {
1969 delete $item->{'timestamp'};
1973 =head2 _get_single_item_column
1975 _get_single_item_column($column, $itemnumber);
1977 Retrieves the value of a single column from an C<items>
1978 row specified by C<$itemnumber>.
1982 sub _get_single_item_column {
1984 my $itemnumber = shift;
1986 my $dbh = C4::Context->dbh;
1987 my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
1988 $sth->execute($itemnumber);
1989 my ($value) = $sth->fetchrow();
1993 =head2 _calc_items_cn_sort
1995 _calc_items_cn_sort($item, $source_values);
1997 Helper routine to calculate C<items.cn_sort>.
2001 sub _calc_items_cn_sort {
2003 my $source_values = shift;
2005 $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
2008 =head2 _set_defaults_for_add
2010 _set_defaults_for_add($item_hash);
2012 Given an item hash representing an item to be added, set
2013 correct default values for columns whose default value
2014 is not handled by the DBMS. This includes the following
2021 C<items.dateaccessioned>
2043 sub _set_defaults_for_add {
2045 $item->{dateaccessioned} ||= C4::Dates->new->output('iso');
2046 $item->{$_} ||= 0 for (qw( notforloan damaged itemlost wthdrawn));
2049 =head2 _koha_new_item
2051 my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
2053 Perform the actual insert into the C<items> table.
2057 sub _koha_new_item {
2058 my ( $item, $barcode ) = @_;
2059 my $dbh=C4::Context->dbh;
2062 "INSERT INTO items SET
2064 biblioitemnumber = ?,
2066 dateaccessioned = ?,
2070 replacementprice = ?,
2071 replacementpricedate = ?,
2072 datelastborrowed = ?,
2080 coded_location_qualifier = ?,
2086 permanent_location = ?,
2098 more_subfields_xml = ?,
2102 my $sth = $dbh->prepare($query);
2103 my $today = C4::Dates->today('iso');
2105 $item->{'biblionumber'},
2106 $item->{'biblioitemnumber'},
2108 $item->{'dateaccessioned'},
2109 $item->{'booksellerid'},
2110 $item->{'homebranch'},
2112 $item->{'replacementprice'},
2113 $item->{'replacementpricedate'} || $today,
2114 $item->{datelastborrowed},
2115 $item->{datelastseen} || $today,
2117 $item->{'notforloan'},
2119 $item->{'itemlost'},
2120 $item->{'wthdrawn'},
2121 $item->{'itemcallnumber'},
2122 $item->{'coded_location_qualifier'},
2123 $item->{'restricted'},
2124 $item->{'itemnotes'},
2125 $item->{'holdingbranch'},
2127 $item->{'location'},
2128 $item->{'permanent_location'},
2131 $item->{'renewals'},
2132 $item->{'reserves'},
2133 $item->{'items.cn_source'},
2134 $item->{'items.cn_sort'},
2137 $item->{'materials'},
2139 $item->{'enumchron'},
2140 $item->{'more_subfields_xml'},
2141 $item->{'copynumber'},
2142 $item->{'stocknumber'},
2146 if ( defined $sth->errstr ) {
2147 $error.="ERROR in _koha_new_item $query".$sth->errstr;
2150 $itemnumber = $dbh->{'mysql_insertid'};
2153 return ( $itemnumber, $error );
2156 =head2 MoveItemFromBiblio
2158 MoveItemFromBiblio($itenumber, $frombiblio, $tobiblio);
2160 Moves an item from a biblio to another
2162 Returns undef if the move failed or the biblionumber of the destination record otherwise
2166 sub MoveItemFromBiblio {
2167 my ($itemnumber, $frombiblio, $tobiblio) = @_;
2168 my $dbh = C4::Context->dbh;
2169 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber = ?");
2170 $sth->execute( $tobiblio );
2171 my ( $tobiblioitem ) = $sth->fetchrow();
2172 $sth = $dbh->prepare("UPDATE items SET biblioitemnumber = ?, biblionumber = ? WHERE itemnumber = ? AND biblionumber = ?");
2173 my $return = $sth->execute($tobiblioitem, $tobiblio, $itemnumber, $frombiblio);
2175 ModZebra( $tobiblio, "specialUpdate", "biblioserver", undef, undef );
2176 ModZebra( $frombiblio, "specialUpdate", "biblioserver", undef, undef );
2177 # Checking if the item we want to move is in an order
2178 require C4::Acquisition;
2179 my $order = C4::Acquisition::GetOrderFromItemnumber($itemnumber);
2181 # Replacing the biblionumber within the order if necessary
2182 $order->{'biblionumber'} = $tobiblio;
2183 C4::Acquisition::ModOrder($order);
2192 DelItemCheck($dbh, $biblionumber, $itemnumber);
2194 Exported function (core API) for deleting an item record in Koha if there no current issue.
2199 my ( $dbh, $biblionumber, $itemnumber ) = @_;
2202 my $countanalytics=GetAnalyticsCount($itemnumber);
2205 # check that there is no issue on this item before deletion.
2206 my $sth=$dbh->prepare("select * from issues i where i.itemnumber=?");
2207 $sth->execute($itemnumber);
2209 my $item = GetItem($itemnumber);
2210 my $onloan=$sth->fetchrow;
2213 $error = "book_on_loan"
2215 elsif ( !(C4::Context->userenv->{flags} & 1) and
2216 C4::Context->preference("IndependantBranches") and
2217 (C4::Context->userenv->{branch} ne
2218 $item->{C4::Context->preference("HomeOrHoldingBranch")||'homebranch'}) )
2220 $error = "not_same_branch";
2223 # check it doesnt have a waiting reserve
2224 $sth=$dbh->prepare("SELECT * FROM reserves WHERE (found = 'W' or found = 'T') AND itemnumber = ?");
2225 $sth->execute($itemnumber);
2226 my $reserve=$sth->fetchrow;
2228 $error = "book_reserved";
2229 } elsif ($countanalytics > 0){
2230 $error = "linked_analytics";
2232 DelItem($dbh, $biblionumber, $itemnumber);
2239 =head2 _koha_modify_item
2241 my ($itemnumber,$error) =_koha_modify_item( $item );
2243 Perform the actual update of the C<items> row. Note that this
2244 routine accepts a hashref specifying the columns to update.
2248 sub _koha_modify_item {
2250 my $dbh=C4::Context->dbh;
2253 my $query = "UPDATE items SET ";
2255 for my $key ( keys %$item ) {
2257 push @bind, $item->{$key};
2260 $query .= " WHERE itemnumber=?";
2261 push @bind, $item->{'itemnumber'};
2262 my $sth = C4::Context->dbh->prepare($query);
2263 $sth->execute(@bind);
2264 if ( C4::Context->dbh->errstr ) {
2265 $error.="ERROR in _koha_modify_item $query".$dbh->errstr;
2268 return ($item->{'itemnumber'},$error);
2271 =head2 _koha_delete_item
2273 _koha_delete_item( $dbh, $itemnum );
2275 Internal function to delete an item record from the koha tables
2279 sub _koha_delete_item {
2280 my ( $dbh, $itemnum ) = @_;
2282 # save the deleted item to deleteditems table
2283 my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
2284 $sth->execute($itemnum);
2285 my $data = $sth->fetchrow_hashref();
2286 my $query = "INSERT INTO deleteditems SET ";
2288 foreach my $key ( keys %$data ) {
2289 $query .= "$key = ?,";
2290 push( @bind, $data->{$key} );
2293 $sth = $dbh->prepare($query);
2294 $sth->execute(@bind);
2296 # delete from items table
2297 $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
2298 $sth->execute($itemnum);
2302 =head2 _marc_from_item_hash
2304 my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
2306 Given an item hash representing a complete item record,
2307 create a C<MARC::Record> object containing an embedded
2308 tag representing that item.
2310 The third, optional parameter C<$unlinked_item_subfields> is
2311 an arrayref of subfields (not mapped to C<items> fields per the
2312 framework) to be added to the MARC representation
2317 sub _marc_from_item_hash {
2319 my $frameworkcode = shift;
2320 my $unlinked_item_subfields;
2322 $unlinked_item_subfields = shift;
2325 # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
2326 # Also, don't emit a subfield if the underlying field is blank.
2327 my $mungeditem = { map { (defined($item->{$_}) and $item->{$_} ne '') ?
2328 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
2329 : () } keys %{ $item } };
2331 my $item_marc = MARC::Record->new();
2332 foreach my $item_field ( keys %{$mungeditem} ) {
2333 my ( $tag, $subfield ) = GetMarcFromKohaField( $item_field, $frameworkcode );
2334 next unless defined $tag and defined $subfield; # skip if not mapped to MARC field
2335 my @values = split(/\s?\|\s?/, $mungeditem->{$item_field}, -1);
2336 foreach my $value (@values){
2337 if ( my $field = $item_marc->field($tag) ) {
2338 $field->add_subfields( $subfield => $value );
2340 my $add_subfields = [];
2341 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2342 $add_subfields = $unlinked_item_subfields;
2344 $item_marc->add_fields( $tag, " ", " ", $subfield => $value, @$add_subfields );
2352 =head2 _repack_item_errors
2354 Add an error message hash generated by C<CheckItemPreSave>
2355 to a list of errors.
2359 sub _repack_item_errors {
2360 my $item_sequence_num = shift;
2361 my $item_ref = shift;
2362 my $error_ref = shift;
2364 my @repacked_errors = ();
2366 foreach my $error_code (sort keys %{ $error_ref }) {
2367 my $repacked_error = {};
2368 $repacked_error->{'item_sequence'} = $item_sequence_num;
2369 $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
2370 $repacked_error->{'error_code'} = $error_code;
2371 $repacked_error->{'error_information'} = $error_ref->{$error_code};
2372 push @repacked_errors, $repacked_error;
2375 return @repacked_errors;
2378 =head2 _get_unlinked_item_subfields
2380 my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
2384 sub _get_unlinked_item_subfields {
2385 my $original_item_marc = shift;
2386 my $frameworkcode = shift;
2388 my $marcstructure = GetMarcStructure(1, $frameworkcode);
2390 # assume that this record has only one field, and that that
2391 # field contains only the item information
2393 my @fields = $original_item_marc->fields();
2394 if ($#fields > -1) {
2395 my $field = $fields[0];
2396 my $tag = $field->tag();
2397 foreach my $subfield ($field->subfields()) {
2398 if (defined $subfield->[1] and
2399 $subfield->[1] ne '' and
2400 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
2401 push @$subfields, $subfield->[0] => $subfield->[1];
2408 =head2 _get_unlinked_subfields_xml
2410 my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
2414 sub _get_unlinked_subfields_xml {
2415 my $unlinked_item_subfields = shift;
2418 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2419 my $marc = MARC::Record->new();
2420 # use of tag 999 is arbitrary, and doesn't need to match the item tag
2421 # used in the framework
2422 $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
2423 $marc->encoding("UTF-8");
2424 $xml = $marc->as_xml("USMARC");
2430 =head2 _parse_unlinked_item_subfields_from_xml
2432 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2436 sub _parse_unlinked_item_subfields_from_xml {
2438 require C4::Charset;
2439 return unless defined $xml and $xml ne "";
2440 my $marc = MARC::Record->new_from_xml(C4::Charset::StripNonXmlChars($xml),'UTF-8');
2441 my $unlinked_subfields = [];
2442 my @fields = $marc->fields();
2443 if ($#fields > -1) {
2444 foreach my $subfield ($fields[0]->subfields()) {
2445 push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2448 return $unlinked_subfields;
2451 =head2 GetAnalyticsCount
2453 $count= &GetAnalyticsCount($itemnumber)
2455 counts Usage of itemnumber in Analytical bibliorecords.
2459 sub GetAnalyticsCount {
2460 my ($itemnumber) = @_;
2462 if (C4::Context->preference('NoZebra')) {
2463 # Read the index Koha-Auth-Number for this authid and count the lines
2464 my $result = C4::Search::NZanalyse("hi=$itemnumber");
2465 my @tab = split /;/,$result;
2468 ### ZOOM search here
2470 $query= "hi=".$itemnumber;
2471 my ($err,$res,$result) = C4::Search::SimpleSearch($query,0,10);
2479 $holds = &GetItemHolds($biblionumber, $itemnumber);
2483 This function return the count of holds with $biblionumber and $itemnumber
2488 my ($biblionumber, $itemnumber) = @_;
2490 my $dbh = C4::Context->dbh;
2491 my $query = "SELECT count(*)
2493 WHERE biblionumber=? AND itemnumber=?";
2494 my $sth = $dbh->prepare($query);
2495 $sth->execute($biblionumber, $itemnumber);
2496 $holds = $sth->fetchrow;
2500 # Return the list of the column names of items table
2501 sub _get_items_columns {
2502 my $dbh = C4::Context->dbh;
2503 my $sth = $dbh->column_info(undef, undef, 'items', '%');
2505 my $results = $sth->fetchall_hashref('COLUMN_NAME');
2506 return keys %$results;
2511 my $items = SearchItems($field, $value);
2513 SearchItems will search for items on a specific given field.
2514 For instance you can search all items with a specific stocknumber like this:
2516 my $items = SearchItems('stocknumber', $stocknumber);
2521 my ($field, $value) = @_;
2523 my $dbh = C4::Context->dbh;
2524 my @columns = _get_items_columns;
2526 if(0 < grep /^$field$/, @columns) {
2527 my $query = "SELECT $field FROM items WHERE $field = ?";
2528 my $sth = $dbh->prepare( $query );
2529 $sth->execute( $value );
2530 $results = $sth->fetchall_arrayref({});
2536 =head1 OTHER FUNCTIONS
2540 ($indicators, $value) = _find_value($tag, $subfield, $record,$encoding);
2542 Find the given $subfield in the given $tag in the given
2543 MARC::Record $record. If the subfield is found, returns
2544 the (indicators, value) pair; otherwise, (undef, undef) is
2548 Such a function is used in addbiblio AND additem and serial-edit and maybe could be used in Authorities.
2549 I suggest we export it from this module.
2554 my ( $tagfield, $insubfield, $record, $encoding ) = @_;
2557 if ( $tagfield < 10 ) {
2558 if ( $record->field($tagfield) ) {
2559 push @result, $record->field($tagfield)->data();
2564 foreach my $field ( $record->field($tagfield) ) {
2565 my @subfields = $field->subfields();
2566 foreach my $subfield (@subfields) {
2567 if ( @$subfield[0] eq $insubfield ) {
2568 push @result, @$subfield[1];
2569 $indicator = $field->indicator(1) . $field->indicator(2);
2574 return ( $indicator, @result );
2578 =head2 PrepareItemrecordDisplay
2580 PrepareItemrecordDisplay($itemrecord,$bibnum,$itemumber,$frameworkcode);
2582 Returns a hash with all the fields for Display a given item data in a template
2584 The $frameworkcode returns the item for the given frameworkcode, ONLY if bibnum is not provided
2588 sub PrepareItemrecordDisplay {
2590 my ( $bibnum, $itemnum, $defaultvalues, $frameworkcode ) = @_;
2592 my $dbh = C4::Context->dbh;
2593 $frameworkcode = &GetFrameworkCode($bibnum) if $bibnum;
2594 my ( $itemtagfield, $itemtagsubfield ) = &GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
2595 my $tagslib = &GetMarcStructure( 1, $frameworkcode );
2597 # return nothing if we don't have found an existing framework.
2598 return q{} unless $tagslib;
2601 $itemrecord = C4::Items::GetMarcItem( $bibnum, $itemnum );
2604 my $authorised_values_sth = $dbh->prepare( "SELECT authorised_value,lib FROM authorised_values WHERE category=? ORDER BY lib" );
2605 foreach my $tag ( sort keys %{$tagslib} ) {
2606 my $previous_tag = '';
2609 # loop through each subfield
2611 foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
2612 next if ( subfield_is_koha_internal_p($subfield) );
2613 next if ( $tagslib->{$tag}->{$subfield}->{'tab'} ne "10" );
2615 $subfield_data{tag} = $tag;
2616 $subfield_data{subfield} = $subfield;
2617 $subfield_data{countsubfield} = $cntsubf++;
2618 $subfield_data{kohafield} = $tagslib->{$tag}->{$subfield}->{'kohafield'};
2619 $subfield_data{id} = "tag_".$tag."_subfield_".$subfield."_".int(rand(1000000));
2621 # $subfield_data{marc_lib}=$tagslib->{$tag}->{$subfield}->{lib};
2622 $subfield_data{marc_lib} = $tagslib->{$tag}->{$subfield}->{lib};
2623 $subfield_data{mandatory} = $tagslib->{$tag}->{$subfield}->{mandatory};
2624 $subfield_data{repeatable} = $tagslib->{$tag}->{$subfield}->{repeatable};
2625 $subfield_data{hidden} = "display:none"
2626 if $tagslib->{$tag}->{$subfield}->{hidden};
2627 my ( $x, $defaultvalue );
2629 ( $x, $defaultvalue ) = _find_value( $tag, $subfield, $itemrecord );
2631 $defaultvalue = $tagslib->{$tag}->{$subfield}->{defaultvalue} unless $defaultvalue;
2632 if ( !defined $defaultvalue ) {
2633 $defaultvalue = q||;
2635 $defaultvalue =~ s/"/"/g;
2637 # search for itemcallnumber if applicable
2638 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.itemcallnumber'
2639 && C4::Context->preference('itemcallnumber') ) {
2640 my $CNtag = substr( C4::Context->preference('itemcallnumber'), 0, 3 );
2641 my $CNsubfield = substr( C4::Context->preference('itemcallnumber'), 3, 1 );
2643 my $temp = $itemrecord->field($CNtag);
2645 $defaultvalue = $temp->subfield($CNsubfield);
2649 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.itemcallnumber'
2651 && $defaultvalues->{'callnumber'} ) {
2654 $temp = $itemrecord->field($subfield);
2657 $defaultvalue = $defaultvalues->{'callnumber'} if $defaultvalues;
2660 if ( ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.holdingbranch' || $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.homebranch' )
2662 && $defaultvalues->{'branchcode'} ) {
2665 $temp = $itemrecord->field($subfield);
2668 $defaultvalue = $defaultvalues->{branchcode} if $defaultvalues;
2671 if ( ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.location' )
2673 && $defaultvalues->{'location'} ) {
2675 my $temp; # make perlcritic happy :)
2676 $temp = $itemrecord->field($subfield) if ($itemrecord);
2679 $defaultvalue = $defaultvalues->{location} if $defaultvalues;
2682 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
2683 my @authorised_values;
2686 # builds list, depending on authorised value...
2688 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
2689 if ( ( C4::Context->preference("IndependantBranches") )
2690 && ( C4::Context->userenv->{flags} % 2 != 1 ) ) {
2691 my $sth = $dbh->prepare( "SELECT branchcode,branchname FROM branches WHERE branchcode = ? ORDER BY branchname" );
2692 $sth->execute( C4::Context->userenv->{branch} );
2693 push @authorised_values, ""
2694 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2695 while ( my ( $branchcode, $branchname ) = $sth->fetchrow_array ) {
2696 push @authorised_values, $branchcode;
2697 $authorised_lib{$branchcode} = $branchname;
2700 my $sth = $dbh->prepare( "SELECT branchcode,branchname FROM branches ORDER BY branchname" );
2702 push @authorised_values, ""
2703 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2704 while ( my ( $branchcode, $branchname ) = $sth->fetchrow_array ) {
2705 push @authorised_values, $branchcode;
2706 $authorised_lib{$branchcode} = $branchname;
2711 } elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "itemtypes" ) {
2712 my $sth = $dbh->prepare( "SELECT itemtype,description FROM itemtypes ORDER BY description" );
2714 push @authorised_values, ""
2715 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2716 while ( my ( $itemtype, $description ) = $sth->fetchrow_array ) {
2717 push @authorised_values, $itemtype;
2718 $authorised_lib{$itemtype} = $description;
2721 } elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "cn_source" ) {
2722 push @authorised_values, "" unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2724 my $class_sources = GetClassSources();
2725 my $default_source = C4::Context->preference("DefaultClassificationSource");
2727 foreach my $class_source (sort keys %$class_sources) {
2728 next unless $class_sources->{$class_source}->{'used'} or
2729 ($class_source eq $default_source);
2730 push @authorised_values, $class_source;
2731 $authorised_lib{$class_source} = $class_sources->{$class_source}->{'description'};
2734 #---- "true" authorised value
2736 $authorised_values_sth->execute( $tagslib->{$tag}->{$subfield}->{authorised_value} );
2737 push @authorised_values, ""
2738 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2739 while ( my ( $value, $lib ) = $authorised_values_sth->fetchrow_array ) {
2740 push @authorised_values, $value;
2741 $authorised_lib{$value} = $lib;
2744 $subfield_data{marc_value} = CGI::scrolling_list(
2745 -name => 'field_value',
2746 -values => \@authorised_values,
2747 -default => "$defaultvalue",
2748 -labels => \%authorised_lib,
2753 } elsif ( $tagslib->{$tag}->{$subfield}->{value_builder} ) {
2755 my $plugin = C4::Context->intranetdir . "/cataloguing/value_builder/" . $tagslib->{$tag}->{$subfield}->{'value_builder'};
2758 my $extended_param = plugin_parameters( $dbh, $temp, $tagslib, $subfield_data{id}, undef );
2759 my ( $function_name, $javascript ) = plugin_javascript( $dbh, $temp, $tagslib, $subfield_data{id}, undef );
2760 $subfield_data{random} = int(rand(1000000)); # why do we need 2 different randoms?
2761 $subfield_data{marc_value} = qq[<input tabindex="1" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="67" maxlength="255"
2762 onfocus="Focus$function_name($subfield_data{random}, '$subfield_data{id}');"
2763 onblur=" Blur$function_name($subfield_data{random}, '$subfield_data{id}');" />
2764 <a href="#" class="buttonDot" onclick="Clic$function_name('$subfield_data{id}'); return false;" title="Tag Editor">...</a>
2767 warn "Plugin Failed: $plugin";
2768 $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
2771 elsif ( $tag eq '' ) { # it's an hidden field
2772 $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" />);
2774 elsif ( $tagslib->{$tag}->{$subfield}->{'hidden'} ) { # FIXME: shouldn't input type be "hidden" ?
2775 $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" />);
2777 elsif ( length($defaultvalue) > 100
2778 or (C4::Context->preference("marcflavour") eq "UNIMARC" and
2779 300 <= $tag && $tag < 400 && $subfield eq 'a' )
2780 or (C4::Context->preference("marcflavour") eq "MARC21" and
2781 500 <= $tag && $tag < 600 )
2783 # oversize field (textarea)
2784 $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");
2786 $subfield_data{marc_value} = "<input type=\"text\" name=\"field_value\" value=\"$defaultvalue\" size=\"50\" maxlength=\"255\" />";
2788 push( @loop_data, \%subfield_data );
2793 if ( $itemrecord && $itemrecord->field($itemtagfield) ) {
2794 $itemnumber = $itemrecord->subfield( $itemtagfield, $itemtagsubfield );
2797 'itemtagfield' => $itemtagfield,
2798 'itemtagsubfield' => $itemtagsubfield,
2799 'itemnumber' => $itemnumber,
2800 'iteminformation' => \@loop_data