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/;
34 use DateTime::Format::MySQL;
35 use Data::Dumper; # used as part of logging item record changes, not just for
36 # debugging; so please don't remove this
37 use Koha::DateUtils qw/dt_from_string/;
41 use vars qw($VERSION @ISA @EXPORT);
44 $VERSION = 3.07.00.049;
47 @ISA = qw( Exporter );
70 GetItemsByBiblioitemnumber
74 GetItemnumbersForBiblio
76 get_hostitemnumbers_of
77 GetItemnumberFromBarcode
78 GetBarcodeFromItemnumber
93 PrepareItemrecordDisplay
100 C4::Items - item management functions
104 This module contains an API for manipulating item
105 records in Koha, and is used by cataloguing, circulation,
106 acquisitions, and serials management.
108 A Koha item record is stored in two places: the
109 items table and embedded in a MARC tag in the XML
110 version of the associated bib record in C<biblioitems.marcxml>.
111 This is done to allow the item information to be readily
112 indexed (e.g., by Zebra), but means that each item
113 modification transaction must keep the items table
114 and the MARC XML in sync at all times.
116 Consequently, all code that creates, modifies, or deletes
117 item records B<must> use an appropriate function from
118 C<C4::Items>. If no existing function is suitable, it is
119 better to add one to C<C4::Items> than to use add
120 one-off SQL statements to add or modify items.
122 The items table will be considered authoritative. In other
123 words, if there is ever a discrepancy between the items
124 table and the MARC XML, the items table should be considered
127 =head1 HISTORICAL NOTE
129 Most of the functions in C<C4::Items> were originally in
130 the C<C4::Biblio> module.
132 =head1 CORE EXPORTED FUNCTIONS
134 The following functions are meant for use by users
141 $item = GetItem($itemnumber,$barcode,$serial);
143 Return item information, for a given itemnumber or barcode.
144 The return value is a hashref mapping item column
145 names to values. If C<$serial> is true, include serial publication data.
150 my ($itemnumber,$barcode, $serial) = @_;
151 my $dbh = C4::Context->dbh;
155 my $sth = $dbh->prepare("
157 WHERE itemnumber = ?");
158 $sth->execute($itemnumber);
159 $data = $sth->fetchrow_hashref;
161 my $sth = $dbh->prepare("
165 $sth->execute($barcode);
166 $data = $sth->fetchrow_hashref;
169 return unless ( $data );
172 my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=?");
173 $ssth->execute($data->{'itemnumber'}) ;
174 ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
176 #if we don't have an items.itype, use biblioitems.itemtype.
177 if( ! $data->{'itype'} ) {
178 my $sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
179 $sth->execute($data->{'biblionumber'});
180 ($data->{'itype'}) = $sth->fetchrow_array;
187 CartToShelf($itemnumber);
189 Set the current shelving location of the item record
190 to its stored permanent shelving location. This is
191 primarily used to indicate when an item whose current
192 location is a special processing ('PROC') or shelving cart
193 ('CART') location is back in the stacks.
198 my ( $itemnumber ) = @_;
200 unless ( $itemnumber ) {
201 croak "FAILED CartToShelf() - no itemnumber supplied";
204 my $item = GetItem($itemnumber);
205 if ( $item->{location} eq 'CART' ) {
206 $item->{location} = $item->{permanent_location};
207 ModItem($item, undef, $itemnumber);
213 ShelfToCart($itemnumber);
215 Set the current shelving location of the item
216 to shelving cart ('CART').
221 my ( $itemnumber ) = @_;
223 unless ( $itemnumber ) {
224 croak "FAILED ShelfToCart() - no itemnumber supplied";
227 my $item = GetItem($itemnumber);
228 $item->{'location'} = 'CART';
229 ModItem($item, undef, $itemnumber);
232 =head2 AddItemFromMarc
234 my ($biblionumber, $biblioitemnumber, $itemnumber)
235 = AddItemFromMarc($source_item_marc, $biblionumber);
237 Given a MARC::Record object containing an embedded item
238 record and a biblionumber, create a new item record.
242 sub AddItemFromMarc {
243 my ( $source_item_marc, $biblionumber ) = @_;
244 my $dbh = C4::Context->dbh;
246 # parse item hash from MARC
247 my $frameworkcode = GetFrameworkCode( $biblionumber );
248 my ($itemtag,$itemsubfield)=GetMarcFromKohaField("items.itemnumber",$frameworkcode);
250 my $localitemmarc=MARC::Record->new;
251 $localitemmarc->append_fields($source_item_marc->field($itemtag));
252 my $item = &TransformMarcToKoha( $dbh, $localitemmarc, $frameworkcode ,'items');
253 my $unlinked_item_subfields = _get_unlinked_item_subfields($localitemmarc, $frameworkcode);
254 return AddItem($item, $biblionumber, $dbh, $frameworkcode, $unlinked_item_subfields);
259 my ($biblionumber, $biblioitemnumber, $itemnumber)
260 = AddItem($item, $biblionumber[, $dbh, $frameworkcode, $unlinked_item_subfields]);
262 Given a hash containing item column names as keys,
263 create a new Koha item record.
265 The first two optional parameters (C<$dbh> and C<$frameworkcode>)
266 do not need to be supplied for general use; they exist
267 simply to allow them to be picked up from AddItemFromMarc.
269 The final optional parameter, C<$unlinked_item_subfields>, contains
270 an arrayref containing subfields present in the original MARC
271 representation of the item (e.g., from the item editor) that are
272 not mapped to C<items> columns directly but should instead
273 be stored in C<items.more_subfields_xml> and included in
274 the biblio items tag for display and indexing.
280 my $biblionumber = shift;
282 my $dbh = @_ ? shift : C4::Context->dbh;
283 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
284 my $unlinked_item_subfields;
286 $unlinked_item_subfields = shift
289 # needs old biblionumber and biblioitemnumber
290 $item->{'biblionumber'} = $biblionumber;
291 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
292 $sth->execute( $item->{'biblionumber'} );
293 ($item->{'biblioitemnumber'}) = $sth->fetchrow;
295 _set_defaults_for_add($item);
296 _set_derived_columns_for_add($item);
297 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
298 # FIXME - checks here
299 unless ( $item->{itype} ) { # default to biblioitem.itemtype if no itype
300 my $itype_sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
301 $itype_sth->execute( $item->{'biblionumber'} );
302 ( $item->{'itype'} ) = $itype_sth->fetchrow_array;
305 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
306 $item->{'itemnumber'} = $itemnumber;
308 ModZebra( $item->{biblionumber}, "specialUpdate", "biblioserver" );
310 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
312 return ($item->{biblionumber}, $item->{biblioitemnumber}, $itemnumber);
315 =head2 AddItemBatchFromMarc
317 ($itemnumber_ref, $error_ref) = AddItemBatchFromMarc($record,
318 $biblionumber, $biblioitemnumber, $frameworkcode);
320 Efficiently create item records from a MARC biblio record with
321 embedded item fields. This routine is suitable for batch jobs.
323 This API assumes that the bib record has already been
324 saved to the C<biblio> and C<biblioitems> tables. It does
325 not expect that C<biblioitems.marc> and C<biblioitems.marcxml>
326 are populated, but it will do so via a call to ModBibiloMarc.
328 The goal of this API is to have a similar effect to using AddBiblio
329 and AddItems in succession, but without inefficient repeated
330 parsing of the MARC XML bib record.
332 This function returns an arrayref of new itemsnumbers and an arrayref of item
333 errors encountered during the processing. Each entry in the errors
334 list is a hashref containing the following keys:
340 Sequence number of original item tag in the MARC record.
344 Item barcode, provide to assist in the construction of
345 useful error messages.
349 Code representing the error condition. Can be 'duplicate_barcode',
350 'invalid_homebranch', or 'invalid_holdingbranch'.
352 =item error_information
354 Additional information appropriate to the error condition.
360 sub AddItemBatchFromMarc {
361 my ($record, $biblionumber, $biblioitemnumber, $frameworkcode) = @_;
363 my @itemnumbers = ();
365 my $dbh = C4::Context->dbh;
367 # We modify the record, so lets work on a clone so we don't change the
369 $record = $record->clone();
370 # loop through the item tags and start creating items
371 my @bad_item_fields = ();
372 my ($itemtag, $itemsubfield) = &GetMarcFromKohaField("items.itemnumber",'');
373 my $item_sequence_num = 0;
374 ITEMFIELD: foreach my $item_field ($record->field($itemtag)) {
375 $item_sequence_num++;
376 # we take the item field and stick it into a new
377 # MARC record -- this is required so far because (FIXME)
378 # TransformMarcToKoha requires a MARC::Record, not a MARC::Field
379 # and there is no TransformMarcFieldToKoha
380 my $temp_item_marc = MARC::Record->new();
381 $temp_item_marc->append_fields($item_field);
383 # add biblionumber and biblioitemnumber
384 my $item = TransformMarcToKoha( $dbh, $temp_item_marc, $frameworkcode, 'items' );
385 my $unlinked_item_subfields = _get_unlinked_item_subfields($temp_item_marc, $frameworkcode);
386 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
387 $item->{'biblionumber'} = $biblionumber;
388 $item->{'biblioitemnumber'} = $biblioitemnumber;
390 # check for duplicate barcode
391 my %item_errors = CheckItemPreSave($item);
393 push @errors, _repack_item_errors($item_sequence_num, $item, \%item_errors);
394 push @bad_item_fields, $item_field;
398 _set_defaults_for_add($item);
399 _set_derived_columns_for_add($item);
400 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
401 warn $error if $error;
402 push @itemnumbers, $itemnumber; # FIXME not checking error
403 $item->{'itemnumber'} = $itemnumber;
405 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
407 my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
408 $item_field->replace_with($new_item_marc->field($itemtag));
411 # remove any MARC item fields for rejected items
412 foreach my $item_field (@bad_item_fields) {
413 $record->delete_field($item_field);
416 # update the MARC biblio
417 # $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode );
419 return (\@itemnumbers, \@errors);
422 =head2 ModItemFromMarc
424 ModItemFromMarc($item_marc, $biblionumber, $itemnumber);
426 This function updates an item record based on a supplied
427 C<MARC::Record> object containing an embedded item field.
428 This API is meant for the use of C<additem.pl>; for
429 other purposes, C<ModItem> should be used.
431 This function uses the hash %default_values_for_mod_from_marc,
432 which contains default values for item fields to
433 apply when modifying an item. This is needed beccause
434 if an item field's value is cleared, TransformMarcToKoha
435 does not include the column in the
436 hash that's passed to ModItem, which without
437 use of this hash makes it impossible to clear
438 an item field's value. See bug 2466.
440 Note that only columns that can be directly
441 changed from the cataloging and serials
442 item editors are included in this hash.
448 our %default_values_for_mod_from_marc;
450 sub _build_default_values_for_mod_marc {
451 my ($frameworkcode) = @_;
452 return $default_values_for_mod_from_marc{$frameworkcode}
453 if exists $default_values_for_mod_from_marc{$frameworkcode};
454 my $marc_structure = C4::Biblio::GetMarcStructure( 1, $frameworkcode );
455 my $default_values = {
457 booksellerid => undef,
459 'items.cn_source' => undef,
460 coded_location_qualifier => undef,
464 holdingbranch => undef,
466 itemcallnumber => undef,
471 permanent_location => undef,
474 # paidfor => undef, # commented, see bug 12817
476 replacementprice => undef,
477 replacementpricedate => undef,
480 stocknumber => undef,
484 while ( my ( $field, $default_value ) = each %$default_values ) {
485 $field =~ s|[^\.]*\.?(.*)|items.$1|;
486 $default_values_for_mod_from_marc{$frameworkcode}{$field} =
488 if C4::Koha::IsKohaFieldLinked(
489 { kohafield => $field, frameworkcode => $frameworkcode } );
491 return $default_values_for_mod_from_marc{$frameworkcode};
494 sub ModItemFromMarc {
495 my $item_marc = shift;
496 my $biblionumber = shift;
497 my $itemnumber = shift;
499 my $dbh = C4::Context->dbh;
500 my $frameworkcode = GetFrameworkCode($biblionumber);
501 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
503 my $localitemmarc = MARC::Record->new;
504 $localitemmarc->append_fields( $item_marc->field($itemtag) );
505 my $item = &TransformMarcToKoha( $dbh, $localitemmarc, $frameworkcode, 'items' );
506 my $default_values = _build_default_values_for_mod_marc();
507 foreach my $item_field ( keys %$default_values ) {
508 $item->{$item_field} = $default_values->{$item_field}
509 unless exists $item->{$item_field};
511 my $unlinked_item_subfields = _get_unlinked_item_subfields( $localitemmarc, $frameworkcode );
513 ModItem($item, $biblionumber, $itemnumber, $dbh, $frameworkcode, $unlinked_item_subfields);
519 ModItem({ column => $newvalue }, $biblionumber, $itemnumber);
521 Change one or more columns in an item record and update
522 the MARC representation of the item.
524 The first argument is a hashref mapping from item column
525 names to the new values. The second and third arguments
526 are the biblionumber and itemnumber, respectively.
528 The fourth, optional parameter, C<$unlinked_item_subfields>, contains
529 an arrayref containing subfields present in the original MARC
530 representation of the item (e.g., from the item editor) that are
531 not mapped to C<items> columns directly but should instead
532 be stored in C<items.more_subfields_xml> and included in
533 the biblio items tag for display and indexing.
535 If one of the changed columns is used to calculate
536 the derived value of a column such as C<items.cn_sort>,
537 this routine will perform the necessary calculation
544 my $biblionumber = shift;
545 my $itemnumber = shift;
547 # if $biblionumber is undefined, get it from the current item
548 unless (defined $biblionumber) {
549 $biblionumber = _get_single_item_column('biblionumber', $itemnumber);
552 my $dbh = @_ ? shift : C4::Context->dbh;
553 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
555 my $unlinked_item_subfields;
557 $unlinked_item_subfields = shift;
558 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
561 $item->{'itemnumber'} = $itemnumber or return;
563 my @fields = qw( itemlost withdrawn );
565 # Only call GetItem if we need to set an "on" date field
566 if ( $item->{itemlost} || $item->{withdrawn} ) {
567 my $pre_mod_item = GetItem( $item->{'itemnumber'} );
568 for my $field (@fields) {
569 if ( defined( $item->{$field} )
570 and not $pre_mod_item->{$field}
571 and $item->{$field} )
573 $item->{ $field . '_on' } =
574 DateTime::Format::MySQL->format_datetime( dt_from_string() );
579 # If the field is defined but empty, we are removing and,
580 # and thus need to clear out the 'on' field as well
581 for my $field (@fields) {
582 if ( defined( $item->{$field} ) && !$item->{$field} ) {
583 $item->{ $field . '_on' } = undef;
588 _set_derived_columns_for_mod($item);
589 _do_column_fixes_for_mod($item);
592 # attempt to change itemnumber
593 # attempt to change biblionumber (if we want
594 # an API to relink an item to a different bib,
595 # it should be a separate function)
598 _koha_modify_item($item);
600 # request that bib be reindexed so that searching on current
601 # item status is possible
602 ModZebra( $biblionumber, "specialUpdate", "biblioserver" );
604 logaction("CATALOGUING", "MODIFY", $itemnumber, "item ".Dumper($item)) if C4::Context->preference("CataloguingLog");
607 =head2 ModItemTransfer
609 ModItemTransfer($itenumber, $frombranch, $tobranch);
611 Marks an item as being transferred from one branch
616 sub ModItemTransfer {
617 my ( $itemnumber, $frombranch, $tobranch ) = @_;
619 my $dbh = C4::Context->dbh;
621 # Remove the 'shelving cart' location status if it is being used.
622 CartToShelf( $itemnumber ) if ( C4::Context->preference("ReturnToShelvingCart") );
624 #new entry in branchtransfers....
625 my $sth = $dbh->prepare(
626 "INSERT INTO branchtransfers (itemnumber, frombranch, datesent, tobranch)
627 VALUES (?, ?, NOW(), ?)");
628 $sth->execute($itemnumber, $frombranch, $tobranch);
630 ModItem({ holdingbranch => $tobranch }, undef, $itemnumber);
631 ModDateLastSeen($itemnumber);
635 =head2 ModDateLastSeen
637 ModDateLastSeen($itemnum);
639 Mark item as seen. Is called when an item is issued, returned or manually marked during inventory/stocktaking.
640 C<$itemnum> is the item number
644 sub ModDateLastSeen {
645 my ($itemnumber) = @_;
647 my $today = C4::Dates->new();
648 ModItem({ itemlost => 0, datelastseen => $today->output("iso") }, undef, $itemnumber);
653 DelItem({ itemnumber => $itemnumber, [ biblionumber => $biblionumber ] } );
655 Exported function (core API) for deleting an item record in Koha.
662 my $itemnumber = $params->{itemnumber};
663 my $biblionumber = $params->{biblionumber};
665 unless ($biblionumber) {
666 $biblionumber = C4::Biblio::GetBiblionumberFromItemnumber($itemnumber);
669 # If there is no biblionumber for the given itemnumber, there is nothing to delete
670 return 0 unless $biblionumber;
672 # FIXME check the item has no current issues
673 my $deleted = _koha_delete_item( $itemnumber );
675 # get the MARC record
676 my $record = GetMarcBiblio($biblionumber);
677 ModZebra( $biblionumber, "specialUpdate", "biblioserver" );
679 #search item field code
680 logaction("CATALOGUING", "DELETE", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
684 =head2 CheckItemPreSave
686 my $item_ref = TransformMarcToKoha($marc, 'items');
688 my %errors = CheckItemPreSave($item_ref);
689 if (exists $errors{'duplicate_barcode'}) {
690 print "item has duplicate barcode: ", $errors{'duplicate_barcode'}, "\n";
691 } elsif (exists $errors{'invalid_homebranch'}) {
692 print "item has invalid home branch: ", $errors{'invalid_homebranch'}, "\n";
693 } elsif (exists $errors{'invalid_holdingbranch'}) {
694 print "item has invalid holding branch: ", $errors{'invalid_holdingbranch'}, "\n";
699 Given a hashref containing item fields, determine if it can be
700 inserted or updated in the database. Specifically, checks for
701 database integrity issues, and returns a hash containing any
702 of the following keys, if applicable.
706 =item duplicate_barcode
708 Barcode, if it duplicates one already found in the database.
710 =item invalid_homebranch
712 Home branch, if not defined in branches table.
714 =item invalid_holdingbranch
716 Holding branch, if not defined in branches table.
720 This function does NOT implement any policy-related checks,
721 e.g., whether current operator is allowed to save an
722 item that has a given branch code.
726 sub CheckItemPreSave {
727 my $item_ref = shift;
732 # check for duplicate barcode
733 if (exists $item_ref->{'barcode'} and defined $item_ref->{'barcode'}) {
734 my $existing_itemnumber = GetItemnumberFromBarcode($item_ref->{'barcode'});
735 if ($existing_itemnumber) {
736 if (!exists $item_ref->{'itemnumber'} # new item
737 or $item_ref->{'itemnumber'} != $existing_itemnumber) { # existing item
738 $errors{'duplicate_barcode'} = $item_ref->{'barcode'};
743 # check for valid home branch
744 if (exists $item_ref->{'homebranch'} and defined $item_ref->{'homebranch'}) {
745 my $branch_name = C4::Branch::GetBranchName($item_ref->{'homebranch'});
746 unless (defined $branch_name) {
747 # relies on fact that branches.branchname is a non-NULL column,
748 # so GetBranchName returns undef only if branch does not exist
749 $errors{'invalid_homebranch'} = $item_ref->{'homebranch'};
753 # check for valid holding branch
754 if (exists $item_ref->{'holdingbranch'} and defined $item_ref->{'holdingbranch'}) {
755 my $branch_name = C4::Branch::GetBranchName($item_ref->{'holdingbranch'});
756 unless (defined $branch_name) {
757 # relies on fact that branches.branchname is a non-NULL column,
758 # so GetBranchName returns undef only if branch does not exist
759 $errors{'invalid_holdingbranch'} = $item_ref->{'holdingbranch'};
767 =head1 EXPORTED SPECIAL ACCESSOR FUNCTIONS
769 The following functions provide various ways of
770 getting an item record, a set of item records, or
771 lists of authorized values for certain item fields.
773 Some of the functions in this group are candidates
774 for refactoring -- for example, some of the code
775 in C<GetItemsByBiblioitemnumber> and C<GetItemsInfo>
776 has copy-and-paste work.
782 $itemstatushash = GetItemStatus($fwkcode);
784 Returns a list of valid values for the
785 C<items.notforloan> field.
787 NOTE: does B<not> return an individual item's
790 Can be MARC dependant.
792 But basically could be can be loan or not
793 Create a status selector with the following code
795 =head3 in PERL SCRIPT
797 my $itemstatushash = getitemstatus;
799 foreach my $thisstatus (keys %$itemstatushash) {
800 my %row =(value => $thisstatus,
801 statusname => $itemstatushash->{$thisstatus}->{'statusname'},
803 push @itemstatusloop, \%row;
805 $template->param(statusloop=>\@itemstatusloop);
809 <select name="statusloop" id="statusloop">
810 <option value="">Default</option>
811 [% FOREACH statusloo IN statusloop %]
812 [% IF ( statusloo.selected ) %]
813 <option value="[% statusloo.value %]" selected="selected">[% statusloo.statusname %]</option>
815 <option value="[% statusloo.value %]">[% statusloo.statusname %]</option>
824 # returns a reference to a hash of references to status...
827 my $dbh = C4::Context->dbh;
829 $fwk = '' unless ($fwk);
830 my ( $tag, $subfield ) =
831 GetMarcFromKohaField( "items.notforloan", $fwk );
832 if ( $tag and $subfield ) {
835 "SELECT authorised_value
836 FROM marc_subfield_structure
842 $sth->execute( $tag, $subfield, $fwk );
843 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
846 "SELECT authorised_value,lib
847 FROM authorised_values
852 $authvalsth->execute($authorisedvaluecat);
853 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
854 $itemstatus{$authorisedvalue} = $lib;
868 $itemstatus{"1"} = "Not For Loan";
872 =head2 GetItemLocation
874 $itemlochash = GetItemLocation($fwk);
876 Returns a list of valid values for the
877 C<items.location> field.
879 NOTE: does B<not> return an individual item's
882 where fwk stands for an optional framework code.
883 Create a location selector with the following code
885 =head3 in PERL SCRIPT
887 my $itemlochash = getitemlocation;
889 foreach my $thisloc (keys %$itemlochash) {
890 my $selected = 1 if $thisbranch eq $branch;
891 my %row =(locval => $thisloc,
892 selected => $selected,
893 locname => $itemlochash->{$thisloc},
895 push @itemlocloop, \%row;
897 $template->param(itemlocationloop => \@itemlocloop);
901 <select name="location">
902 <option value="">Default</option>
903 <!-- TMPL_LOOP name="itemlocationloop" -->
904 <option value="<!-- TMPL_VAR name="locval" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="locname" --></option>
910 sub GetItemLocation {
912 # returns a reference to a hash of references to location...
915 my $dbh = C4::Context->dbh;
917 $fwk = '' unless ($fwk);
918 my ( $tag, $subfield ) =
919 GetMarcFromKohaField( "items.location", $fwk );
920 if ( $tag and $subfield ) {
923 "SELECT authorised_value
924 FROM marc_subfield_structure
929 $sth->execute( $tag, $subfield, $fwk );
930 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
933 "SELECT authorised_value,lib
934 FROM authorised_values
938 $authvalsth->execute($authorisedvaluecat);
939 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
940 $itemlocation{$authorisedvalue} = $lib;
942 return \%itemlocation;
954 $itemlocation{"1"} = "Not For Loan";
955 return \%itemlocation;
960 $items = GetLostItems( $where, $orderby );
962 This function gets a list of lost items.
968 C<$where> is a hashref. it containts a field of the items table as key
969 and the value to match as value. For example:
971 { barcode => 'abc123',
972 homebranch => 'CPL', }
974 C<$orderby> is a field of the items table by which the resultset
979 C<$items> is a reference to an array full of hashrefs with columns
980 from the "items" table as keys.
982 =item usage in the perl script:
984 my $where = { barcode => '0001548' };
985 my $items = GetLostItems( $where, "homebranch" );
986 $template->param( itemsloop => $items );
993 # Getting input args.
996 my $dbh = C4::Context->dbh;
999 SELECT title, author, lib, itemlost, authorised_value, barcode, datelastseen, price, replacementprice, homebranch,
1000 itype, itemtype, holdingbranch, location, itemnotes, items.biblionumber as biblionumber
1002 LEFT JOIN biblio ON (items.biblionumber = biblio.biblionumber)
1003 LEFT JOIN biblioitems ON (items.biblionumber = biblioitems.biblionumber)
1004 LEFT JOIN authorised_values ON (items.itemlost = authorised_values.authorised_value)
1006 authorised_values.category = 'LOST'
1007 AND itemlost IS NOT NULL
1010 my @query_parameters;
1011 foreach my $key (keys %$where) {
1012 $query .= " AND $key LIKE ?";
1013 push @query_parameters, "%$where->{$key}%";
1015 my @ordervalues = qw/title author homebranch itype barcode price replacementprice lib datelastseen location/;
1017 if ( defined $orderby && grep($orderby, @ordervalues)) {
1018 $query .= ' ORDER BY '.$orderby;
1021 my $sth = $dbh->prepare($query);
1022 $sth->execute( @query_parameters );
1024 while ( my $row = $sth->fetchrow_hashref ){
1030 =head2 GetItemsForInventory
1032 ($itemlist, $iTotalRecords) = GetItemsForInventory($minlocation, $maxlocation, $location, $itemtype, $ignoreissued, $datelastseen, $branchcode, $offset, $size, $statushash);
1034 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
1036 The sub returns a reference to a list of hashes, each containing
1037 itemnumber, author, title, barcode, item callnumber, and date last
1038 seen. It is ordered by callnumber then title.
1040 The required minlocation & maxlocation parameters are used to specify a range of item callnumbers
1041 the datelastseen can be used to specify that you want to see items not seen since a past date only.
1042 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
1043 $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.
1045 $iTotalRecords is the number of rows that would have been returned without the $offset, $size limit clause
1049 sub GetItemsForInventory {
1050 my ( $minlocation, $maxlocation,$location, $itemtype, $ignoreissued, $datelastseen, $branchcode, $branch, $offset, $size, $statushash ) = @_;
1051 my $dbh = C4::Context->dbh;
1052 my ( @bind_params, @where_strings );
1054 my $select_columns = q{
1055 SELECT items.itemnumber, barcode, itemcallnumber, title, author, biblio.biblionumber, biblio.frameworkcode, datelastseen, homebranch, location, notforloan, damaged, itemlost, withdrawn, stocknumber
1057 my $select_count = q{SELECT COUNT(*)};
1060 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
1061 LEFT JOIN biblioitems on items.biblionumber = biblioitems.biblionumber
1064 for my $authvfield (keys %$statushash){
1065 if ( scalar @{$statushash->{$authvfield}} > 0 ){
1066 my $joinedvals = join ',', @{$statushash->{$authvfield}};
1067 push @where_strings, "$authvfield in (" . $joinedvals . ")";
1073 push @where_strings, 'itemcallnumber >= ?';
1074 push @bind_params, $minlocation;
1078 push @where_strings, 'itemcallnumber <= ?';
1079 push @bind_params, $maxlocation;
1082 if ($datelastseen) {
1083 $datelastseen = format_date_in_iso($datelastseen);
1084 push @where_strings, '(datelastseen < ? OR datelastseen IS NULL)';
1085 push @bind_params, $datelastseen;
1089 push @where_strings, 'items.location = ?';
1090 push @bind_params, $location;
1093 if ( $branchcode ) {
1094 if($branch eq "homebranch"){
1095 push @where_strings, 'items.homebranch = ?';
1097 push @where_strings, 'items.holdingbranch = ?';
1099 push @bind_params, $branchcode;
1103 push @where_strings, 'biblioitems.itemtype = ?';
1104 push @bind_params, $itemtype;
1107 if ( $ignoreissued) {
1108 $query .= "LEFT JOIN issues ON items.itemnumber = issues.itemnumber ";
1109 push @where_strings, 'issues.date_due IS NULL';
1112 if ( @where_strings ) {
1114 $query .= join ' AND ', @where_strings;
1116 $query .= ' ORDER BY items.cn_sort, itemcallnumber, title';
1117 my $count_query = $select_count . $query;
1118 $query .= " LIMIT $offset, $size" if ($offset and $size);
1119 $query = $select_columns . $query;
1120 my $sth = $dbh->prepare($query);
1121 $sth->execute( @bind_params );
1124 my $tmpresults = $sth->fetchall_arrayref({});
1125 $sth = $dbh->prepare( $count_query );
1126 $sth->execute( @bind_params );
1127 my ($iTotalRecords) = $sth->fetchrow_array();
1129 foreach my $row (@$tmpresults) {
1132 foreach (keys %$row) {
1133 # If the koha field is mapped to a marc field
1134 my ($f, $sf) = GetMarcFromKohaField("items.$_", $row->{'frameworkcode'});
1136 # We replace the code with it's description
1137 my $authvals = C4::Koha::GetKohaAuthorisedValuesFromField($f, $sf, $row->{'frameworkcode'});
1138 $row->{$_} = $authvals->{$row->{$_}} if defined $authvals->{$row->{$_}};
1141 push @results, $row;
1144 return (\@results, $iTotalRecords);
1147 =head2 GetItemsCount
1149 $count = &GetItemsCount( $biblionumber);
1151 This function return count of item with $biblionumber
1156 my ( $biblionumber ) = @_;
1157 my $dbh = C4::Context->dbh;
1158 my $query = "SELECT count(*)
1160 WHERE biblionumber=?";
1161 my $sth = $dbh->prepare($query);
1162 $sth->execute($biblionumber);
1163 my $count = $sth->fetchrow;
1167 =head2 GetItemInfosOf
1169 GetItemInfosOf(@itemnumbers);
1173 sub GetItemInfosOf {
1174 my @itemnumbers = @_;
1176 my $itemnumber_values = @itemnumbers ? join( ',', @itemnumbers ) : "''";
1181 WHERE itemnumber IN ($itemnumber_values)
1183 return get_infos_of( $query, 'itemnumber' );
1186 =head2 GetItemsByBiblioitemnumber
1188 GetItemsByBiblioitemnumber($biblioitemnumber);
1190 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1191 Called by C<C4::XISBN>
1195 sub GetItemsByBiblioitemnumber {
1196 my ( $bibitem ) = @_;
1197 my $dbh = C4::Context->dbh;
1198 my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1199 # Get all items attached to a biblioitem
1202 $sth->execute($bibitem) || die $sth->errstr;
1203 while ( my $data = $sth->fetchrow_hashref ) {
1204 # Foreach item, get circulation information
1205 my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1206 WHERE itemnumber = ?
1207 AND issues.borrowernumber = borrowers.borrowernumber"
1209 $sth2->execute( $data->{'itemnumber'} );
1210 if ( my $data2 = $sth2->fetchrow_hashref ) {
1211 # if item is out, set the due date and who it is out too
1212 $data->{'date_due'} = $data2->{'date_due'};
1213 $data->{'cardnumber'} = $data2->{'cardnumber'};
1214 $data->{'borrowernumber'} = $data2->{'borrowernumber'};
1217 # set date_due to blank, so in the template we check itemlost, and withdrawn
1218 $data->{'date_due'} = '';
1220 # Find the last 3 people who borrowed this item.
1221 my $query2 = "SELECT * FROM old_issues, borrowers WHERE itemnumber = ?
1222 AND old_issues.borrowernumber = borrowers.borrowernumber
1223 ORDER BY returndate desc,timestamp desc LIMIT 3";
1224 $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1225 $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1227 while ( my $data2 = $sth2->fetchrow_hashref ) {
1228 $data->{"timestamp$i2"} = $data2->{'timestamp'};
1229 $data->{"card$i2"} = $data2->{'cardnumber'};
1230 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
1233 push(@results,$data);
1240 @results = GetItemsInfo($biblionumber);
1242 Returns information about items with the given biblionumber.
1244 C<GetItemsInfo> returns a list of references-to-hash. Each element
1245 contains a number of keys. Most of them are attributes from the
1246 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
1247 Koha database. Other keys include:
1251 =item C<$data-E<gt>{branchname}>
1253 The name (not the code) of the branch to which the book belongs.
1255 =item C<$data-E<gt>{datelastseen}>
1257 This is simply C<items.datelastseen>, except that while the date is
1258 stored in YYYY-MM-DD format in the database, here it is converted to
1259 DD/MM/YYYY format. A NULL date is returned as C<//>.
1261 =item C<$data-E<gt>{datedue}>
1263 =item C<$data-E<gt>{class}>
1265 This is the concatenation of C<biblioitems.classification>, the book's
1266 Dewey code, and C<biblioitems.subclass>.
1268 =item C<$data-E<gt>{ocount}>
1270 I think this is the number of copies of the book available.
1272 =item C<$data-E<gt>{order}>
1274 If this is set, it is set to C<One Order>.
1281 my ( $biblionumber ) = @_;
1282 my $dbh = C4::Context->dbh;
1283 # note biblioitems.* must be avoided to prevent large marc and marcxml fields from killing performance.
1289 biblioitems.itemtype,
1292 biblioitems.publicationyear,
1293 biblioitems.publishercode,
1294 biblioitems.volumedate,
1295 biblioitems.volumedesc,
1298 items.notforloan as itemnotforloan,
1299 issues.borrowernumber,
1300 issues.date_due as datedue,
1301 borrowers.cardnumber,
1303 borrowers.firstname,
1304 borrowers.branchcode as bcode,
1306 serial.publisheddate,
1307 itemtypes.description,
1308 itemtypes.notforloan as notforloan_per_itemtype,
1311 holding.opac_info as holding_branch_opac_info,
1312 home.opac_info as home_branch_opac_info
1314 $query .= ", issues.onsite_checkout"
1315 if C4::Context->preference("OnSiteCheckouts");
1318 LEFT JOIN branches AS holding ON items.holdingbranch = holding.branchcode
1319 LEFT JOIN branches AS home ON items.homebranch=home.branchcode
1320 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1321 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1322 LEFT JOIN issues USING (itemnumber)
1323 LEFT JOIN borrowers USING (borrowernumber)
1324 LEFT JOIN serialitems USING (itemnumber)
1325 LEFT JOIN serial USING (serialid)
1326 LEFT JOIN itemtypes ON itemtypes.itemtype = "
1327 . (C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype');
1328 $query .= " LEFT JOIN issues ON issues.itemnumber = items.itemnumber"
1329 if C4::Context->preference("OnSiteCheckouts");
1330 $query .= " WHERE items.biblionumber = ? ORDER BY home.branchname, items.enumchron, LPAD( items.copynumber, 8, '0' ), items.dateaccessioned DESC" ;
1331 my $sth = $dbh->prepare($query);
1332 $sth->execute($biblionumber);
1337 my $userenv = C4::Context->userenv;
1338 my $want_not_same_branch = C4::Context->preference("IndependentBranches") && !C4::Context->IsSuperLibrarian();
1339 while ( my $data = $sth->fetchrow_hashref ) {
1340 if ( $data->{borrowernumber} && $want_not_same_branch) {
1341 $data->{'NOTSAMEBRANCH'} = $data->{'bcode'} ne $userenv->{branch};
1344 $serial ||= $data->{'serial'};
1346 # get notforloan complete status if applicable
1347 if ( my $code = C4::Koha::GetAuthValCode( 'items.notforloan', $data->{frameworkcode} ) ) {
1348 $data->{notforloanvalue} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{itemnotforloan} );
1349 $data->{notforloanvalueopac} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{itemnotforloan}, 1 );
1352 # get restricted status and description if applicable
1353 if ( my $code = C4::Koha::GetAuthValCode( 'items.restricted', $data->{frameworkcode} ) ) {
1354 $data->{restrictedopac} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{restricted}, 1 );
1355 $data->{restricted} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{restricted} );
1358 # my stack procedures
1359 if ( my $code = C4::Koha::GetAuthValCode( 'items.stack', $data->{frameworkcode} ) ) {
1360 $data->{stack} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{stack} );
1363 # Find the last 3 people who borrowed this item.
1364 my $sth2 = $dbh->prepare("SELECT * FROM old_issues,borrowers
1365 WHERE itemnumber = ?
1366 AND old_issues.borrowernumber = borrowers.borrowernumber
1367 ORDER BY returndate DESC
1369 $sth2->execute($data->{'itemnumber'});
1371 while (my $data2 = $sth2->fetchrow_hashref()) {
1372 $data->{"timestamp$ii"} = $data2->{'timestamp'} if $data2->{'timestamp'};
1373 $data->{"card$ii"} = $data2->{'cardnumber'} if $data2->{'cardnumber'};
1374 $data->{"borrower$ii"} = $data2->{'borrowernumber'} if $data2->{'borrowernumber'};
1378 $results[$i] = $data;
1383 ? sort { ($b->{'publisheddate'} || $b->{'enumchron'}) cmp ($a->{'publisheddate'} || $a->{'enumchron'}) } @results
1387 =head2 GetItemsLocationInfo
1389 my @itemlocinfo = GetItemsLocationInfo($biblionumber);
1391 Returns the branch names, shelving location and itemcallnumber for each item attached to the biblio in question
1393 C<GetItemsInfo> returns a list of references-to-hash. Data returned:
1397 =item C<$data-E<gt>{homebranch}>
1399 Branch Name of the item's homebranch
1401 =item C<$data-E<gt>{holdingbranch}>
1403 Branch Name of the item's holdingbranch
1405 =item C<$data-E<gt>{location}>
1407 Item's shelving location code
1409 =item C<$data-E<gt>{location_intranet}>
1411 The intranet description for the Shelving Location as set in authorised_values 'LOC'
1413 =item C<$data-E<gt>{location_opac}>
1415 The OPAC description for the Shelving Location as set in authorised_values 'LOC'. Falls back to intranet description if no OPAC
1418 =item C<$data-E<gt>{itemcallnumber}>
1420 Item's itemcallnumber
1422 =item C<$data-E<gt>{cn_sort}>
1424 Item's call number normalized for sorting
1430 sub GetItemsLocationInfo {
1431 my $biblionumber = shift;
1434 my $dbh = C4::Context->dbh;
1435 my $query = "SELECT a.branchname as homebranch, b.branchname as holdingbranch,
1436 location, itemcallnumber, cn_sort
1437 FROM items, branches as a, branches as b
1438 WHERE homebranch = a.branchcode AND holdingbranch = b.branchcode
1439 AND biblionumber = ?
1440 ORDER BY cn_sort ASC";
1441 my $sth = $dbh->prepare($query);
1442 $sth->execute($biblionumber);
1444 while ( my $data = $sth->fetchrow_hashref ) {
1445 $data->{location_intranet} = GetKohaAuthorisedValueLib('LOC', $data->{location});
1446 $data->{location_opac}= GetKohaAuthorisedValueLib('LOC', $data->{location}, 1);
1447 push @results, $data;
1452 =head2 GetHostItemsInfo
1454 $hostiteminfo = GetHostItemsInfo($hostfield);
1455 Returns the iteminfo for items linked to records via a host field
1459 sub GetHostItemsInfo {
1461 my @returnitemsInfo;
1463 if (C4::Context->preference('marcflavour') eq 'MARC21' ||
1464 C4::Context->preference('marcflavour') eq 'NORMARC'){
1465 foreach my $hostfield ( $record->field('773') ) {
1466 my $hostbiblionumber = $hostfield->subfield("0");
1467 my $linkeditemnumber = $hostfield->subfield("9");
1468 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1469 foreach my $hostitemInfo (@hostitemInfos){
1470 if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1471 push (@returnitemsInfo,$hostitemInfo);
1476 } elsif ( C4::Context->preference('marcflavour') eq 'UNIMARC'){
1477 foreach my $hostfield ( $record->field('461') ) {
1478 my $hostbiblionumber = $hostfield->subfield("0");
1479 my $linkeditemnumber = $hostfield->subfield("9");
1480 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1481 foreach my $hostitemInfo (@hostitemInfos){
1482 if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1483 push (@returnitemsInfo,$hostitemInfo);
1489 return @returnitemsInfo;
1493 =head2 GetLastAcquisitions
1495 my $lastacq = GetLastAcquisitions({'branches' => ('branch1','branch2'),
1496 'itemtypes' => ('BK','BD')}, 10);
1500 sub GetLastAcquisitions {
1501 my ($data,$max) = @_;
1503 my $itemtype = C4::Context->preference('item-level_itypes') ? 'itype' : 'itemtype';
1505 my $number_of_branches = @{$data->{branches}};
1506 my $number_of_itemtypes = @{$data->{itemtypes}};
1509 my @where = ('WHERE 1 ');
1510 $number_of_branches and push @where
1511 , 'AND holdingbranch IN ('
1512 , join(',', ('?') x $number_of_branches )
1516 $number_of_itemtypes and push @where
1517 , "AND $itemtype IN ("
1518 , join(',', ('?') x $number_of_itemtypes )
1522 my $query = "SELECT biblio.biblionumber as biblionumber, title, dateaccessioned
1523 FROM items RIGHT JOIN biblio ON (items.biblionumber=biblio.biblionumber)
1524 RIGHT JOIN biblioitems ON (items.biblioitemnumber=biblioitems.biblioitemnumber)
1526 GROUP BY biblio.biblionumber
1527 ORDER BY dateaccessioned DESC LIMIT $max";
1529 my $dbh = C4::Context->dbh;
1530 my $sth = $dbh->prepare($query);
1532 $sth->execute((@{$data->{branches}}, @{$data->{itemtypes}}));
1535 while( my $row = $sth->fetchrow_hashref){
1536 push @results, {date => $row->{dateaccessioned}
1537 , biblionumber => $row->{biblionumber}
1538 , title => $row->{title}};
1544 =head2 GetItemnumbersForBiblio
1546 my $itemnumbers = GetItemnumbersForBiblio($biblionumber);
1548 Given a single biblionumber, return an arrayref of all the corresponding itemnumbers
1552 sub GetItemnumbersForBiblio {
1553 my $biblionumber = shift;
1555 my $dbh = C4::Context->dbh;
1556 my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber = ?");
1557 $sth->execute($biblionumber);
1558 while (my $result = $sth->fetchrow_hashref) {
1559 push @items, $result->{'itemnumber'};
1564 =head2 get_itemnumbers_of
1566 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1568 Given a list of biblionumbers, return the list of corresponding itemnumbers
1569 for each biblionumber.
1571 Return a reference on a hash where keys are biblionumbers and values are
1572 references on array of itemnumbers.
1576 sub get_itemnumbers_of {
1577 my @biblionumbers = @_;
1579 my $dbh = C4::Context->dbh;
1585 WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1587 my $sth = $dbh->prepare($query);
1588 $sth->execute(@biblionumbers);
1592 while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1593 push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1596 return \%itemnumbers_of;
1599 =head2 get_hostitemnumbers_of
1601 my @itemnumbers_of = get_hostitemnumbers_of($biblionumber);
1603 Given a biblionumber, return the list of corresponding itemnumbers that are linked to it via host fields
1605 Return a reference on a hash where key is a biblionumber and values are
1606 references on array of itemnumbers.
1611 sub get_hostitemnumbers_of {
1612 my ($biblionumber) = @_;
1613 my $marcrecord = GetMarcBiblio($biblionumber);
1614 my (@returnhostitemnumbers,$tag, $biblio_s, $item_s);
1616 my $marcflavor = C4::Context->preference('marcflavour');
1617 if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1621 } elsif ($marcflavor eq 'UNIMARC') {
1627 foreach my $hostfield ( $marcrecord->field($tag) ) {
1628 my $hostbiblionumber = $hostfield->subfield($biblio_s);
1629 my $linkeditemnumber = $hostfield->subfield($item_s);
1631 if (my $itemnumbers = get_itemnumbers_of($hostbiblionumber)->{$hostbiblionumber})
1633 @itemnumbers = @$itemnumbers;
1635 foreach my $itemnumber (@itemnumbers){
1636 if ($itemnumber eq $linkeditemnumber){
1637 push (@returnhostitemnumbers,$itemnumber);
1642 return @returnhostitemnumbers;
1646 =head2 GetItemnumberFromBarcode
1648 $result = GetItemnumberFromBarcode($barcode);
1652 sub GetItemnumberFromBarcode {
1654 my $dbh = C4::Context->dbh;
1657 $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1658 $rq->execute($barcode);
1659 my ($result) = $rq->fetchrow;
1663 =head2 GetBarcodeFromItemnumber
1665 $result = GetBarcodeFromItemnumber($itemnumber);
1669 sub GetBarcodeFromItemnumber {
1670 my ($itemnumber) = @_;
1671 my $dbh = C4::Context->dbh;
1674 $dbh->prepare("SELECT barcode FROM items WHERE items.itemnumber=?");
1675 $rq->execute($itemnumber);
1676 my ($result) = $rq->fetchrow;
1680 =head2 GetHiddenItemnumbers
1682 my @itemnumbers_to_hide = GetHiddenItemnumbers(@items);
1684 Given a list of items it checks which should be hidden from the OPAC given
1685 the current configuration. Returns a list of itemnumbers corresponding to
1686 those that should be hidden.
1690 sub GetHiddenItemnumbers {
1694 my $yaml = C4::Context->preference('OpacHiddenItems');
1695 return () if (! $yaml =~ /\S/ );
1696 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1699 $hidingrules = YAML::Load($yaml);
1702 warn "Unable to parse OpacHiddenItems syspref : $@";
1705 my $dbh = C4::Context->dbh;
1708 foreach my $item (@items) {
1710 # We check each rule
1711 foreach my $field (keys %$hidingrules) {
1713 if (exists $item->{$field}) {
1714 $val = $item->{$field};
1717 my $query = "SELECT $field from items where itemnumber = ?";
1718 $val = $dbh->selectrow_array($query, undef, $item->{'itemnumber'});
1720 $val = '' unless defined $val;
1722 # If the results matches the values in the yaml file
1723 if (any { $val eq $_ } @{$hidingrules->{$field}}) {
1725 # We add the itemnumber to the list
1726 push @resultitems, $item->{'itemnumber'};
1728 # If at least one rule matched for an item, no need to test the others
1733 return @resultitems;
1736 =head3 get_item_authorised_values
1738 find the types and values for all authorised values assigned to this item.
1740 parameters: itemnumber
1742 returns: a hashref malling the authorised value to the value set for this itemnumber
1744 $authorised_values = {
1750 'RESTRICTED' => undef,
1753 'branches' => 'CPL',
1754 'cn_source' => undef,
1755 'itemtypes' => 'SER',
1758 Notes: see C4::Biblio::get_biblio_authorised_values for a similar method at the biblio level.
1762 sub get_item_authorised_values {
1763 my $itemnumber = shift;
1765 # assume that these entries in the authorised_value table are item level.
1766 my $query = q(SELECT distinct authorised_value, kohafield
1767 FROM marc_subfield_structure
1768 WHERE kohafield like 'item%'
1769 AND authorised_value != '' );
1771 my $itemlevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
1772 my $iteminfo = GetItem( $itemnumber );
1773 # warn( Data::Dumper->Dump( [ $itemlevel_authorised_values ], [ 'itemlevel_authorised_values' ] ) );
1775 foreach my $this_authorised_value ( keys %$itemlevel_authorised_values ) {
1776 my $field = $itemlevel_authorised_values->{ $this_authorised_value }->{'kohafield'};
1777 $field =~ s/^items\.//;
1778 if ( exists $iteminfo->{ $field } ) {
1779 $return->{ $this_authorised_value } = $iteminfo->{ $field };
1782 # warn( Data::Dumper->Dump( [ $return ], [ 'return' ] ) );
1786 =head3 get_authorised_value_images
1788 find a list of icons that are appropriate for display based on the
1789 authorised values for a biblio.
1791 parameters: listref of authorised values, such as comes from
1792 get_item_authorised_values or
1793 from C4::Biblio::get_biblio_authorised_values
1795 returns: listref of hashrefs for each image. Each hashref looks like this:
1797 { imageurl => '/intranet-tmpl/prog/img/itemtypeimg/npl/WEB.gif',
1802 Notes: Currently, I put on the full path to the images on the staff
1803 side. This should either be configurable or not done at all. Since I
1804 have to deal with 'intranet' or 'opac' in
1805 get_biblio_authorised_values, perhaps I should be passing it in.
1809 sub get_authorised_value_images {
1810 my $authorised_values = shift;
1814 my $authorised_value_list = GetAuthorisedValues();
1815 # warn ( Data::Dumper->Dump( [ $authorised_value_list ], [ 'authorised_value_list' ] ) );
1816 foreach my $this_authorised_value ( @$authorised_value_list ) {
1817 if ( exists $authorised_values->{ $this_authorised_value->{'category'} }
1818 && $authorised_values->{ $this_authorised_value->{'category'} } eq $this_authorised_value->{'authorised_value'} ) {
1819 # warn ( Data::Dumper->Dump( [ $this_authorised_value ], [ 'this_authorised_value' ] ) );
1820 if ( defined $this_authorised_value->{'imageurl'} ) {
1821 push @imagelist, { imageurl => C4::Koha::getitemtypeimagelocation( 'intranet', $this_authorised_value->{'imageurl'} ),
1822 label => $this_authorised_value->{'lib'},
1823 category => $this_authorised_value->{'category'},
1824 value => $this_authorised_value->{'authorised_value'}, };
1829 # warn ( Data::Dumper->Dump( [ \@imagelist ], [ 'imagelist' ] ) );
1834 =head1 LIMITED USE FUNCTIONS
1836 The following functions, while part of the public API,
1837 are not exported. This is generally because they are
1838 meant to be used by only one script for a specific
1839 purpose, and should not be used in any other context
1840 without careful thought.
1846 my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1848 Returns MARC::Record of the item passed in parameter.
1849 This function is meant for use only in C<cataloguing/additem.pl>,
1850 where it is needed to support that script's MARC-like
1856 my ( $biblionumber, $itemnumber ) = @_;
1858 # GetMarcItem has been revised so that it does the following:
1859 # 1. Gets the item information from the items table.
1860 # 2. Converts it to a MARC field for storage in the bib record.
1862 # The previous behavior was:
1863 # 1. Get the bib record.
1864 # 2. Return the MARC tag corresponding to the item record.
1866 # The difference is that one treats the items row as authoritative,
1867 # while the other treats the MARC representation as authoritative
1868 # under certain circumstances.
1870 my $itemrecord = GetItem($itemnumber);
1872 # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1873 # Also, don't emit a subfield if the underlying field is blank.
1876 return Item2Marc($itemrecord,$biblionumber);
1880 my ($itemrecord,$biblionumber)=@_;
1883 defined($itemrecord->{$_}) && $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : ()
1884 } keys %{ $itemrecord }
1886 my $itemmarc = TransformKohaToMarc($mungeditem);
1887 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",GetFrameworkCode($biblionumber)||'');
1889 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1890 if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1891 foreach my $field ($itemmarc->field($itemtag)){
1892 $field->add_subfields(@$unlinked_item_subfields);
1898 =head1 PRIVATE FUNCTIONS AND VARIABLES
1900 The following functions are not meant to be called
1901 directly, but are documented in order to explain
1902 the inner workings of C<C4::Items>.
1906 =head2 %derived_columns
1908 This hash keeps track of item columns that
1909 are strictly derived from other columns in
1910 the item record and are not meant to be set
1913 Each key in the hash should be the name of a
1914 column (as named by TransformMarcToKoha). Each
1915 value should be hashref whose keys are the
1916 columns on which the derived column depends. The
1917 hashref should also contain a 'BUILDER' key
1918 that is a reference to a sub that calculates
1923 my %derived_columns = (
1924 'items.cn_sort' => {
1925 'itemcallnumber' => 1,
1926 'items.cn_source' => 1,
1927 'BUILDER' => \&_calc_items_cn_sort,
1931 =head2 _set_derived_columns_for_add
1933 _set_derived_column_for_add($item);
1935 Given an item hash representing a new item to be added,
1936 calculate any derived columns. Currently the only
1937 such column is C<items.cn_sort>.
1941 sub _set_derived_columns_for_add {
1944 foreach my $column (keys %derived_columns) {
1945 my $builder = $derived_columns{$column}->{'BUILDER'};
1946 my $source_values = {};
1947 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1948 next if $source_column eq 'BUILDER';
1949 $source_values->{$source_column} = $item->{$source_column};
1951 $builder->($item, $source_values);
1955 =head2 _set_derived_columns_for_mod
1957 _set_derived_column_for_mod($item);
1959 Given an item hash representing a new item to be modified.
1960 calculate any derived columns. Currently the only
1961 such column is C<items.cn_sort>.
1963 This routine differs from C<_set_derived_columns_for_add>
1964 in that it needs to handle partial item records. In other
1965 words, the caller of C<ModItem> may have supplied only one
1966 or two columns to be changed, so this function needs to
1967 determine whether any of the columns to be changed affect
1968 any of the derived columns. Also, if a derived column
1969 depends on more than one column, but the caller is not
1970 changing all of then, this routine retrieves the unchanged
1971 values from the database in order to ensure a correct
1976 sub _set_derived_columns_for_mod {
1979 foreach my $column (keys %derived_columns) {
1980 my $builder = $derived_columns{$column}->{'BUILDER'};
1981 my $source_values = {};
1982 my %missing_sources = ();
1983 my $must_recalc = 0;
1984 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1985 next if $source_column eq 'BUILDER';
1986 if (exists $item->{$source_column}) {
1988 $source_values->{$source_column} = $item->{$source_column};
1990 $missing_sources{$source_column} = 1;
1994 foreach my $source_column (keys %missing_sources) {
1995 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
1997 $builder->($item, $source_values);
2002 =head2 _do_column_fixes_for_mod
2004 _do_column_fixes_for_mod($item);
2006 Given an item hashref containing one or more
2007 columns to modify, fix up certain values.
2008 Specifically, set to 0 any passed value
2009 of C<notforloan>, C<damaged>, C<itemlost>, or
2010 C<withdrawn> that is either undefined or
2011 contains the empty string.
2015 sub _do_column_fixes_for_mod {
2018 if (exists $item->{'notforloan'} and
2019 (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
2020 $item->{'notforloan'} = 0;
2022 if (exists $item->{'damaged'} and
2023 (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
2024 $item->{'damaged'} = 0;
2026 if (exists $item->{'itemlost'} and
2027 (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
2028 $item->{'itemlost'} = 0;
2030 if (exists $item->{'withdrawn'} and
2031 (not defined $item->{'withdrawn'} or $item->{'withdrawn'} eq '')) {
2032 $item->{'withdrawn'} = 0;
2034 if (exists $item->{'location'} && !$item->{'permanent_location'}) {
2035 $item->{'permanent_location'} = $item->{'location'};
2037 if (exists $item->{'timestamp'}) {
2038 delete $item->{'timestamp'};
2042 =head2 _get_single_item_column
2044 _get_single_item_column($column, $itemnumber);
2046 Retrieves the value of a single column from an C<items>
2047 row specified by C<$itemnumber>.
2051 sub _get_single_item_column {
2053 my $itemnumber = shift;
2055 my $dbh = C4::Context->dbh;
2056 my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
2057 $sth->execute($itemnumber);
2058 my ($value) = $sth->fetchrow();
2062 =head2 _calc_items_cn_sort
2064 _calc_items_cn_sort($item, $source_values);
2066 Helper routine to calculate C<items.cn_sort>.
2070 sub _calc_items_cn_sort {
2072 my $source_values = shift;
2074 $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
2077 =head2 _set_defaults_for_add
2079 _set_defaults_for_add($item_hash);
2081 Given an item hash representing an item to be added, set
2082 correct default values for columns whose default value
2083 is not handled by the DBMS. This includes the following
2090 C<items.dateaccessioned>
2112 sub _set_defaults_for_add {
2114 $item->{dateaccessioned} ||= C4::Dates->new->output('iso');
2115 $item->{$_} ||= 0 for (qw( notforloan damaged itemlost withdrawn));
2118 =head2 _koha_new_item
2120 my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
2122 Perform the actual insert into the C<items> table.
2126 sub _koha_new_item {
2127 my ( $item, $barcode ) = @_;
2128 my $dbh=C4::Context->dbh;
2131 "INSERT INTO items SET
2133 biblioitemnumber = ?,
2135 dateaccessioned = ?,
2139 replacementprice = ?,
2140 replacementpricedate = ?,
2141 datelastborrowed = ?,
2149 coded_location_qualifier = ?,
2155 permanent_location = ?,
2167 more_subfields_xml = ?,
2171 my $sth = $dbh->prepare($query);
2172 my $today = C4::Dates->today('iso');
2174 $item->{'biblionumber'},
2175 $item->{'biblioitemnumber'},
2177 $item->{'dateaccessioned'},
2178 $item->{'booksellerid'},
2179 $item->{'homebranch'},
2181 $item->{'replacementprice'},
2182 $item->{'replacementpricedate'} || $today,
2183 $item->{datelastborrowed},
2184 $item->{datelastseen} || $today,
2186 $item->{'notforloan'},
2188 $item->{'itemlost'},
2189 $item->{'withdrawn'},
2190 $item->{'itemcallnumber'},
2191 $item->{'coded_location_qualifier'},
2192 $item->{'restricted'},
2193 $item->{'itemnotes'},
2194 $item->{'holdingbranch'},
2196 $item->{'location'},
2197 $item->{'permanent_location'},
2200 $item->{'renewals'},
2201 $item->{'reserves'},
2202 $item->{'items.cn_source'},
2203 $item->{'items.cn_sort'},
2206 $item->{'materials'},
2208 $item->{'enumchron'},
2209 $item->{'more_subfields_xml'},
2210 $item->{'copynumber'},
2211 $item->{'stocknumber'},
2215 if ( defined $sth->errstr ) {
2216 $error.="ERROR in _koha_new_item $query".$sth->errstr;
2219 $itemnumber = $dbh->{'mysql_insertid'};
2222 return ( $itemnumber, $error );
2225 =head2 MoveItemFromBiblio
2227 MoveItemFromBiblio($itenumber, $frombiblio, $tobiblio);
2229 Moves an item from a biblio to another
2231 Returns undef if the move failed or the biblionumber of the destination record otherwise
2235 sub MoveItemFromBiblio {
2236 my ($itemnumber, $frombiblio, $tobiblio) = @_;
2237 my $dbh = C4::Context->dbh;
2238 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber = ?");
2239 $sth->execute( $tobiblio );
2240 my ( $tobiblioitem ) = $sth->fetchrow();
2241 $sth = $dbh->prepare("UPDATE items SET biblioitemnumber = ?, biblionumber = ? WHERE itemnumber = ? AND biblionumber = ?");
2242 my $return = $sth->execute($tobiblioitem, $tobiblio, $itemnumber, $frombiblio);
2244 ModZebra( $tobiblio, "specialUpdate", "biblioserver" );
2245 ModZebra( $frombiblio, "specialUpdate", "biblioserver" );
2246 # Checking if the item we want to move is in an order
2247 require C4::Acquisition;
2248 my $order = C4::Acquisition::GetOrderFromItemnumber($itemnumber);
2250 # Replacing the biblionumber within the order if necessary
2251 $order->{'biblionumber'} = $tobiblio;
2252 C4::Acquisition::ModOrder($order);
2261 DelItemCheck($dbh, $biblionumber, $itemnumber);
2263 Exported function (core API) for deleting an item record in Koha if there no current issue.
2268 my ( $dbh, $biblionumber, $itemnumber ) = @_;
2271 my $countanalytics=GetAnalyticsCount($itemnumber);
2274 # check that there is no issue on this item before deletion.
2275 my $sth = $dbh->prepare(q{
2276 SELECT COUNT(*) FROM issues
2277 WHERE itemnumber = ?
2279 $sth->execute($itemnumber);
2280 my ($onloan) = $sth->fetchrow;
2282 my $item = GetItem($itemnumber);
2285 $error = "book_on_loan"
2287 elsif ( !C4::Context->IsSuperLibrarian()
2288 and C4::Context->preference("IndependentBranches")
2289 and ( C4::Context->userenv->{branch} ne $item->{'homebranch'} ) )
2291 $error = "not_same_branch";
2294 # check it doesnt have a waiting reserve
2295 $sth = $dbh->prepare(q{
2296 SELECT COUNT(*) FROM reserves
2297 WHERE (found = 'W' OR found = 'T')
2300 $sth->execute($itemnumber);
2301 my ($reserve) = $sth->fetchrow;
2303 $error = "book_reserved";
2304 } elsif ($countanalytics > 0){
2305 $error = "linked_analytics";
2309 biblionumber => $biblionumber,
2310 itemnumber => $itemnumber
2319 =head2 _koha_modify_item
2321 my ($itemnumber,$error) =_koha_modify_item( $item );
2323 Perform the actual update of the C<items> row. Note that this
2324 routine accepts a hashref specifying the columns to update.
2328 sub _koha_modify_item {
2330 my $dbh=C4::Context->dbh;
2333 my $query = "UPDATE items SET ";
2335 for my $key ( keys %$item ) {
2336 next if ( $key eq 'itemnumber' );
2338 push @bind, $item->{$key};
2341 $query .= " WHERE itemnumber=?";
2342 push @bind, $item->{'itemnumber'};
2343 my $sth = $dbh->prepare($query);
2344 $sth->execute(@bind);
2346 $error.="ERROR in _koha_modify_item $query: ".$sth->errstr;
2349 return ($item->{'itemnumber'},$error);
2352 =head2 _koha_delete_item
2354 _koha_delete_item( $itemnum );
2356 Internal function to delete an item record from the koha tables
2360 sub _koha_delete_item {
2361 my ( $itemnum ) = @_;
2363 my $dbh = C4::Context->dbh;
2364 # save the deleted item to deleteditems table
2365 my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
2366 $sth->execute($itemnum);
2367 my $data = $sth->fetchrow_hashref();
2369 # There is no item to delete
2370 return 0 unless $data;
2372 my $query = "INSERT INTO deleteditems SET ";
2374 foreach my $key ( keys %$data ) {
2375 next if ( $key eq 'timestamp' ); # timestamp will be set by db
2376 $query .= "$key = ?,";
2377 push( @bind, $data->{$key} );
2380 $sth = $dbh->prepare($query);
2381 $sth->execute(@bind);
2383 # delete from items table
2384 $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
2385 my $deleted = $sth->execute($itemnum);
2386 return ( $deleted == 1 ) ? 1 : 0;
2389 =head2 _marc_from_item_hash
2391 my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
2393 Given an item hash representing a complete item record,
2394 create a C<MARC::Record> object containing an embedded
2395 tag representing that item.
2397 The third, optional parameter C<$unlinked_item_subfields> is
2398 an arrayref of subfields (not mapped to C<items> fields per the
2399 framework) to be added to the MARC representation
2404 sub _marc_from_item_hash {
2406 my $frameworkcode = shift;
2407 my $unlinked_item_subfields;
2409 $unlinked_item_subfields = shift;
2412 # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
2413 # Also, don't emit a subfield if the underlying field is blank.
2414 my $mungeditem = { map { (defined($item->{$_}) and $item->{$_} ne '') ?
2415 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
2416 : () } keys %{ $item } };
2418 my $item_marc = MARC::Record->new();
2419 foreach my $item_field ( keys %{$mungeditem} ) {
2420 my ( $tag, $subfield ) = GetMarcFromKohaField( $item_field, $frameworkcode );
2421 next unless defined $tag and defined $subfield; # skip if not mapped to MARC field
2422 my @values = split(/\s?\|\s?/, $mungeditem->{$item_field}, -1);
2423 foreach my $value (@values){
2424 if ( my $field = $item_marc->field($tag) ) {
2425 $field->add_subfields( $subfield => $value );
2427 my $add_subfields = [];
2428 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2429 $add_subfields = $unlinked_item_subfields;
2431 $item_marc->add_fields( $tag, " ", " ", $subfield => $value, @$add_subfields );
2439 =head2 _repack_item_errors
2441 Add an error message hash generated by C<CheckItemPreSave>
2442 to a list of errors.
2446 sub _repack_item_errors {
2447 my $item_sequence_num = shift;
2448 my $item_ref = shift;
2449 my $error_ref = shift;
2451 my @repacked_errors = ();
2453 foreach my $error_code (sort keys %{ $error_ref }) {
2454 my $repacked_error = {};
2455 $repacked_error->{'item_sequence'} = $item_sequence_num;
2456 $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
2457 $repacked_error->{'error_code'} = $error_code;
2458 $repacked_error->{'error_information'} = $error_ref->{$error_code};
2459 push @repacked_errors, $repacked_error;
2462 return @repacked_errors;
2465 =head2 _get_unlinked_item_subfields
2467 my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
2471 sub _get_unlinked_item_subfields {
2472 my $original_item_marc = shift;
2473 my $frameworkcode = shift;
2475 my $marcstructure = GetMarcStructure(1, $frameworkcode);
2477 # assume that this record has only one field, and that that
2478 # field contains only the item information
2480 my @fields = $original_item_marc->fields();
2481 if ($#fields > -1) {
2482 my $field = $fields[0];
2483 my $tag = $field->tag();
2484 foreach my $subfield ($field->subfields()) {
2485 if (defined $subfield->[1] and
2486 $subfield->[1] ne '' and
2487 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
2488 push @$subfields, $subfield->[0] => $subfield->[1];
2495 =head2 _get_unlinked_subfields_xml
2497 my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
2501 sub _get_unlinked_subfields_xml {
2502 my $unlinked_item_subfields = shift;
2505 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2506 my $marc = MARC::Record->new();
2507 # use of tag 999 is arbitrary, and doesn't need to match the item tag
2508 # used in the framework
2509 $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
2510 $marc->encoding("UTF-8");
2511 $xml = $marc->as_xml("USMARC");
2517 =head2 _parse_unlinked_item_subfields_from_xml
2519 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2523 sub _parse_unlinked_item_subfields_from_xml {
2525 require C4::Charset;
2526 return unless defined $xml and $xml ne "";
2527 my $marc = MARC::Record->new_from_xml(C4::Charset::StripNonXmlChars($xml),'UTF-8');
2528 my $unlinked_subfields = [];
2529 my @fields = $marc->fields();
2530 if ($#fields > -1) {
2531 foreach my $subfield ($fields[0]->subfields()) {
2532 push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2535 return $unlinked_subfields;
2538 =head2 GetAnalyticsCount
2540 $count= &GetAnalyticsCount($itemnumber)
2542 counts Usage of itemnumber in Analytical bibliorecords.
2546 sub GetAnalyticsCount {
2547 my ($itemnumber) = @_;
2550 ### ZOOM search here
2552 $query= "hi=".$itemnumber;
2553 my ($err,$res,$result) = C4::Search::SimpleSearch($query,0,10);
2559 $holds = &GetItemHolds($biblionumber, $itemnumber);
2561 This function return the count of holds with $biblionumber and $itemnumber
2566 my ($biblionumber, $itemnumber) = @_;
2568 my $dbh = C4::Context->dbh;
2569 my $query = "SELECT count(*)
2571 WHERE biblionumber=? AND itemnumber=?";
2572 my $sth = $dbh->prepare($query);
2573 $sth->execute($biblionumber, $itemnumber);
2574 $holds = $sth->fetchrow;
2578 =head2 SearchItemsByField
2580 my $items = SearchItemsByField($field, $value);
2582 SearchItemsByField will search for items on a specific given field.
2583 For instance you can search all items with a specific stocknumber like this:
2585 my $items = SearchItemsByField('stocknumber', $stocknumber);
2589 sub SearchItemsByField {
2590 my ($field, $value) = @_;
2597 my ($results) = SearchItems($filters);
2601 sub _SearchItems_build_where_fragment {
2605 if (exists($filter->{conjunction})) {
2606 my (@where_strs, @where_args);
2607 foreach my $f (@{ $filter->{filters} }) {
2608 my $fragment = _SearchItems_build_where_fragment($f);
2610 push @where_strs, $fragment->{str};
2611 push @where_args, @{ $fragment->{args} };
2616 $where_str = '(' . join (' ' . $filter->{conjunction} . ' ', @where_strs) . ')';
2619 args => \@where_args,
2623 my @columns = Koha::Database->new()->schema()->resultset('Item')->result_source->columns;
2624 push @columns, Koha::Database->new()->schema()->resultset('Biblio')->result_source->columns;
2625 push @columns, Koha::Database->new()->schema()->resultset('Biblioitem')->result_source->columns;
2626 my @operators = qw(= != > < >= <= like);
2627 my $field = $filter->{field};
2628 if ( (0 < grep /^$field$/, @columns) or (substr($field, 0, 5) eq 'marc:') ) {
2629 my $op = $filter->{operator};
2630 my $query = $filter->{query};
2632 if (!$op or (0 == grep /^$op$/, @operators)) {
2633 $op = '='; # default operator
2637 if ($field =~ /^marc:(\d{3})(?:\$(\w))?$/) {
2639 my $marcsubfield = $2;
2641 if ($marcfield < 10) {
2642 $xpath = "//record/controlfield[\@tag=\"$marcfield\"]";
2644 $xpath = "//record/datafield[\@tag=\"$marcfield\"]/subfield[\@code=\"$marcsubfield\"]";
2646 $column = "ExtractValue(marcxml, '$xpath')";
2651 if (ref $query eq 'ARRAY') {
2654 } elsif ($op eq '!=') {
2658 str => "$column $op (" . join (',', ('?') x @$query) . ")",
2663 str => "$column $op ?",
2670 return $where_fragment;
2675 my ($items, $total) = SearchItems($filter, $params);
2677 Perform a search among items
2679 $filter is a reference to a hash which can be a filter, or a combination of filters.
2681 A filter has the following keys:
2685 =item * field: the name of a SQL column in table items
2687 =item * query: the value to search in this column
2689 =item * operator: comparison operator. Can be one of = != > < >= <= like
2693 A combination of filters hash the following keys:
2697 =item * conjunction: 'AND' or 'OR'
2699 =item * filters: array ref of filters
2703 $params is a reference to a hash that can contain the following parameters:
2707 =item * rows: Number of items to return. 0 returns everything (default: 0)
2709 =item * page: Page to return (return items from (page-1)*rows to (page*rows)-1)
2712 =item * sortby: A SQL column name in items table to sort on
2714 =item * sortorder: 'ASC' or 'DESC'
2721 my ($filter, $params) = @_;
2725 return unless ref $filter eq 'HASH';
2726 return unless ref $params eq 'HASH';
2728 # Default parameters
2729 $params->{rows} ||= 0;
2730 $params->{page} ||= 1;
2731 $params->{sortby} ||= 'itemnumber';
2732 $params->{sortorder} ||= 'ASC';
2734 my ($where_str, @where_args);
2735 my $where_fragment = _SearchItems_build_where_fragment($filter);
2736 if ($where_fragment) {
2737 $where_str = $where_fragment->{str};
2738 @where_args = @{ $where_fragment->{args} };
2741 my $dbh = C4::Context->dbh;
2743 SELECT SQL_CALC_FOUND_ROWS items.*
2745 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2746 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
2748 if (defined $where_str and $where_str ne '') {
2749 $query .= qq{ WHERE $where_str };
2752 my @columns = Koha::Database->new()->schema()->resultset('Item')->result_source->columns;
2753 push @columns, Koha::Database->new()->schema()->resultset('Biblio')->result_source->columns;
2754 push @columns, Koha::Database->new()->schema()->resultset('Biblioitem')->result_source->columns;
2755 my $sortby = (0 < grep {$params->{sortby} eq $_} @columns)
2756 ? $params->{sortby} : 'itemnumber';
2757 my $sortorder = (uc($params->{sortorder}) eq 'ASC') ? 'ASC' : 'DESC';
2758 $query .= qq{ ORDER BY $sortby $sortorder };
2760 my $rows = $params->{rows};
2763 my $offset = $rows * ($params->{page}-1);
2764 $query .= qq { LIMIT ?, ? };
2765 push @limit_args, $offset, $rows;
2768 my $sth = $dbh->prepare($query);
2769 my $rv = $sth->execute(@where_args, @limit_args);
2771 return unless ($rv);
2772 my ($total_rows) = $dbh->selectrow_array(q{ SELECT FOUND_ROWS() });
2774 return ($sth->fetchall_arrayref({}), $total_rows);
2778 =head1 OTHER FUNCTIONS
2782 ($indicators, $value) = _find_value($tag, $subfield, $record,$encoding);
2784 Find the given $subfield in the given $tag in the given
2785 MARC::Record $record. If the subfield is found, returns
2786 the (indicators, value) pair; otherwise, (undef, undef) is
2790 Such a function is used in addbiblio AND additem and serial-edit and maybe could be used in Authorities.
2791 I suggest we export it from this module.
2796 my ( $tagfield, $insubfield, $record, $encoding ) = @_;
2799 if ( $tagfield < 10 ) {
2800 if ( $record->field($tagfield) ) {
2801 push @result, $record->field($tagfield)->data();
2806 foreach my $field ( $record->field($tagfield) ) {
2807 my @subfields = $field->subfields();
2808 foreach my $subfield (@subfields) {
2809 if ( @$subfield[0] eq $insubfield ) {
2810 push @result, @$subfield[1];
2811 $indicator = $field->indicator(1) . $field->indicator(2);
2816 return ( $indicator, @result );
2820 =head2 PrepareItemrecordDisplay
2822 PrepareItemrecordDisplay($itemrecord,$bibnum,$itemumber,$frameworkcode);
2824 Returns a hash with all the fields for Display a given item data in a template
2826 The $frameworkcode returns the item for the given frameworkcode, ONLY if bibnum is not provided
2830 sub PrepareItemrecordDisplay {
2832 my ( $bibnum, $itemnum, $defaultvalues, $frameworkcode ) = @_;
2834 my $dbh = C4::Context->dbh;
2835 $frameworkcode = &GetFrameworkCode($bibnum) if $bibnum;
2836 my ( $itemtagfield, $itemtagsubfield ) = &GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
2837 my $tagslib = &GetMarcStructure( 1, $frameworkcode );
2839 # return nothing if we don't have found an existing framework.
2840 return q{} unless $tagslib;
2843 $itemrecord = C4::Items::GetMarcItem( $bibnum, $itemnum );
2847 my $branch_limit = C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
2849 SELECT authorised_value,lib FROM authorised_values
2852 LEFT JOIN authorised_values_branches ON ( id = av_id )
2857 $query .= qq{ AND ( branchcode = ? OR branchcode IS NULL )} if $branch_limit;
2858 $query .= qq{ ORDER BY lib};
2859 my $authorised_values_sth = $dbh->prepare( $query );
2860 foreach my $tag ( sort keys %{$tagslib} ) {
2861 my $previous_tag = '';
2864 # loop through each subfield
2866 foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
2867 next if ( subfield_is_koha_internal_p($subfield) );
2868 next if ( $tagslib->{$tag}->{$subfield}->{'tab'} ne "10" );
2870 $subfield_data{tag} = $tag;
2871 $subfield_data{subfield} = $subfield;
2872 $subfield_data{countsubfield} = $cntsubf++;
2873 $subfield_data{kohafield} = $tagslib->{$tag}->{$subfield}->{'kohafield'};
2874 $subfield_data{id} = "tag_".$tag."_subfield_".$subfield."_".int(rand(1000000));
2876 # $subfield_data{marc_lib}=$tagslib->{$tag}->{$subfield}->{lib};
2877 $subfield_data{marc_lib} = $tagslib->{$tag}->{$subfield}->{lib};
2878 $subfield_data{mandatory} = $tagslib->{$tag}->{$subfield}->{mandatory};
2879 $subfield_data{repeatable} = $tagslib->{$tag}->{$subfield}->{repeatable};
2880 $subfield_data{hidden} = "display:none"
2881 if ( ( $tagslib->{$tag}->{$subfield}->{hidden} > 4 )
2882 || ( $tagslib->{$tag}->{$subfield}->{hidden} < -4 ) );
2883 my ( $x, $defaultvalue );
2885 ( $x, $defaultvalue ) = _find_value( $tag, $subfield, $itemrecord );
2887 $defaultvalue = $tagslib->{$tag}->{$subfield}->{defaultvalue} unless $defaultvalue;
2888 if ( !defined $defaultvalue ) {
2889 $defaultvalue = q||;
2891 $defaultvalue =~ s/"/"/g;
2894 # search for itemcallnumber if applicable
2895 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.itemcallnumber'
2896 && C4::Context->preference('itemcallnumber') ) {
2897 my $CNtag = substr( C4::Context->preference('itemcallnumber'), 0, 3 );
2898 my $CNsubfield = substr( C4::Context->preference('itemcallnumber'), 3, 1 );
2899 if ( $itemrecord and my $field = $itemrecord->field($CNtag) ) {
2900 $defaultvalue = $field->subfield($CNsubfield);
2903 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.itemcallnumber'
2905 && $defaultvalues->{'callnumber'} ) {
2906 if( $itemrecord and $defaultvalues and not $itemrecord->field($subfield) ){
2907 # if the item record exists, only use default value if the item has no callnumber
2908 $defaultvalue = $defaultvalues->{callnumber};
2909 } elsif ( !$itemrecord and $defaultvalues ) {
2910 # if the item record *doesn't* exists, always use the default value
2911 $defaultvalue = $defaultvalues->{callnumber};
2914 if ( ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.holdingbranch' || $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.homebranch' )
2916 && $defaultvalues->{'branchcode'} ) {
2917 if ( $itemrecord and $defaultvalues and not $itemrecord->field($subfield) ) {
2918 $defaultvalue = $defaultvalues->{branchcode};
2921 if ( ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.location' )
2923 && $defaultvalues->{'location'} ) {
2925 if ( $itemrecord and $defaultvalues and not $itemrecord->field($subfield) ) {
2926 # if the item record exists, only use default value if the item has no locationr
2927 $defaultvalue = $defaultvalues->{location};
2928 } elsif ( !$itemrecord and $defaultvalues ) {
2929 # if the item record *doesn't* exists, always use the default value
2930 $defaultvalue = $defaultvalues->{location};
2933 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
2934 my @authorised_values;
2937 # builds list, depending on authorised value...
2939 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
2940 if ( ( C4::Context->preference("IndependentBranches") )
2941 && !C4::Context->IsSuperLibrarian() ) {
2942 my $sth = $dbh->prepare( "SELECT branchcode,branchname FROM branches WHERE branchcode = ? ORDER BY branchname" );
2943 $sth->execute( C4::Context->userenv->{branch} );
2944 push @authorised_values, ""
2945 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2946 while ( my ( $branchcode, $branchname ) = $sth->fetchrow_array ) {
2947 push @authorised_values, $branchcode;
2948 $authorised_lib{$branchcode} = $branchname;
2951 my $sth = $dbh->prepare( "SELECT branchcode,branchname FROM branches ORDER BY branchname" );
2953 push @authorised_values, ""
2954 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2955 while ( my ( $branchcode, $branchname ) = $sth->fetchrow_array ) {
2956 push @authorised_values, $branchcode;
2957 $authorised_lib{$branchcode} = $branchname;
2961 $defaultvalue = C4::Context->userenv ? C4::Context->userenv->{branch} : undef;
2962 if ( $defaultvalues and $defaultvalues->{branchcode} ) {
2963 $defaultvalue = $defaultvalues->{branchcode};
2967 } elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "itemtypes" ) {
2968 my $sth = $dbh->prepare( "SELECT itemtype,description FROM itemtypes ORDER BY description" );
2970 push @authorised_values, ""
2971 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2972 while ( my ( $itemtype, $description ) = $sth->fetchrow_array ) {
2973 push @authorised_values, $itemtype;
2974 $authorised_lib{$itemtype} = $description;
2977 } elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "cn_source" ) {
2978 push @authorised_values, "" unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2980 my $class_sources = GetClassSources();
2981 my $default_source = C4::Context->preference("DefaultClassificationSource");
2983 foreach my $class_source (sort keys %$class_sources) {
2984 next unless $class_sources->{$class_source}->{'used'} or
2985 ($class_source eq $default_source);
2986 push @authorised_values, $class_source;
2987 $authorised_lib{$class_source} = $class_sources->{$class_source}->{'description'};
2990 $defaultvalue = $default_source;
2992 #---- "true" authorised value
2994 $authorised_values_sth->execute(
2995 $tagslib->{$tag}->{$subfield}->{authorised_value},
2996 $branch_limit ? $branch_limit : ()
2998 push @authorised_values, ""
2999 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
3000 while ( my ( $value, $lib ) = $authorised_values_sth->fetchrow_array ) {
3001 push @authorised_values, $value;
3002 $authorised_lib{$value} = $lib;
3005 $subfield_data{marc_value} = {
3007 values => \@authorised_values,
3008 default => "$defaultvalue",
3009 labels => \%authorised_lib,
3011 } elsif ( $tagslib->{$tag}->{$subfield}->{value_builder} ) {
3013 my $plugin = C4::Context->intranetdir . "/cataloguing/value_builder/" . $tagslib->{$tag}->{$subfield}->{'value_builder'};
3015 my $extended_param = plugin_parameters( $dbh, undef, $tagslib, $subfield_data{id}, undef );
3016 my ( $function_name, $javascript ) = plugin_javascript( $dbh, undef, $tagslib, $subfield_data{id}, undef );
3017 $subfield_data{random} = int(rand(1000000)); # why do we need 2 different randoms?
3018 $subfield_data{marc_value} = qq[<input type="text" tabindex="1" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" maxlength="255"
3019 onfocus="Focus$function_name($subfield_data{random}, '$subfield_data{id}');"
3020 onblur=" Blur$function_name($subfield_data{random}, '$subfield_data{id}');" />
3021 <a href="#" class="buttonDot" onclick="Clic$function_name('$subfield_data{id}'); return false;" title="Tag Editor">...</a>
3024 warn "Plugin Failed: $plugin";
3025 $subfield_data{marc_value} = qq(<input type="text" tabindex="1" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" maxlength="255" />); # supply default input form
3028 elsif ( $tag eq '' ) { # it's an hidden field
3029 $subfield_data{marc_value} = qq(<input type="hidden" tabindex="1" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" maxlength="255" value="$defaultvalue" />);
3031 elsif ( $tagslib->{$tag}->{$subfield}->{'hidden'} ) { # FIXME: shouldn't input type be "hidden" ?
3032 $subfield_data{marc_value} = qq(<input type="text" tabindex="1" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" maxlength="255" value="$defaultvalue" />);
3034 elsif ( length($defaultvalue) > 100
3035 or (C4::Context->preference("marcflavour") eq "UNIMARC" and
3036 300 <= $tag && $tag < 400 && $subfield eq 'a' )
3037 or (C4::Context->preference("marcflavour") eq "MARC21" and
3038 500 <= $tag && $tag < 600 )
3040 # oversize field (textarea)
3041 $subfield_data{marc_value} = qq(<textarea tabindex="1" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" maxlength="255">$defaultvalue</textarea>\n");
3043 $subfield_data{marc_value} = "<input type=\"text\" name=\"field_value\" value=\"$defaultvalue\" size=\"50\" maxlength=\"255\" />";
3045 push( @loop_data, \%subfield_data );
3050 if ( $itemrecord && $itemrecord->field($itemtagfield) ) {
3051 $itemnumber = $itemrecord->subfield( $itemtagfield, $itemtagsubfield );
3054 'itemtagfield' => $itemtagfield,
3055 'itemtagsubfield' => $itemtagsubfield,
3056 'itemnumber' => $itemnumber,
3057 'iteminformation' => \@loop_data