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
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
22 #use warnings; FIXME - Bug 2505
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/;
40 use Koha::Biblioitems;
42 use Koha::SearchEngine;
43 use Koha::SearchEngine::Search;
46 use vars qw(@ISA @EXPORT);
51 @ISA = qw( Exporter );
74 GetItemsByBiblioitemnumber
78 GetItemnumbersForBiblio
80 get_hostitemnumbers_of
81 GetItemnumberFromBarcode
82 GetBarcodeFromItemnumber
98 PrepareItemrecordDisplay
105 C4::Items - item management functions
109 This module contains an API for manipulating item
110 records in Koha, and is used by cataloguing, circulation,
111 acquisitions, and serials management.
113 A Koha item record is stored in two places: the
114 items table and embedded in a MARC tag in the XML
115 version of the associated bib record in C<biblioitems.marcxml>.
116 This is done to allow the item information to be readily
117 indexed (e.g., by Zebra), but means that each item
118 modification transaction must keep the items table
119 and the MARC XML in sync at all times.
121 Consequently, all code that creates, modifies, or deletes
122 item records B<must> use an appropriate function from
123 C<C4::Items>. If no existing function is suitable, it is
124 better to add one to C<C4::Items> than to use add
125 one-off SQL statements to add or modify items.
127 The items table will be considered authoritative. In other
128 words, if there is ever a discrepancy between the items
129 table and the MARC XML, the items table should be considered
132 =head1 HISTORICAL NOTE
134 Most of the functions in C<C4::Items> were originally in
135 the C<C4::Biblio> module.
137 =head1 CORE EXPORTED FUNCTIONS
139 The following functions are meant for use by users
146 $item = GetItem($itemnumber,$barcode,$serial);
148 Return item information, for a given itemnumber or barcode.
149 The return value is a hashref mapping item column
150 names to values. If C<$serial> is true, include serial publication data.
155 my ($itemnumber,$barcode, $serial) = @_;
156 my $dbh = C4::Context->dbh;
160 my $sth = $dbh->prepare("
162 WHERE itemnumber = ?");
163 $sth->execute($itemnumber);
164 $data = $sth->fetchrow_hashref;
166 my $sth = $dbh->prepare("
170 $sth->execute($barcode);
171 $data = $sth->fetchrow_hashref;
174 return unless ( $data );
177 my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=?");
178 $ssth->execute($data->{'itemnumber'}) ;
179 ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
181 #if we don't have an items.itype, use biblioitems.itemtype.
182 # FIXME this should respect the itypes systempreference
183 # if (C4::Context->preference('item-level_itypes')) {
184 if( ! $data->{'itype'} ) {
185 my $sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
186 $sth->execute($data->{'biblionumber'});
187 ($data->{'itype'}) = $sth->fetchrow_array;
194 CartToShelf($itemnumber);
196 Set the current shelving location of the item record
197 to its stored permanent shelving location. This is
198 primarily used to indicate when an item whose current
199 location is a special processing ('PROC') or shelving cart
200 ('CART') location is back in the stacks.
205 my ( $itemnumber ) = @_;
207 unless ( $itemnumber ) {
208 croak "FAILED CartToShelf() - no itemnumber supplied";
211 my $item = GetItem($itemnumber);
212 if ( $item->{location} eq 'CART' ) {
213 $item->{location} = $item->{permanent_location};
214 ModItem($item, undef, $itemnumber);
220 ShelfToCart($itemnumber);
222 Set the current shelving location of the item
223 to shelving cart ('CART').
228 my ( $itemnumber ) = @_;
230 unless ( $itemnumber ) {
231 croak "FAILED ShelfToCart() - no itemnumber supplied";
234 my $item = GetItem($itemnumber);
235 $item->{'location'} = 'CART';
236 ModItem($item, undef, $itemnumber);
239 =head2 AddItemFromMarc
241 my ($biblionumber, $biblioitemnumber, $itemnumber)
242 = AddItemFromMarc($source_item_marc, $biblionumber);
244 Given a MARC::Record object containing an embedded item
245 record and a biblionumber, create a new item record.
249 sub AddItemFromMarc {
250 my ( $source_item_marc, $biblionumber ) = @_;
251 my $dbh = C4::Context->dbh;
253 # parse item hash from MARC
254 my $frameworkcode = GetFrameworkCode( $biblionumber );
255 my ($itemtag,$itemsubfield)=GetMarcFromKohaField("items.itemnumber",$frameworkcode);
257 my $localitemmarc=MARC::Record->new;
258 $localitemmarc->append_fields($source_item_marc->field($itemtag));
259 my $item = &TransformMarcToKoha( $localitemmarc, $frameworkcode ,'items');
260 my $unlinked_item_subfields = _get_unlinked_item_subfields($localitemmarc, $frameworkcode);
261 return AddItem($item, $biblionumber, $dbh, $frameworkcode, $unlinked_item_subfields);
266 my ($biblionumber, $biblioitemnumber, $itemnumber)
267 = AddItem($item, $biblionumber[, $dbh, $frameworkcode, $unlinked_item_subfields]);
269 Given a hash containing item column names as keys,
270 create a new Koha item record.
272 The first two optional parameters (C<$dbh> and C<$frameworkcode>)
273 do not need to be supplied for general use; they exist
274 simply to allow them to be picked up from AddItemFromMarc.
276 The final optional parameter, C<$unlinked_item_subfields>, contains
277 an arrayref containing subfields present in the original MARC
278 representation of the item (e.g., from the item editor) that are
279 not mapped to C<items> columns directly but should instead
280 be stored in C<items.more_subfields_xml> and included in
281 the biblio items tag for display and indexing.
287 my $biblionumber = shift;
289 my $dbh = @_ ? shift : C4::Context->dbh;
290 my $frameworkcode = @_ ? shift : GetFrameworkCode($biblionumber);
291 my $unlinked_item_subfields;
293 $unlinked_item_subfields = shift;
296 # needs old biblionumber and biblioitemnumber
297 $item->{'biblionumber'} = $biblionumber;
298 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
299 $sth->execute( $item->{'biblionumber'} );
300 ( $item->{'biblioitemnumber'} ) = $sth->fetchrow;
302 _set_defaults_for_add($item);
303 _set_derived_columns_for_add($item);
304 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
306 # FIXME - checks here
307 unless ( $item->{itype} ) { # default to biblioitem.itemtype if no itype
308 my $itype_sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
309 $itype_sth->execute( $item->{'biblionumber'} );
310 ( $item->{'itype'} ) = $itype_sth->fetchrow_array;
313 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
316 $item->{'itemnumber'} = $itemnumber;
318 ModZebra( $item->{biblionumber}, "specialUpdate", "biblioserver" );
320 logaction( "CATALOGUING", "ADD", $itemnumber, "item" )
321 if C4::Context->preference("CataloguingLog");
323 return ( $item->{biblionumber}, $item->{biblioitemnumber}, $itemnumber );
326 =head2 AddItemBatchFromMarc
328 ($itemnumber_ref, $error_ref) = AddItemBatchFromMarc($record,
329 $biblionumber, $biblioitemnumber, $frameworkcode);
331 Efficiently create item records from a MARC biblio record with
332 embedded item fields. This routine is suitable for batch jobs.
334 This API assumes that the bib record has already been
335 saved to the C<biblio> and C<biblioitems> tables. It does
336 not expect that C<biblioitems.marc> and C<biblioitems.marcxml>
337 are populated, but it will do so via a call to ModBibiloMarc.
339 The goal of this API is to have a similar effect to using AddBiblio
340 and AddItems in succession, but without inefficient repeated
341 parsing of the MARC XML bib record.
343 This function returns an arrayref of new itemsnumbers and an arrayref of item
344 errors encountered during the processing. Each entry in the errors
345 list is a hashref containing the following keys:
351 Sequence number of original item tag in the MARC record.
355 Item barcode, provide to assist in the construction of
356 useful error messages.
360 Code representing the error condition. Can be 'duplicate_barcode',
361 'invalid_homebranch', or 'invalid_holdingbranch'.
363 =item error_information
365 Additional information appropriate to the error condition.
371 sub AddItemBatchFromMarc {
372 my ($record, $biblionumber, $biblioitemnumber, $frameworkcode) = @_;
374 my @itemnumbers = ();
376 my $dbh = C4::Context->dbh;
378 # We modify the record, so lets work on a clone so we don't change the
380 $record = $record->clone();
381 # loop through the item tags and start creating items
382 my @bad_item_fields = ();
383 my ($itemtag, $itemsubfield) = &GetMarcFromKohaField("items.itemnumber",'');
384 my $item_sequence_num = 0;
385 ITEMFIELD: foreach my $item_field ($record->field($itemtag)) {
386 $item_sequence_num++;
387 # we take the item field and stick it into a new
388 # MARC record -- this is required so far because (FIXME)
389 # TransformMarcToKoha requires a MARC::Record, not a MARC::Field
390 # and there is no TransformMarcFieldToKoha
391 my $temp_item_marc = MARC::Record->new();
392 $temp_item_marc->append_fields($item_field);
394 # add biblionumber and biblioitemnumber
395 my $item = TransformMarcToKoha( $temp_item_marc, $frameworkcode, 'items' );
396 my $unlinked_item_subfields = _get_unlinked_item_subfields($temp_item_marc, $frameworkcode);
397 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
398 $item->{'biblionumber'} = $biblionumber;
399 $item->{'biblioitemnumber'} = $biblioitemnumber;
401 # check for duplicate barcode
402 my %item_errors = CheckItemPreSave($item);
404 push @errors, _repack_item_errors($item_sequence_num, $item, \%item_errors);
405 push @bad_item_fields, $item_field;
409 _set_defaults_for_add($item);
410 _set_derived_columns_for_add($item);
411 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
412 warn $error if $error;
413 push @itemnumbers, $itemnumber; # FIXME not checking error
414 $item->{'itemnumber'} = $itemnumber;
416 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
418 my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
419 $item_field->replace_with($new_item_marc->field($itemtag));
422 # remove any MARC item fields for rejected items
423 foreach my $item_field (@bad_item_fields) {
424 $record->delete_field($item_field);
427 # update the MARC biblio
428 # $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode );
430 return (\@itemnumbers, \@errors);
433 =head2 ModItemFromMarc
435 ModItemFromMarc($item_marc, $biblionumber, $itemnumber);
437 This function updates an item record based on a supplied
438 C<MARC::Record> object containing an embedded item field.
439 This API is meant for the use of C<additem.pl>; for
440 other purposes, C<ModItem> should be used.
442 This function uses the hash %default_values_for_mod_from_marc,
443 which contains default values for item fields to
444 apply when modifying an item. This is needed because
445 if an item field's value is cleared, TransformMarcToKoha
446 does not include the column in the
447 hash that's passed to ModItem, which without
448 use of this hash makes it impossible to clear
449 an item field's value. See bug 2466.
451 Note that only columns that can be directly
452 changed from the cataloging and serials
453 item editors are included in this hash.
459 sub _build_default_values_for_mod_marc {
460 my ($frameworkcode) = @_;
462 my $cache = Koha::Caches->get_instance();
463 my $cache_key = "default_value_for_mod_marc-$frameworkcode";
464 my $cached = $cache->get_from_cache($cache_key);
465 return $cached if $cached;
467 my $default_values = {
469 booksellerid => undef,
471 'items.cn_source' => undef,
472 coded_location_qualifier => undef,
476 holdingbranch => undef,
478 itemcallnumber => undef,
481 itemnotes_nonpublic => undef,
484 permanent_location => undef,
488 # paidfor => undef, # commented, see bug 12817
490 replacementprice => undef,
491 replacementpricedate => undef,
494 stocknumber => undef,
498 my %default_values_for_mod_from_marc;
499 while ( my ( $field, $default_value ) = each %$default_values ) {
500 my $kohafield = $field;
501 $kohafield =~ s|^([^\.]+)$|items.$1|;
502 $default_values_for_mod_from_marc{$field} =
504 if C4::Koha::IsKohaFieldLinked(
505 { kohafield => $kohafield, frameworkcode => $frameworkcode } );
508 $cache->set_in_cache($cache_key, \%default_values_for_mod_from_marc);
509 return \%default_values_for_mod_from_marc;
512 sub ModItemFromMarc {
513 my $item_marc = shift;
514 my $biblionumber = shift;
515 my $itemnumber = shift;
517 my $dbh = C4::Context->dbh;
518 my $frameworkcode = GetFrameworkCode($biblionumber);
519 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
521 my $localitemmarc = MARC::Record->new;
522 $localitemmarc->append_fields( $item_marc->field($itemtag) );
523 my $item = &TransformMarcToKoha( $localitemmarc, $frameworkcode, 'items' );
524 my $default_values = _build_default_values_for_mod_marc($frameworkcode);
525 foreach my $item_field ( keys %$default_values ) {
526 $item->{$item_field} = $default_values->{$item_field}
527 unless exists $item->{$item_field};
529 my $unlinked_item_subfields = _get_unlinked_item_subfields( $localitemmarc, $frameworkcode );
531 ModItem($item, $biblionumber, $itemnumber, $dbh, $frameworkcode, $unlinked_item_subfields);
537 ModItem({ column => $newvalue }, $biblionumber, $itemnumber);
539 Change one or more columns in an item record and update
540 the MARC representation of the item.
542 The first argument is a hashref mapping from item column
543 names to the new values. The second and third arguments
544 are the biblionumber and itemnumber, respectively.
546 The fourth, optional parameter, C<$unlinked_item_subfields>, contains
547 an arrayref containing subfields present in the original MARC
548 representation of the item (e.g., from the item editor) that are
549 not mapped to C<items> columns directly but should instead
550 be stored in C<items.more_subfields_xml> and included in
551 the biblio items tag for display and indexing.
553 If one of the changed columns is used to calculate
554 the derived value of a column such as C<items.cn_sort>,
555 this routine will perform the necessary calculation
562 my $biblionumber = shift;
563 my $itemnumber = shift;
565 # if $biblionumber is undefined, get it from the current item
566 unless (defined $biblionumber) {
567 $biblionumber = _get_single_item_column('biblionumber', $itemnumber);
570 my $dbh = @_ ? shift : C4::Context->dbh;
571 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
573 my $unlinked_item_subfields;
575 $unlinked_item_subfields = shift;
576 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
579 $item->{'itemnumber'} = $itemnumber or return;
581 my @fields = qw( itemlost withdrawn );
583 # Only call GetItem if we need to set an "on" date field
584 if ( $item->{itemlost} || $item->{withdrawn} ) {
585 my $pre_mod_item = GetItem( $item->{'itemnumber'} );
586 for my $field (@fields) {
587 if ( defined( $item->{$field} )
588 and not $pre_mod_item->{$field}
589 and $item->{$field} )
591 $item->{ $field . '_on' } =
592 DateTime::Format::MySQL->format_datetime( dt_from_string() );
597 # If the field is defined but empty, we are removing and,
598 # and thus need to clear out the 'on' field as well
599 for my $field (@fields) {
600 if ( defined( $item->{$field} ) && !$item->{$field} ) {
601 $item->{ $field . '_on' } = undef;
606 _set_derived_columns_for_mod($item);
607 _do_column_fixes_for_mod($item);
610 # attempt to change itemnumber
611 # attempt to change biblionumber (if we want
612 # an API to relink an item to a different bib,
613 # it should be a separate function)
616 _koha_modify_item($item);
618 # request that bib be reindexed so that searching on current
619 # item status is possible
620 ModZebra( $biblionumber, "specialUpdate", "biblioserver" );
622 logaction("CATALOGUING", "MODIFY", $itemnumber, "item ".Dumper($item)) if C4::Context->preference("CataloguingLog");
625 =head2 ModItemTransfer
627 ModItemTransfer($itenumber, $frombranch, $tobranch);
629 Marks an item as being transferred from one branch
634 sub ModItemTransfer {
635 my ( $itemnumber, $frombranch, $tobranch ) = @_;
637 my $dbh = C4::Context->dbh;
639 # Remove the 'shelving cart' location status if it is being used.
640 CartToShelf( $itemnumber ) if ( C4::Context->preference("ReturnToShelvingCart") );
642 #new entry in branchtransfers....
643 my $sth = $dbh->prepare(
644 "INSERT INTO branchtransfers (itemnumber, frombranch, datesent, tobranch)
645 VALUES (?, ?, NOW(), ?)");
646 $sth->execute($itemnumber, $frombranch, $tobranch);
648 ModItem({ holdingbranch => $tobranch }, undef, $itemnumber);
649 ModDateLastSeen($itemnumber);
653 =head2 ModDateLastSeen
655 ModDateLastSeen($itemnum);
657 Mark item as seen. Is called when an item is issued, returned or manually marked during inventory/stocktaking.
658 C<$itemnum> is the item number
662 sub ModDateLastSeen {
663 my ($itemnumber) = @_;
665 my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
666 ModItem({ itemlost => 0, datelastseen => $today }, undef, $itemnumber);
671 DelItem({ itemnumber => $itemnumber, [ biblionumber => $biblionumber ] } );
673 Exported function (core API) for deleting an item record in Koha.
680 my $itemnumber = $params->{itemnumber};
681 my $biblionumber = $params->{biblionumber};
683 unless ($biblionumber) {
684 $biblionumber = C4::Biblio::GetBiblionumberFromItemnumber($itemnumber);
687 # If there is no biblionumber for the given itemnumber, there is nothing to delete
688 return 0 unless $biblionumber;
690 # FIXME check the item has no current issues
691 my $deleted = _koha_delete_item( $itemnumber );
693 # get the MARC record
694 my $record = GetMarcBiblio($biblionumber);
695 ModZebra( $biblionumber, "specialUpdate", "biblioserver" );
697 #search item field code
698 logaction("CATALOGUING", "DELETE", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
702 =head2 CheckItemPreSave
704 my $item_ref = TransformMarcToKoha($marc, 'items');
706 my %errors = CheckItemPreSave($item_ref);
707 if (exists $errors{'duplicate_barcode'}) {
708 print "item has duplicate barcode: ", $errors{'duplicate_barcode'}, "\n";
709 } elsif (exists $errors{'invalid_homebranch'}) {
710 print "item has invalid home branch: ", $errors{'invalid_homebranch'}, "\n";
711 } elsif (exists $errors{'invalid_holdingbranch'}) {
712 print "item has invalid holding branch: ", $errors{'invalid_holdingbranch'}, "\n";
717 Given a hashref containing item fields, determine if it can be
718 inserted or updated in the database. Specifically, checks for
719 database integrity issues, and returns a hash containing any
720 of the following keys, if applicable.
724 =item duplicate_barcode
726 Barcode, if it duplicates one already found in the database.
728 =item invalid_homebranch
730 Home branch, if not defined in branches table.
732 =item invalid_holdingbranch
734 Holding branch, if not defined in branches table.
738 This function does NOT implement any policy-related checks,
739 e.g., whether current operator is allowed to save an
740 item that has a given branch code.
744 sub CheckItemPreSave {
745 my $item_ref = shift;
749 # check for duplicate barcode
750 if (exists $item_ref->{'barcode'} and defined $item_ref->{'barcode'}) {
751 my $existing_itemnumber = GetItemnumberFromBarcode($item_ref->{'barcode'});
752 if ($existing_itemnumber) {
753 if (!exists $item_ref->{'itemnumber'} # new item
754 or $item_ref->{'itemnumber'} != $existing_itemnumber) { # existing item
755 $errors{'duplicate_barcode'} = $item_ref->{'barcode'};
760 # check for valid home branch
761 if (exists $item_ref->{'homebranch'} and defined $item_ref->{'homebranch'}) {
762 my $home_library = Koha::Libraries->find( $item_ref->{homebranch} );
763 unless (defined $home_library) {
764 $errors{'invalid_homebranch'} = $item_ref->{'homebranch'};
768 # check for valid holding branch
769 if (exists $item_ref->{'holdingbranch'} and defined $item_ref->{'holdingbranch'}) {
770 my $holding_library = Koha::Libraries->find( $item_ref->{holdingbranch} );
771 unless (defined $holding_library) {
772 $errors{'invalid_holdingbranch'} = $item_ref->{'holdingbranch'};
780 =head1 EXPORTED SPECIAL ACCESSOR FUNCTIONS
782 The following functions provide various ways of
783 getting an item record, a set of item records, or
784 lists of authorized values for certain item fields.
786 Some of the functions in this group are candidates
787 for refactoring -- for example, some of the code
788 in C<GetItemsByBiblioitemnumber> and C<GetItemsInfo>
789 has copy-and-paste work.
795 $itemstatushash = GetItemStatus($fwkcode);
797 Returns a list of valid values for the
798 C<items.notforloan> field.
800 NOTE: does B<not> return an individual item's
803 Can be MARC dependent.
805 But basically could be can be loan or not
806 Create a status selector with the following code
808 =head3 in PERL SCRIPT
810 my $itemstatushash = getitemstatus;
812 foreach my $thisstatus (keys %$itemstatushash) {
813 my %row =(value => $thisstatus,
814 statusname => $itemstatushash->{$thisstatus}->{'statusname'},
816 push @itemstatusloop, \%row;
818 $template->param(statusloop=>\@itemstatusloop);
822 <select name="statusloop" id="statusloop">
823 <option value="">Default</option>
824 [% FOREACH statusloo IN statusloop %]
825 [% IF ( statusloo.selected ) %]
826 <option value="[% statusloo.value %]" selected="selected">[% statusloo.statusname %]</option>
828 <option value="[% statusloo.value %]">[% statusloo.statusname %]</option>
837 # returns a reference to a hash of references to status...
840 my $dbh = C4::Context->dbh;
842 $fwk = '' unless ($fwk);
843 my ( $tag, $subfield ) =
844 GetMarcFromKohaField( "items.notforloan", $fwk );
845 if ( $tag and $subfield ) {
848 "SELECT authorised_value
849 FROM marc_subfield_structure
855 $sth->execute( $tag, $subfield, $fwk );
856 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
859 "SELECT authorised_value,lib
860 FROM authorised_values
865 $authvalsth->execute($authorisedvaluecat);
866 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
867 $itemstatus{$authorisedvalue} = $lib;
881 $itemstatus{"1"} = "Not For Loan";
885 =head2 GetItemLocation
887 $itemlochash = GetItemLocation($fwk);
889 Returns a list of valid values for the
890 C<items.location> field.
892 NOTE: does B<not> return an individual item's
895 where fwk stands for an optional framework code.
896 Create a location selector with the following code
898 =head3 in PERL SCRIPT
900 my $itemlochash = getitemlocation;
902 foreach my $thisloc (keys %$itemlochash) {
903 my $selected = 1 if $thisbranch eq $branch;
904 my %row =(locval => $thisloc,
905 selected => $selected,
906 locname => $itemlochash->{$thisloc},
908 push @itemlocloop, \%row;
910 $template->param(itemlocationloop => \@itemlocloop);
914 <select name="location">
915 <option value="">Default</option>
916 <!-- TMPL_LOOP name="itemlocationloop" -->
917 <option value="<!-- TMPL_VAR name="locval" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="locname" --></option>
923 sub GetItemLocation {
925 # returns a reference to a hash of references to location...
928 my $dbh = C4::Context->dbh;
930 $fwk = '' unless ($fwk);
931 my ( $tag, $subfield ) =
932 GetMarcFromKohaField( "items.location", $fwk );
933 if ( $tag and $subfield ) {
936 "SELECT authorised_value
937 FROM marc_subfield_structure
942 $sth->execute( $tag, $subfield, $fwk );
943 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
946 "SELECT authorised_value,lib
947 FROM authorised_values
951 $authvalsth->execute($authorisedvaluecat);
952 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
953 $itemlocation{$authorisedvalue} = $lib;
955 return \%itemlocation;
967 $itemlocation{"1"} = "Not For Loan";
968 return \%itemlocation;
973 $items = GetLostItems( $where );
975 This function gets a list of lost items.
981 C<$where> is a hashref. it containts a field of the items table as key
982 and the value to match as value. For example:
984 { barcode => 'abc123',
985 homebranch => 'CPL', }
989 C<$items> is a reference to an array full of hashrefs with columns
990 from the "items" table as keys.
992 =item usage in the perl script:
994 my $where = { barcode => '0001548' };
995 my $items = GetLostItems( $where );
996 $template->param( itemsloop => $items );
1003 # Getting input args.
1005 my $dbh = C4::Context->dbh;
1008 SELECT title, author, lib, itemlost, authorised_value, barcode, datelastseen, price, replacementprice, homebranch,
1009 itype, itemtype, holdingbranch, location, itemnotes, items.biblionumber as biblionumber, itemcallnumber
1011 LEFT JOIN biblio ON (items.biblionumber = biblio.biblionumber)
1012 LEFT JOIN biblioitems ON (items.biblionumber = biblioitems.biblionumber)
1013 LEFT JOIN authorised_values ON (items.itemlost = authorised_values.authorised_value)
1015 authorised_values.category = 'LOST'
1016 AND itemlost IS NOT NULL
1019 my @query_parameters;
1020 foreach my $key (keys %$where) {
1021 $query .= " AND $key LIKE ?";
1022 push @query_parameters, "%$where->{$key}%";
1025 my $sth = $dbh->prepare($query);
1026 $sth->execute( @query_parameters );
1028 while ( my $row = $sth->fetchrow_hashref ){
1034 =head2 GetItemsForInventory
1036 ($itemlist, $iTotalRecords) = GetItemsForInventory( {
1037 minlocation => $minlocation,
1038 maxlocation => $maxlocation,
1039 location => $location,
1040 itemtype => $itemtype,
1041 ignoreissued => $ignoreissued,
1042 datelastseen => $datelastseen,
1043 branchcode => $branchcode,
1047 statushash => $statushash,
1048 interface => $interface,
1051 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
1053 The sub returns a reference to a list of hashes, each containing
1054 itemnumber, author, title, barcode, item callnumber, and date last
1055 seen. It is ordered by callnumber then title.
1057 The required minlocation & maxlocation parameters are used to specify a range of item callnumbers
1058 the datelastseen can be used to specify that you want to see items not seen since a past date only.
1059 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
1060 $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.
1062 $iTotalRecords is the number of rows that would have been returned without the $offset, $size limit clause
1066 sub GetItemsForInventory {
1067 my ( $parameters ) = @_;
1068 my $minlocation = $parameters->{'minlocation'} // '';
1069 my $maxlocation = $parameters->{'maxlocation'} // '';
1070 my $location = $parameters->{'location'} // '';
1071 my $itemtype = $parameters->{'itemtype'} // '';
1072 my $ignoreissued = $parameters->{'ignoreissued'} // '';
1073 my $datelastseen = $parameters->{'datelastseen'} // '';
1074 my $branchcode = $parameters->{'branchcode'} // '';
1075 my $branch = $parameters->{'branch'} // '';
1076 my $offset = $parameters->{'offset'} // '';
1077 my $size = $parameters->{'size'} // '';
1078 my $statushash = $parameters->{'statushash'} // '';
1079 my $interface = $parameters->{'interface'} // '';
1081 my $dbh = C4::Context->dbh;
1082 my ( @bind_params, @where_strings );
1084 my $select_columns = q{
1085 SELECT items.itemnumber, barcode, itemcallnumber, title, author, biblio.biblionumber, biblio.frameworkcode, datelastseen, homebranch, location, notforloan, damaged, itemlost, withdrawn, stocknumber
1087 my $select_count = q{SELECT COUNT(*)};
1090 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
1091 LEFT JOIN biblioitems on items.biblionumber = biblioitems.biblionumber
1094 for my $authvfield (keys %$statushash){
1095 if ( scalar @{$statushash->{$authvfield}} > 0 ){
1096 my $joinedvals = join ',', @{$statushash->{$authvfield}};
1097 push @where_strings, "$authvfield in (" . $joinedvals . ")";
1103 push @where_strings, 'itemcallnumber >= ?';
1104 push @bind_params, $minlocation;
1108 push @where_strings, 'itemcallnumber <= ?';
1109 push @bind_params, $maxlocation;
1112 if ($datelastseen) {
1113 $datelastseen = output_pref({ str => $datelastseen, dateformat => 'iso', dateonly => 1 });
1114 push @where_strings, '(datelastseen < ? OR datelastseen IS NULL)';
1115 push @bind_params, $datelastseen;
1119 push @where_strings, 'items.location = ?';
1120 push @bind_params, $location;
1123 if ( $branchcode ) {
1124 if($branch eq "homebranch"){
1125 push @where_strings, 'items.homebranch = ?';
1127 push @where_strings, 'items.holdingbranch = ?';
1129 push @bind_params, $branchcode;
1133 push @where_strings, 'biblioitems.itemtype = ?';
1134 push @bind_params, $itemtype;
1137 if ( $ignoreissued) {
1138 $query .= "LEFT JOIN issues ON items.itemnumber = issues.itemnumber ";
1139 push @where_strings, 'issues.date_due IS NULL';
1142 if ( @where_strings ) {
1144 $query .= join ' AND ', @where_strings;
1146 $query .= ' ORDER BY items.cn_sort, itemcallnumber, title';
1147 my $count_query = $select_count . $query;
1148 $query .= " LIMIT $offset, $size" if ($offset and $size);
1149 $query = $select_columns . $query;
1150 my $sth = $dbh->prepare($query);
1151 $sth->execute( @bind_params );
1154 my $tmpresults = $sth->fetchall_arrayref({});
1155 $sth = $dbh->prepare( $count_query );
1156 $sth->execute( @bind_params );
1157 my ($iTotalRecords) = $sth->fetchrow_array();
1159 my $avmapping = C4::Koha::GetKohaAuthorisedValuesMapping( {
1160 interface => $interface
1162 foreach my $row (@$tmpresults) {
1165 foreach (keys %$row) {
1166 if (defined($avmapping->{"items.$_,".$row->{'frameworkcode'}.",".$row->{$_}})) {
1167 $row->{$_} = $avmapping->{"items.$_,".$row->{'frameworkcode'}.",".$row->{$_}};
1170 push @results, $row;
1173 return (\@results, $iTotalRecords);
1176 =head2 GetItemsCount
1178 $count = &GetItemsCount( $biblionumber);
1180 This function return count of item with $biblionumber
1185 my ( $biblionumber ) = @_;
1186 my $dbh = C4::Context->dbh;
1187 my $query = "SELECT count(*)
1189 WHERE biblionumber=?";
1190 my $sth = $dbh->prepare($query);
1191 $sth->execute($biblionumber);
1192 my $count = $sth->fetchrow;
1196 =head2 GetItemInfosOf
1198 GetItemInfosOf(@itemnumbers);
1202 sub GetItemInfosOf {
1203 my @itemnumbers = @_;
1205 my $itemnumber_values = @itemnumbers ? join( ',', @itemnumbers ) : "''";
1210 WHERE itemnumber IN ($itemnumber_values)
1212 return get_infos_of( $query, 'itemnumber' );
1215 =head2 GetItemsByBiblioitemnumber
1217 GetItemsByBiblioitemnumber($biblioitemnumber);
1219 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1220 Called by C<C4::XISBN>
1224 sub GetItemsByBiblioitemnumber {
1225 my ( $bibitem ) = @_;
1226 my $dbh = C4::Context->dbh;
1227 my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1228 # Get all items attached to a biblioitem
1231 $sth->execute($bibitem) || die $sth->errstr;
1232 while ( my $data = $sth->fetchrow_hashref ) {
1233 # Foreach item, get circulation information
1234 my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1235 WHERE itemnumber = ?
1236 AND issues.borrowernumber = borrowers.borrowernumber"
1238 $sth2->execute( $data->{'itemnumber'} );
1239 if ( my $data2 = $sth2->fetchrow_hashref ) {
1240 # if item is out, set the due date and who it is out too
1241 $data->{'date_due'} = $data2->{'date_due'};
1242 $data->{'cardnumber'} = $data2->{'cardnumber'};
1243 $data->{'borrowernumber'} = $data2->{'borrowernumber'};
1246 # set date_due to blank, so in the template we check itemlost, and withdrawn
1247 $data->{'date_due'} = '';
1249 # Find the last 3 people who borrowed this item.
1250 my $query2 = "SELECT * FROM old_issues, borrowers WHERE itemnumber = ?
1251 AND old_issues.borrowernumber = borrowers.borrowernumber
1252 ORDER BY returndate desc,timestamp desc LIMIT 3";
1253 $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1254 $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1256 while ( my $data2 = $sth2->fetchrow_hashref ) {
1257 $data->{"timestamp$i2"} = $data2->{'timestamp'};
1258 $data->{"card$i2"} = $data2->{'cardnumber'};
1259 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
1262 push(@results,$data);
1269 @results = GetItemsInfo($biblionumber);
1271 Returns information about items with the given biblionumber.
1273 C<GetItemsInfo> returns a list of references-to-hash. Each element
1274 contains a number of keys. Most of them are attributes from the
1275 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
1276 Koha database. Other keys include:
1280 =item C<$data-E<gt>{branchname}>
1282 The name (not the code) of the branch to which the book belongs.
1284 =item C<$data-E<gt>{datelastseen}>
1286 This is simply C<items.datelastseen>, except that while the date is
1287 stored in YYYY-MM-DD format in the database, here it is converted to
1288 DD/MM/YYYY format. A NULL date is returned as C<//>.
1290 =item C<$data-E<gt>{datedue}>
1292 =item C<$data-E<gt>{class}>
1294 This is the concatenation of C<biblioitems.classification>, the book's
1295 Dewey code, and C<biblioitems.subclass>.
1297 =item C<$data-E<gt>{ocount}>
1299 I think this is the number of copies of the book available.
1301 =item C<$data-E<gt>{order}>
1303 If this is set, it is set to C<One Order>.
1310 my ( $biblionumber ) = @_;
1311 my $dbh = C4::Context->dbh;
1312 # note biblioitems.* must be avoided to prevent large marc and marcxml fields from killing performance.
1313 require C4::Languages;
1314 my $language = C4::Languages::getlanguage();
1320 biblioitems.itemtype,
1323 biblioitems.publicationyear,
1324 biblioitems.publishercode,
1325 biblioitems.volumedate,
1326 biblioitems.volumedesc,
1329 items.notforloan as itemnotforloan,
1330 issues.borrowernumber,
1331 issues.date_due as datedue,
1332 issues.onsite_checkout,
1333 borrowers.cardnumber,
1335 borrowers.firstname,
1336 borrowers.branchcode as bcode,
1338 serial.publisheddate,
1339 itemtypes.description,
1340 COALESCE( localization.translation, itemtypes.description ) AS translated_description,
1341 itemtypes.notforloan as notforloan_per_itemtype,
1345 holding.opac_info as holding_branch_opac_info,
1346 home.opac_info as home_branch_opac_info
1350 LEFT JOIN branches AS holding ON items.holdingbranch = holding.branchcode
1351 LEFT JOIN branches AS home ON items.homebranch=home.branchcode
1352 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1353 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1354 LEFT JOIN issues USING (itemnumber)
1355 LEFT JOIN borrowers USING (borrowernumber)
1356 LEFT JOIN serialitems USING (itemnumber)
1357 LEFT JOIN serial USING (serialid)
1358 LEFT JOIN itemtypes ON itemtypes.itemtype = "
1359 . (C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype');
1361 LEFT JOIN localization ON itemtypes.itemtype = localization.code
1362 AND localization.entity = 'itemtypes'
1363 AND localization.lang = ?
1366 $query .= " WHERE items.biblionumber = ? ORDER BY home.branchname, items.enumchron, LPAD( items.copynumber, 8, '0' ), items.dateaccessioned DESC" ;
1367 my $sth = $dbh->prepare($query);
1368 $sth->execute($language, $biblionumber);
1373 my $userenv = C4::Context->userenv;
1374 my $want_not_same_branch = C4::Context->preference("IndependentBranches") && !C4::Context->IsSuperLibrarian();
1375 while ( my $data = $sth->fetchrow_hashref ) {
1376 if ( $data->{borrowernumber} && $want_not_same_branch) {
1377 $data->{'NOTSAMEBRANCH'} = $data->{'bcode'} ne $userenv->{branch};
1380 $serial ||= $data->{'serial'};
1382 # get notforloan complete status if applicable
1383 if ( my $code = C4::Koha::GetAuthValCode( 'items.notforloan', $data->{frameworkcode} ) ) {
1384 $data->{notforloanvalue} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{itemnotforloan} );
1385 $data->{notforloanvalueopac} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{itemnotforloan}, 1 );
1388 # get restricted status and description if applicable
1389 if ( my $code = C4::Koha::GetAuthValCode( 'items.restricted', $data->{frameworkcode} ) ) {
1390 $data->{restrictedopac} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{restricted}, 1 );
1391 $data->{restricted} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{restricted} );
1394 # my stack procedures
1395 if ( my $code = C4::Koha::GetAuthValCode( 'items.stack', $data->{frameworkcode} ) ) {
1396 $data->{stack} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{stack} );
1399 # Find the last 3 people who borrowed this item.
1400 my $sth2 = $dbh->prepare("SELECT * FROM old_issues,borrowers
1401 WHERE itemnumber = ?
1402 AND old_issues.borrowernumber = borrowers.borrowernumber
1403 ORDER BY returndate DESC
1405 $sth2->execute($data->{'itemnumber'});
1407 while (my $data2 = $sth2->fetchrow_hashref()) {
1408 $data->{"timestamp$ii"} = $data2->{'timestamp'} if $data2->{'timestamp'};
1409 $data->{"card$ii"} = $data2->{'cardnumber'} if $data2->{'cardnumber'};
1410 $data->{"borrower$ii"} = $data2->{'borrowernumber'} if $data2->{'borrowernumber'};
1414 $results[$i] = $data;
1419 ? sort { ($b->{'publisheddate'} || $b->{'enumchron'}) cmp ($a->{'publisheddate'} || $a->{'enumchron'}) } @results
1423 =head2 GetItemsLocationInfo
1425 my @itemlocinfo = GetItemsLocationInfo($biblionumber);
1427 Returns the branch names, shelving location and itemcallnumber for each item attached to the biblio in question
1429 C<GetItemsInfo> returns a list of references-to-hash. Data returned:
1433 =item C<$data-E<gt>{homebranch}>
1435 Branch Name of the item's homebranch
1437 =item C<$data-E<gt>{holdingbranch}>
1439 Branch Name of the item's holdingbranch
1441 =item C<$data-E<gt>{location}>
1443 Item's shelving location code
1445 =item C<$data-E<gt>{location_intranet}>
1447 The intranet description for the Shelving Location as set in authorised_values 'LOC'
1449 =item C<$data-E<gt>{location_opac}>
1451 The OPAC description for the Shelving Location as set in authorised_values 'LOC'. Falls back to intranet description if no OPAC
1454 =item C<$data-E<gt>{itemcallnumber}>
1456 Item's itemcallnumber
1458 =item C<$data-E<gt>{cn_sort}>
1460 Item's call number normalized for sorting
1466 sub GetItemsLocationInfo {
1467 my $biblionumber = shift;
1470 my $dbh = C4::Context->dbh;
1471 my $query = "SELECT a.branchname as homebranch, b.branchname as holdingbranch,
1472 location, itemcallnumber, cn_sort
1473 FROM items, branches as a, branches as b
1474 WHERE homebranch = a.branchcode AND holdingbranch = b.branchcode
1475 AND biblionumber = ?
1476 ORDER BY cn_sort ASC";
1477 my $sth = $dbh->prepare($query);
1478 $sth->execute($biblionumber);
1480 while ( my $data = $sth->fetchrow_hashref ) {
1481 $data->{location_intranet} = GetKohaAuthorisedValueLib('LOC', $data->{location});
1482 $data->{location_opac}= GetKohaAuthorisedValueLib('LOC', $data->{location}, 1);
1483 push @results, $data;
1488 =head2 GetHostItemsInfo
1490 $hostiteminfo = GetHostItemsInfo($hostfield);
1491 Returns the iteminfo for items linked to records via a host field
1495 sub GetHostItemsInfo {
1497 my @returnitemsInfo;
1499 if (C4::Context->preference('marcflavour') eq 'MARC21' ||
1500 C4::Context->preference('marcflavour') eq 'NORMARC'){
1501 foreach my $hostfield ( $record->field('773') ) {
1502 my $hostbiblionumber = $hostfield->subfield("0");
1503 my $linkeditemnumber = $hostfield->subfield("9");
1504 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1505 foreach my $hostitemInfo (@hostitemInfos){
1506 if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1507 push (@returnitemsInfo,$hostitemInfo);
1512 } elsif ( C4::Context->preference('marcflavour') eq 'UNIMARC'){
1513 foreach my $hostfield ( $record->field('461') ) {
1514 my $hostbiblionumber = $hostfield->subfield("0");
1515 my $linkeditemnumber = $hostfield->subfield("9");
1516 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1517 foreach my $hostitemInfo (@hostitemInfos){
1518 if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1519 push (@returnitemsInfo,$hostitemInfo);
1525 return @returnitemsInfo;
1529 =head2 GetLastAcquisitions
1531 my $lastacq = GetLastAcquisitions({'branches' => ('branch1','branch2'),
1532 'itemtypes' => ('BK','BD')}, 10);
1536 sub GetLastAcquisitions {
1537 my ($data,$max) = @_;
1539 my $itemtype = C4::Context->preference('item-level_itypes') ? 'itype' : 'itemtype';
1541 my $number_of_branches = @{$data->{branches}};
1542 my $number_of_itemtypes = @{$data->{itemtypes}};
1545 my @where = ('WHERE 1 ');
1546 $number_of_branches and push @where
1547 , 'AND holdingbranch IN ('
1548 , join(',', ('?') x $number_of_branches )
1552 $number_of_itemtypes and push @where
1553 , "AND $itemtype IN ("
1554 , join(',', ('?') x $number_of_itemtypes )
1558 my $query = "SELECT biblio.biblionumber as biblionumber, title, dateaccessioned
1559 FROM items RIGHT JOIN biblio ON (items.biblionumber=biblio.biblionumber)
1560 RIGHT JOIN biblioitems ON (items.biblioitemnumber=biblioitems.biblioitemnumber)
1562 GROUP BY biblio.biblionumber
1563 ORDER BY dateaccessioned DESC LIMIT $max";
1565 my $dbh = C4::Context->dbh;
1566 my $sth = $dbh->prepare($query);
1568 $sth->execute((@{$data->{branches}}, @{$data->{itemtypes}}));
1571 while( my $row = $sth->fetchrow_hashref){
1572 push @results, {date => $row->{dateaccessioned}
1573 , biblionumber => $row->{biblionumber}
1574 , title => $row->{title}};
1580 =head2 GetItemnumbersForBiblio
1582 my $itemnumbers = GetItemnumbersForBiblio($biblionumber);
1584 Given a single biblionumber, return an arrayref of all the corresponding itemnumbers
1588 sub GetItemnumbersForBiblio {
1589 my $biblionumber = shift;
1591 my $dbh = C4::Context->dbh;
1592 my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber = ?");
1593 $sth->execute($biblionumber);
1594 while (my $result = $sth->fetchrow_hashref) {
1595 push @items, $result->{'itemnumber'};
1600 =head2 get_itemnumbers_of
1602 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1604 Given a list of biblionumbers, return the list of corresponding itemnumbers
1605 for each biblionumber.
1607 Return a reference on a hash where keys are biblionumbers and values are
1608 references on array of itemnumbers.
1612 sub get_itemnumbers_of {
1613 my @biblionumbers = @_;
1615 my $dbh = C4::Context->dbh;
1621 WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1623 my $sth = $dbh->prepare($query);
1624 $sth->execute(@biblionumbers);
1628 while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1629 push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1632 return \%itemnumbers_of;
1635 =head2 get_hostitemnumbers_of
1637 my @itemnumbers_of = get_hostitemnumbers_of($biblionumber);
1639 Given a biblionumber, return the list of corresponding itemnumbers that are linked to it via host fields
1641 Return a reference on a hash where key is a biblionumber and values are
1642 references on array of itemnumbers.
1647 sub get_hostitemnumbers_of {
1648 my ($biblionumber) = @_;
1649 my $marcrecord = GetMarcBiblio($biblionumber);
1651 return unless $marcrecord;
1653 my ( @returnhostitemnumbers, $tag, $biblio_s, $item_s );
1655 my $marcflavor = C4::Context->preference('marcflavour');
1656 if ( $marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC' ) {
1661 elsif ( $marcflavor eq 'UNIMARC' ) {
1667 foreach my $hostfield ( $marcrecord->field($tag) ) {
1668 my $hostbiblionumber = $hostfield->subfield($biblio_s);
1669 my $linkeditemnumber = $hostfield->subfield($item_s);
1671 if ( my $itemnumbers =
1672 get_itemnumbers_of($hostbiblionumber)->{$hostbiblionumber} )
1674 @itemnumbers = @$itemnumbers;
1676 foreach my $itemnumber (@itemnumbers) {
1677 if ( $itemnumber eq $linkeditemnumber ) {
1678 push( @returnhostitemnumbers, $itemnumber );
1684 return @returnhostitemnumbers;
1688 =head2 GetItemnumberFromBarcode
1690 $result = GetItemnumberFromBarcode($barcode);
1694 sub GetItemnumberFromBarcode {
1696 my $dbh = C4::Context->dbh;
1699 $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1700 $rq->execute($barcode);
1701 my ($result) = $rq->fetchrow;
1705 =head2 GetBarcodeFromItemnumber
1707 $result = GetBarcodeFromItemnumber($itemnumber);
1711 sub GetBarcodeFromItemnumber {
1712 my ($itemnumber) = @_;
1713 my $dbh = C4::Context->dbh;
1716 $dbh->prepare("SELECT barcode FROM items WHERE items.itemnumber=?");
1717 $rq->execute($itemnumber);
1718 my ($result) = $rq->fetchrow;
1722 =head2 GetHiddenItemnumbers
1724 my @itemnumbers_to_hide = GetHiddenItemnumbers(@items);
1726 Given a list of items it checks which should be hidden from the OPAC given
1727 the current configuration. Returns a list of itemnumbers corresponding to
1728 those that should be hidden.
1732 sub GetHiddenItemnumbers {
1736 my $yaml = C4::Context->preference('OpacHiddenItems');
1737 return () if (! $yaml =~ /\S/ );
1738 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1741 $hidingrules = YAML::Load($yaml);
1744 warn "Unable to parse OpacHiddenItems syspref : $@";
1747 my $dbh = C4::Context->dbh;
1750 foreach my $item (@items) {
1752 # We check each rule
1753 foreach my $field (keys %$hidingrules) {
1755 if (exists $item->{$field}) {
1756 $val = $item->{$field};
1759 my $query = "SELECT $field from items where itemnumber = ?";
1760 $val = $dbh->selectrow_array($query, undef, $item->{'itemnumber'});
1762 $val = '' unless defined $val;
1764 # If the results matches the values in the yaml file
1765 if (any { $val eq $_ } @{$hidingrules->{$field}}) {
1767 # We add the itemnumber to the list
1768 push @resultitems, $item->{'itemnumber'};
1770 # If at least one rule matched for an item, no need to test the others
1775 return @resultitems;
1778 =head1 LIMITED USE FUNCTIONS
1780 The following functions, while part of the public API,
1781 are not exported. This is generally because they are
1782 meant to be used by only one script for a specific
1783 purpose, and should not be used in any other context
1784 without careful thought.
1790 my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1792 Returns MARC::Record of the item passed in parameter.
1793 This function is meant for use only in C<cataloguing/additem.pl>,
1794 where it is needed to support that script's MARC-like
1800 my ( $biblionumber, $itemnumber ) = @_;
1802 # GetMarcItem has been revised so that it does the following:
1803 # 1. Gets the item information from the items table.
1804 # 2. Converts it to a MARC field for storage in the bib record.
1806 # The previous behavior was:
1807 # 1. Get the bib record.
1808 # 2. Return the MARC tag corresponding to the item record.
1810 # The difference is that one treats the items row as authoritative,
1811 # while the other treats the MARC representation as authoritative
1812 # under certain circumstances.
1814 my $itemrecord = GetItem($itemnumber);
1816 # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1817 # Also, don't emit a subfield if the underlying field is blank.
1820 return Item2Marc($itemrecord,$biblionumber);
1824 my ($itemrecord,$biblionumber)=@_;
1827 defined($itemrecord->{$_}) && $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : ()
1828 } keys %{ $itemrecord }
1830 my $itemmarc = TransformKohaToMarc($mungeditem);
1831 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",GetFrameworkCode($biblionumber)||'');
1833 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1834 if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1835 foreach my $field ($itemmarc->field($itemtag)){
1836 $field->add_subfields(@$unlinked_item_subfields);
1842 =head1 PRIVATE FUNCTIONS AND VARIABLES
1844 The following functions are not meant to be called
1845 directly, but are documented in order to explain
1846 the inner workings of C<C4::Items>.
1850 =head2 %derived_columns
1852 This hash keeps track of item columns that
1853 are strictly derived from other columns in
1854 the item record and are not meant to be set
1857 Each key in the hash should be the name of a
1858 column (as named by TransformMarcToKoha). Each
1859 value should be hashref whose keys are the
1860 columns on which the derived column depends. The
1861 hashref should also contain a 'BUILDER' key
1862 that is a reference to a sub that calculates
1867 my %derived_columns = (
1868 'items.cn_sort' => {
1869 'itemcallnumber' => 1,
1870 'items.cn_source' => 1,
1871 'BUILDER' => \&_calc_items_cn_sort,
1875 =head2 _set_derived_columns_for_add
1877 _set_derived_column_for_add($item);
1879 Given an item hash representing a new item to be added,
1880 calculate any derived columns. Currently the only
1881 such column is C<items.cn_sort>.
1885 sub _set_derived_columns_for_add {
1888 foreach my $column (keys %derived_columns) {
1889 my $builder = $derived_columns{$column}->{'BUILDER'};
1890 my $source_values = {};
1891 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1892 next if $source_column eq 'BUILDER';
1893 $source_values->{$source_column} = $item->{$source_column};
1895 $builder->($item, $source_values);
1899 =head2 _set_derived_columns_for_mod
1901 _set_derived_column_for_mod($item);
1903 Given an item hash representing a new item to be modified.
1904 calculate any derived columns. Currently the only
1905 such column is C<items.cn_sort>.
1907 This routine differs from C<_set_derived_columns_for_add>
1908 in that it needs to handle partial item records. In other
1909 words, the caller of C<ModItem> may have supplied only one
1910 or two columns to be changed, so this function needs to
1911 determine whether any of the columns to be changed affect
1912 any of the derived columns. Also, if a derived column
1913 depends on more than one column, but the caller is not
1914 changing all of then, this routine retrieves the unchanged
1915 values from the database in order to ensure a correct
1920 sub _set_derived_columns_for_mod {
1923 foreach my $column (keys %derived_columns) {
1924 my $builder = $derived_columns{$column}->{'BUILDER'};
1925 my $source_values = {};
1926 my %missing_sources = ();
1927 my $must_recalc = 0;
1928 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1929 next if $source_column eq 'BUILDER';
1930 if (exists $item->{$source_column}) {
1932 $source_values->{$source_column} = $item->{$source_column};
1934 $missing_sources{$source_column} = 1;
1938 foreach my $source_column (keys %missing_sources) {
1939 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
1941 $builder->($item, $source_values);
1946 =head2 _do_column_fixes_for_mod
1948 _do_column_fixes_for_mod($item);
1950 Given an item hashref containing one or more
1951 columns to modify, fix up certain values.
1952 Specifically, set to 0 any passed value
1953 of C<notforloan>, C<damaged>, C<itemlost>, or
1954 C<withdrawn> that is either undefined or
1955 contains the empty string.
1959 sub _do_column_fixes_for_mod {
1962 if (exists $item->{'notforloan'} and
1963 (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
1964 $item->{'notforloan'} = 0;
1966 if (exists $item->{'damaged'} and
1967 (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
1968 $item->{'damaged'} = 0;
1970 if (exists $item->{'itemlost'} and
1971 (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
1972 $item->{'itemlost'} = 0;
1974 if (exists $item->{'withdrawn'} and
1975 (not defined $item->{'withdrawn'} or $item->{'withdrawn'} eq '')) {
1976 $item->{'withdrawn'} = 0;
1978 if (exists $item->{location}
1979 and $item->{location} ne 'CART'
1980 and $item->{location} ne 'PROC'
1981 and not $item->{permanent_location}
1983 $item->{'permanent_location'} = $item->{'location'};
1985 if (exists $item->{'timestamp'}) {
1986 delete $item->{'timestamp'};
1990 =head2 _get_single_item_column
1992 _get_single_item_column($column, $itemnumber);
1994 Retrieves the value of a single column from an C<items>
1995 row specified by C<$itemnumber>.
1999 sub _get_single_item_column {
2001 my $itemnumber = shift;
2003 my $dbh = C4::Context->dbh;
2004 my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
2005 $sth->execute($itemnumber);
2006 my ($value) = $sth->fetchrow();
2010 =head2 _calc_items_cn_sort
2012 _calc_items_cn_sort($item, $source_values);
2014 Helper routine to calculate C<items.cn_sort>.
2018 sub _calc_items_cn_sort {
2020 my $source_values = shift;
2022 $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
2025 =head2 _set_defaults_for_add
2027 _set_defaults_for_add($item_hash);
2029 Given an item hash representing an item to be added, set
2030 correct default values for columns whose default value
2031 is not handled by the DBMS. This includes the following
2038 C<items.dateaccessioned>
2060 sub _set_defaults_for_add {
2062 $item->{dateaccessioned} ||= output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
2063 $item->{$_} ||= 0 for (qw( notforloan damaged itemlost withdrawn));
2066 =head2 _koha_new_item
2068 my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
2070 Perform the actual insert into the C<items> table.
2074 sub _koha_new_item {
2075 my ( $item, $barcode ) = @_;
2076 my $dbh=C4::Context->dbh;
2078 $item->{permanent_location} //= $item->{location};
2080 "INSERT INTO items SET
2082 biblioitemnumber = ?,
2084 dateaccessioned = ?,
2088 replacementprice = ?,
2089 replacementpricedate = ?,
2090 datelastborrowed = ?,
2098 coded_location_qualifier = ?,
2101 itemnotes_nonpublic = ?,
2105 permanent_location = ?,
2117 more_subfields_xml = ?,
2122 my $sth = $dbh->prepare($query);
2123 my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
2125 $item->{'biblionumber'},
2126 $item->{'biblioitemnumber'},
2128 $item->{'dateaccessioned'},
2129 $item->{'booksellerid'},
2130 $item->{'homebranch'},
2132 $item->{'replacementprice'},
2133 $item->{'replacementpricedate'} || $today,
2134 $item->{datelastborrowed},
2135 $item->{datelastseen} || $today,
2137 $item->{'notforloan'},
2139 $item->{'itemlost'},
2140 $item->{'withdrawn'},
2141 $item->{'itemcallnumber'},
2142 $item->{'coded_location_qualifier'},
2143 $item->{'restricted'},
2144 $item->{'itemnotes'},
2145 $item->{'itemnotes_nonpublic'},
2146 $item->{'holdingbranch'},
2148 $item->{'location'},
2149 $item->{'permanent_location'},
2152 $item->{'renewals'},
2153 $item->{'reserves'},
2154 $item->{'items.cn_source'},
2155 $item->{'items.cn_sort'},
2158 $item->{'materials'},
2160 $item->{'enumchron'},
2161 $item->{'more_subfields_xml'},
2162 $item->{'copynumber'},
2163 $item->{'stocknumber'},
2164 $item->{'new_status'},
2168 if ( defined $sth->errstr ) {
2169 $error.="ERROR in _koha_new_item $query".$sth->errstr;
2172 $itemnumber = $dbh->{'mysql_insertid'};
2175 return ( $itemnumber, $error );
2178 =head2 MoveItemFromBiblio
2180 MoveItemFromBiblio($itenumber, $frombiblio, $tobiblio);
2182 Moves an item from a biblio to another
2184 Returns undef if the move failed or the biblionumber of the destination record otherwise
2188 sub MoveItemFromBiblio {
2189 my ($itemnumber, $frombiblio, $tobiblio) = @_;
2190 my $dbh = C4::Context->dbh;
2191 my ( $tobiblioitem ) = $dbh->selectrow_array(q|
2192 SELECT biblioitemnumber
2194 WHERE biblionumber = ?
2195 |, undef, $tobiblio );
2196 my $return = $dbh->do(q|
2198 SET biblioitemnumber = ?,
2200 WHERE itemnumber = ?
2201 AND biblionumber = ?
2202 |, undef, $tobiblioitem, $tobiblio, $itemnumber, $frombiblio );
2204 ModZebra( $tobiblio, "specialUpdate", "biblioserver" );
2205 ModZebra( $frombiblio, "specialUpdate", "biblioserver" );
2206 # Checking if the item we want to move is in an order
2207 require C4::Acquisition;
2208 my $order = C4::Acquisition::GetOrderFromItemnumber($itemnumber);
2210 # Replacing the biblionumber within the order if necessary
2211 $order->{'biblionumber'} = $tobiblio;
2212 C4::Acquisition::ModOrder($order);
2215 # Update reserves, hold_fill_targets, tmp_holdsqueue and linktracker tables
2216 for my $table_name ( qw( reserves hold_fill_targets tmp_holdsqueue linktracker ) ) {
2219 SET biblionumber = ?
2220 WHERE itemnumber = ?
2221 |, undef, $tobiblio, $itemnumber );
2228 =head2 ItemSafeToDelete
2230 ItemSafeToDelete( $biblionumber, $itemnumber);
2232 Exported function (core API) for checking whether an item record is safe to delete.
2234 returns 1 if the item is safe to delete,
2236 "book_on_loan" if the item is checked out,
2238 "not_same_branch" if the item is blocked by independent branches,
2240 "book_reserved" if the there are holds aganst the item, or
2242 "linked_analytics" if the item has linked analytic records.
2246 sub ItemSafeToDelete {
2247 my ( $biblionumber, $itemnumber ) = @_;
2249 my $dbh = C4::Context->dbh;
2253 my $countanalytics = GetAnalyticsCount($itemnumber);
2255 # check that there is no issue on this item before deletion.
2256 my $sth = $dbh->prepare(
2258 SELECT COUNT(*) FROM issues
2259 WHERE itemnumber = ?
2262 $sth->execute($itemnumber);
2263 my ($onloan) = $sth->fetchrow;
2265 my $item = GetItem($itemnumber);
2268 $status = "book_on_loan";
2270 elsif ( defined C4::Context->userenv
2271 and !C4::Context->IsSuperLibrarian()
2272 and C4::Context->preference("IndependentBranches")
2273 and ( C4::Context->userenv->{branch} ne $item->{'homebranch'} ) )
2275 $status = "not_same_branch";
2278 # check it doesn't have a waiting reserve
2279 $sth = $dbh->prepare(
2281 SELECT COUNT(*) FROM reserves
2282 WHERE (found = 'W' OR found = 'T')
2286 $sth->execute($itemnumber);
2287 my ($reserve) = $sth->fetchrow;
2289 $status = "book_reserved";
2291 elsif ( $countanalytics > 0 ) {
2292 $status = "linked_analytics";
2303 DelItemCheck( $biblionumber, $itemnumber);
2305 Exported function (core API) for deleting an item record in Koha if there no current issue.
2307 DelItemCheck wraps ItemSafeToDelete around DelItem.
2312 my ( $biblionumber, $itemnumber ) = @_;
2313 my $status = ItemSafeToDelete( $biblionumber, $itemnumber );
2315 if ( $status == 1 ) {
2318 biblionumber => $biblionumber,
2319 itemnumber => $itemnumber
2326 =head2 _koha_modify_item
2328 my ($itemnumber,$error) =_koha_modify_item( $item );
2330 Perform the actual update of the C<items> row. Note that this
2331 routine accepts a hashref specifying the columns to update.
2335 sub _koha_modify_item {
2337 my $dbh=C4::Context->dbh;
2340 my $query = "UPDATE items SET ";
2342 for my $key ( keys %$item ) {
2343 next if ( $key eq 'itemnumber' );
2345 push @bind, $item->{$key};
2348 $query .= " WHERE itemnumber=?";
2349 push @bind, $item->{'itemnumber'};
2350 my $sth = $dbh->prepare($query);
2351 $sth->execute(@bind);
2353 $error.="ERROR in _koha_modify_item $query: ".$sth->errstr;
2356 return ($item->{'itemnumber'},$error);
2359 =head2 _koha_delete_item
2361 _koha_delete_item( $itemnum );
2363 Internal function to delete an item record from the koha tables
2367 sub _koha_delete_item {
2368 my ( $itemnum ) = @_;
2370 my $dbh = C4::Context->dbh;
2371 # save the deleted item to deleteditems table
2372 my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
2373 $sth->execute($itemnum);
2374 my $data = $sth->fetchrow_hashref();
2376 # There is no item to delete
2377 return 0 unless $data;
2379 my $query = "INSERT INTO deleteditems SET ";
2381 foreach my $key ( keys %$data ) {
2382 next if ( $key eq 'timestamp' ); # timestamp will be set by db
2383 $query .= "$key = ?,";
2384 push( @bind, $data->{$key} );
2387 $sth = $dbh->prepare($query);
2388 $sth->execute(@bind);
2390 # delete from items table
2391 $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
2392 my $deleted = $sth->execute($itemnum);
2393 return ( $deleted == 1 ) ? 1 : 0;
2396 =head2 _marc_from_item_hash
2398 my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
2400 Given an item hash representing a complete item record,
2401 create a C<MARC::Record> object containing an embedded
2402 tag representing that item.
2404 The third, optional parameter C<$unlinked_item_subfields> is
2405 an arrayref of subfields (not mapped to C<items> fields per the
2406 framework) to be added to the MARC representation
2411 sub _marc_from_item_hash {
2413 my $frameworkcode = shift;
2414 my $unlinked_item_subfields;
2416 $unlinked_item_subfields = shift;
2419 # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
2420 # Also, don't emit a subfield if the underlying field is blank.
2421 my $mungeditem = { map { (defined($item->{$_}) and $item->{$_} ne '') ?
2422 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
2423 : () } keys %{ $item } };
2425 my $item_marc = MARC::Record->new();
2426 foreach my $item_field ( keys %{$mungeditem} ) {
2427 my ( $tag, $subfield ) = GetMarcFromKohaField( $item_field, $frameworkcode );
2428 next unless defined $tag and defined $subfield; # skip if not mapped to MARC field
2429 my @values = split(/\s?\|\s?/, $mungeditem->{$item_field}, -1);
2430 foreach my $value (@values){
2431 if ( my $field = $item_marc->field($tag) ) {
2432 $field->add_subfields( $subfield => $value );
2434 my $add_subfields = [];
2435 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2436 $add_subfields = $unlinked_item_subfields;
2438 $item_marc->add_fields( $tag, " ", " ", $subfield => $value, @$add_subfields );
2446 =head2 _repack_item_errors
2448 Add an error message hash generated by C<CheckItemPreSave>
2449 to a list of errors.
2453 sub _repack_item_errors {
2454 my $item_sequence_num = shift;
2455 my $item_ref = shift;
2456 my $error_ref = shift;
2458 my @repacked_errors = ();
2460 foreach my $error_code (sort keys %{ $error_ref }) {
2461 my $repacked_error = {};
2462 $repacked_error->{'item_sequence'} = $item_sequence_num;
2463 $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
2464 $repacked_error->{'error_code'} = $error_code;
2465 $repacked_error->{'error_information'} = $error_ref->{$error_code};
2466 push @repacked_errors, $repacked_error;
2469 return @repacked_errors;
2472 =head2 _get_unlinked_item_subfields
2474 my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
2478 sub _get_unlinked_item_subfields {
2479 my $original_item_marc = shift;
2480 my $frameworkcode = shift;
2482 my $marcstructure = GetMarcStructure(1, $frameworkcode, { unsafe => 1 });
2484 # assume that this record has only one field, and that that
2485 # field contains only the item information
2487 my @fields = $original_item_marc->fields();
2488 if ($#fields > -1) {
2489 my $field = $fields[0];
2490 my $tag = $field->tag();
2491 foreach my $subfield ($field->subfields()) {
2492 if (defined $subfield->[1] and
2493 $subfield->[1] ne '' and
2494 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
2495 push @$subfields, $subfield->[0] => $subfield->[1];
2502 =head2 _get_unlinked_subfields_xml
2504 my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
2508 sub _get_unlinked_subfields_xml {
2509 my $unlinked_item_subfields = shift;
2512 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2513 my $marc = MARC::Record->new();
2514 # use of tag 999 is arbitrary, and doesn't need to match the item tag
2515 # used in the framework
2516 $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
2517 $marc->encoding("UTF-8");
2518 $xml = $marc->as_xml("USMARC");
2524 =head2 _parse_unlinked_item_subfields_from_xml
2526 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2530 sub _parse_unlinked_item_subfields_from_xml {
2532 require C4::Charset;
2533 return unless defined $xml and $xml ne "";
2534 my $marc = MARC::Record->new_from_xml(C4::Charset::StripNonXmlChars($xml),'UTF-8');
2535 my $unlinked_subfields = [];
2536 my @fields = $marc->fields();
2537 if ($#fields > -1) {
2538 foreach my $subfield ($fields[0]->subfields()) {
2539 push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2542 return $unlinked_subfields;
2545 =head2 GetAnalyticsCount
2547 $count= &GetAnalyticsCount($itemnumber)
2549 counts Usage of itemnumber in Analytical bibliorecords.
2553 sub GetAnalyticsCount {
2554 my ($itemnumber) = @_;
2556 ### ZOOM search here
2558 $query= "hi=".$itemnumber;
2559 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
2560 my ($err,$res,$result) = $searcher->simple_search_compat($query,0,10);
2566 $holds = &GetItemHolds($biblionumber, $itemnumber);
2568 This function return the count of holds with $biblionumber and $itemnumber
2573 my ($biblionumber, $itemnumber) = @_;
2575 my $dbh = C4::Context->dbh;
2576 my $query = "SELECT count(*)
2578 WHERE biblionumber=? AND itemnumber=?";
2579 my $sth = $dbh->prepare($query);
2580 $sth->execute($biblionumber, $itemnumber);
2581 $holds = $sth->fetchrow;
2585 =head2 SearchItemsByField
2587 my $items = SearchItemsByField($field, $value);
2589 SearchItemsByField will search for items on a specific given field.
2590 For instance you can search all items with a specific stocknumber like this:
2592 my $items = SearchItemsByField('stocknumber', $stocknumber);
2596 sub SearchItemsByField {
2597 my ($field, $value) = @_;
2604 my ($results) = SearchItems($filters);
2608 sub _SearchItems_build_where_fragment {
2611 my $dbh = C4::Context->dbh;
2614 if (exists($filter->{conjunction})) {
2615 my (@where_strs, @where_args);
2616 foreach my $f (@{ $filter->{filters} }) {
2617 my $fragment = _SearchItems_build_where_fragment($f);
2619 push @where_strs, $fragment->{str};
2620 push @where_args, @{ $fragment->{args} };
2625 $where_str = '(' . join (' ' . $filter->{conjunction} . ' ', @where_strs) . ')';
2628 args => \@where_args,
2632 my @columns = Koha::Database->new()->schema()->resultset('Item')->result_source->columns;
2633 push @columns, Koha::Database->new()->schema()->resultset('Biblio')->result_source->columns;
2634 push @columns, Koha::Database->new()->schema()->resultset('Biblioitem')->result_source->columns;
2635 my @operators = qw(= != > < >= <= like);
2636 my $field = $filter->{field};
2637 if ( (0 < grep /^$field$/, @columns) or (substr($field, 0, 5) eq 'marc:') ) {
2638 my $op = $filter->{operator};
2639 my $query = $filter->{query};
2641 if (!$op or (0 == grep /^$op$/, @operators)) {
2642 $op = '='; # default operator
2646 if ($field =~ /^marc:(\d{3})(?:\$(\w))?$/) {
2648 my $marcsubfield = $2;
2649 my ($kohafield) = $dbh->selectrow_array(q|
2650 SELECT kohafield FROM marc_subfield_structure
2651 WHERE tagfield=? AND tagsubfield=? AND frameworkcode=''
2652 |, undef, $marcfield, $marcsubfield);
2655 $column = $kohafield;
2657 # MARC field is not linked to a DB field so we need to use
2658 # ExtractValue on biblioitems.marcxml or
2659 # items.more_subfields_xml, depending on the MARC field.
2662 my ($itemfield) = GetMarcFromKohaField('items.itemnumber');
2663 if ($marcfield eq $itemfield) {
2664 $sqlfield = 'more_subfields_xml';
2665 $xpath = '//record/datafield/subfield[@code="' . $marcsubfield . '"]';
2667 $sqlfield = 'marcxml';
2668 if ($marcfield < 10) {
2669 $xpath = "//record/controlfield[\@tag=\"$marcfield\"]";
2671 $xpath = "//record/datafield[\@tag=\"$marcfield\"]/subfield[\@code=\"$marcsubfield\"]";
2674 $column = "ExtractValue($sqlfield, '$xpath')";
2680 if (ref $query eq 'ARRAY') {
2683 } elsif ($op eq '!=') {
2687 str => "$column $op (" . join (',', ('?') x @$query) . ")",
2692 str => "$column $op ?",
2699 return $where_fragment;
2704 my ($items, $total) = SearchItems($filter, $params);
2706 Perform a search among items
2708 $filter is a reference to a hash which can be a filter, or a combination of filters.
2710 A filter has the following keys:
2714 =item * field: the name of a SQL column in table items
2716 =item * query: the value to search in this column
2718 =item * operator: comparison operator. Can be one of = != > < >= <= like
2722 A combination of filters hash the following keys:
2726 =item * conjunction: 'AND' or 'OR'
2728 =item * filters: array ref of filters
2732 $params is a reference to a hash that can contain the following parameters:
2736 =item * rows: Number of items to return. 0 returns everything (default: 0)
2738 =item * page: Page to return (return items from (page-1)*rows to (page*rows)-1)
2741 =item * sortby: A SQL column name in items table to sort on
2743 =item * sortorder: 'ASC' or 'DESC'
2750 my ($filter, $params) = @_;
2754 return unless ref $filter eq 'HASH';
2755 return unless ref $params eq 'HASH';
2757 # Default parameters
2758 $params->{rows} ||= 0;
2759 $params->{page} ||= 1;
2760 $params->{sortby} ||= 'itemnumber';
2761 $params->{sortorder} ||= 'ASC';
2763 my ($where_str, @where_args);
2764 my $where_fragment = _SearchItems_build_where_fragment($filter);
2765 if ($where_fragment) {
2766 $where_str = $where_fragment->{str};
2767 @where_args = @{ $where_fragment->{args} };
2770 my $dbh = C4::Context->dbh;
2772 SELECT SQL_CALC_FOUND_ROWS items.*
2774 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2775 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
2777 if (defined $where_str and $where_str ne '') {
2778 $query .= qq{ WHERE $where_str };
2781 my @columns = Koha::Database->new()->schema()->resultset('Item')->result_source->columns;
2782 push @columns, Koha::Database->new()->schema()->resultset('Biblio')->result_source->columns;
2783 push @columns, Koha::Database->new()->schema()->resultset('Biblioitem')->result_source->columns;
2784 my $sortby = (0 < grep {$params->{sortby} eq $_} @columns)
2785 ? $params->{sortby} : 'itemnumber';
2786 my $sortorder = (uc($params->{sortorder}) eq 'ASC') ? 'ASC' : 'DESC';
2787 $query .= qq{ ORDER BY $sortby $sortorder };
2789 my $rows = $params->{rows};
2792 my $offset = $rows * ($params->{page}-1);
2793 $query .= qq { LIMIT ?, ? };
2794 push @limit_args, $offset, $rows;
2797 my $sth = $dbh->prepare($query);
2798 my $rv = $sth->execute(@where_args, @limit_args);
2800 return unless ($rv);
2801 my ($total_rows) = $dbh->selectrow_array(q{ SELECT FOUND_ROWS() });
2803 return ($sth->fetchall_arrayref({}), $total_rows);
2807 =head1 OTHER FUNCTIONS
2811 ($indicators, $value) = _find_value($tag, $subfield, $record,$encoding);
2813 Find the given $subfield in the given $tag in the given
2814 MARC::Record $record. If the subfield is found, returns
2815 the (indicators, value) pair; otherwise, (undef, undef) is
2819 Such a function is used in addbiblio AND additem and serial-edit and maybe could be used in Authorities.
2820 I suggest we export it from this module.
2825 my ( $tagfield, $insubfield, $record, $encoding ) = @_;
2828 if ( $tagfield < 10 ) {
2829 if ( $record->field($tagfield) ) {
2830 push @result, $record->field($tagfield)->data();
2835 foreach my $field ( $record->field($tagfield) ) {
2836 my @subfields = $field->subfields();
2837 foreach my $subfield (@subfields) {
2838 if ( @$subfield[0] eq $insubfield ) {
2839 push @result, @$subfield[1];
2840 $indicator = $field->indicator(1) . $field->indicator(2);
2845 return ( $indicator, @result );
2849 =head2 PrepareItemrecordDisplay
2851 PrepareItemrecordDisplay($itemrecord,$bibnum,$itemumber,$frameworkcode);
2853 Returns a hash with all the fields for Display a given item data in a template
2855 The $frameworkcode returns the item for the given frameworkcode, ONLY if bibnum is not provided
2859 sub PrepareItemrecordDisplay {
2861 my ( $bibnum, $itemnum, $defaultvalues, $frameworkcode ) = @_;
2863 my $dbh = C4::Context->dbh;
2864 $frameworkcode = &GetFrameworkCode($bibnum) if $bibnum;
2865 my ( $itemtagfield, $itemtagsubfield ) = &GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
2867 # Note: $tagslib obtained from GetMarcStructure() in 'unsafe' mode is
2868 # a shared data structure. No plugin (including custom ones) should change
2869 # its contents. See also GetMarcStructure.
2870 my $tagslib = &GetMarcStructure( 1, $frameworkcode, { unsafe => 1 } );
2872 # return nothing if we don't have found an existing framework.
2873 return q{} unless $tagslib;
2876 $itemrecord = C4::Items::GetMarcItem( $bibnum, $itemnum );
2880 my $branch_limit = C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
2882 SELECT authorised_value,lib FROM authorised_values
2885 LEFT JOIN authorised_values_branches ON ( id = av_id )
2890 $query .= qq{ AND ( branchcode = ? OR branchcode IS NULL )} if $branch_limit;
2891 $query .= qq{ ORDER BY lib};
2892 my $authorised_values_sth = $dbh->prepare( $query );
2893 foreach my $tag ( sort keys %{$tagslib} ) {
2896 # loop through each subfield
2898 foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
2899 next if IsMarcStructureInternal($tagslib->{$tag}{$subfield});
2900 next unless ( $tagslib->{$tag}->{$subfield}->{'tab'} );
2901 next if ( $tagslib->{$tag}->{$subfield}->{'tab'} ne "10" );
2903 $subfield_data{tag} = $tag;
2904 $subfield_data{subfield} = $subfield;
2905 $subfield_data{countsubfield} = $cntsubf++;
2906 $subfield_data{kohafield} = $tagslib->{$tag}->{$subfield}->{'kohafield'};
2907 $subfield_data{id} = "tag_".$tag."_subfield_".$subfield."_".int(rand(1000000));
2909 # $subfield_data{marc_lib}=$tagslib->{$tag}->{$subfield}->{lib};
2910 $subfield_data{marc_lib} = $tagslib->{$tag}->{$subfield}->{lib};
2911 $subfield_data{mandatory} = $tagslib->{$tag}->{$subfield}->{mandatory};
2912 $subfield_data{repeatable} = $tagslib->{$tag}->{$subfield}->{repeatable};
2913 $subfield_data{hidden} = "display:none"
2914 if ( ( $tagslib->{$tag}->{$subfield}->{hidden} > 4 )
2915 || ( $tagslib->{$tag}->{$subfield}->{hidden} < -4 ) );
2916 my ( $x, $defaultvalue );
2918 ( $x, $defaultvalue ) = _find_value( $tag, $subfield, $itemrecord );
2920 $defaultvalue = $tagslib->{$tag}->{$subfield}->{defaultvalue} unless $defaultvalue;
2921 if ( !defined $defaultvalue ) {
2922 $defaultvalue = q||;
2924 $defaultvalue =~ s/"/"/g;
2927 # search for itemcallnumber if applicable
2928 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.itemcallnumber'
2929 && C4::Context->preference('itemcallnumber') ) {
2930 my $CNtag = substr( C4::Context->preference('itemcallnumber'), 0, 3 );
2931 my $CNsubfield = substr( C4::Context->preference('itemcallnumber'), 3, 1 );
2932 if ( $itemrecord and my $field = $itemrecord->field($CNtag) ) {
2933 $defaultvalue = $field->subfield($CNsubfield);
2936 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.itemcallnumber'
2938 && $defaultvalues->{'callnumber'} ) {
2939 if( $itemrecord and $defaultvalues and not $itemrecord->field($subfield) ){
2940 # if the item record exists, only use default value if the item has no callnumber
2941 $defaultvalue = $defaultvalues->{callnumber};
2942 } elsif ( !$itemrecord and $defaultvalues ) {
2943 # if the item record *doesn't* exists, always use the default value
2944 $defaultvalue = $defaultvalues->{callnumber};
2947 if ( ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.holdingbranch' || $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.homebranch' )
2949 && $defaultvalues->{'branchcode'} ) {
2950 if ( $itemrecord and $defaultvalues and not $itemrecord->field($subfield) ) {
2951 $defaultvalue = $defaultvalues->{branchcode};
2954 if ( ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.location' )
2956 && $defaultvalues->{'location'} ) {
2958 if ( $itemrecord and $defaultvalues and not $itemrecord->field($subfield) ) {
2959 # if the item record exists, only use default value if the item has no locationr
2960 $defaultvalue = $defaultvalues->{location};
2961 } elsif ( !$itemrecord and $defaultvalues ) {
2962 # if the item record *doesn't* exists, always use the default value
2963 $defaultvalue = $defaultvalues->{location};
2966 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
2967 my @authorised_values;
2970 # builds list, depending on authorised value...
2972 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
2973 if ( ( C4::Context->preference("IndependentBranches") )
2974 && !C4::Context->IsSuperLibrarian() ) {
2975 my $sth = $dbh->prepare( "SELECT branchcode,branchname FROM branches WHERE branchcode = ? ORDER BY branchname" );
2976 $sth->execute( C4::Context->userenv->{branch} );
2977 push @authorised_values, ""
2978 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2979 while ( my ( $branchcode, $branchname ) = $sth->fetchrow_array ) {
2980 push @authorised_values, $branchcode;
2981 $authorised_lib{$branchcode} = $branchname;
2984 my $sth = $dbh->prepare( "SELECT branchcode,branchname FROM branches ORDER BY branchname" );
2986 push @authorised_values, ""
2987 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2988 while ( my ( $branchcode, $branchname ) = $sth->fetchrow_array ) {
2989 push @authorised_values, $branchcode;
2990 $authorised_lib{$branchcode} = $branchname;
2994 $defaultvalue = C4::Context->userenv ? C4::Context->userenv->{branch} : undef;
2995 if ( $defaultvalues and $defaultvalues->{branchcode} ) {
2996 $defaultvalue = $defaultvalues->{branchcode};
3000 } elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "itemtypes" ) {
3001 my $itemtypes = GetItemTypes( style => 'array' );
3002 push @authorised_values, ""
3003 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
3004 for my $itemtype ( @$itemtypes ) {
3005 push @authorised_values, $itemtype->{itemtype};
3006 $authorised_lib{$itemtype->{itemtype}} = $itemtype->{translated_description};
3009 } elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "cn_source" ) {
3010 push @authorised_values, "" unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
3012 my $class_sources = GetClassSources();
3013 my $default_source = C4::Context->preference("DefaultClassificationSource");
3015 foreach my $class_source (sort keys %$class_sources) {
3016 next unless $class_sources->{$class_source}->{'used'} or
3017 ($class_source eq $default_source);
3018 push @authorised_values, $class_source;
3019 $authorised_lib{$class_source} = $class_sources->{$class_source}->{'description'};
3022 $defaultvalue = $default_source;
3024 #---- "true" authorised value
3026 $authorised_values_sth->execute(
3027 $tagslib->{$tag}->{$subfield}->{authorised_value},
3028 $branch_limit ? $branch_limit : ()
3030 push @authorised_values, ""
3031 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
3032 while ( my ( $value, $lib ) = $authorised_values_sth->fetchrow_array ) {
3033 push @authorised_values, $value;
3034 $authorised_lib{$value} = $lib;
3037 $subfield_data{marc_value} = {
3039 values => \@authorised_values,
3040 default => "$defaultvalue",
3041 labels => \%authorised_lib,
3043 } elsif ( $tagslib->{$tag}->{$subfield}->{value_builder} ) {
3045 require Koha::FrameworkPlugin;
3046 my $plugin = Koha::FrameworkPlugin->new({
3047 name => $tagslib->{$tag}->{$subfield}->{value_builder},
3050 my $pars = { dbh => $dbh, record => undef, tagslib =>$tagslib, id => $subfield_data{id}, tabloop => undef };
3051 $plugin->build( $pars );
3052 if( !$plugin->errstr ) {
3053 #TODO Move html to template; see report 12176/13397
3054 my $tab= $plugin->noclick? '-1': '';
3055 my $class= $plugin->noclick? ' disabled': '';
3056 my $title= $plugin->noclick? 'No popup': 'Tag editor';
3057 $subfield_data{marc_value} = qq[<input type="text" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" maxlength="255" /><a href="#" id="buttonDot_$subfield_data{id}" tabindex="$tab" class="buttonDot $class" title="$title">...</a>\n].$plugin->javascript;
3059 warn $plugin->errstr;
3060 $subfield_data{marc_value} = qq(<input type="text" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" maxlength="255" />); # supply default input form
3063 elsif ( $tag eq '' ) { # it's an hidden field
3064 $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" />);
3066 elsif ( $tagslib->{$tag}->{$subfield}->{'hidden'} ) { # FIXME: shouldn't input type be "hidden" ?
3067 $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" />);
3069 elsif ( length($defaultvalue) > 100
3070 or (C4::Context->preference("marcflavour") eq "UNIMARC" and
3071 300 <= $tag && $tag < 400 && $subfield eq 'a' )
3072 or (C4::Context->preference("marcflavour") eq "MARC21" and
3073 500 <= $tag && $tag < 600 )
3075 # oversize field (textarea)
3076 $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");
3078 $subfield_data{marc_value} = "<input type=\"text\" name=\"field_value\" value=\"$defaultvalue\" size=\"50\" maxlength=\"255\" />";
3080 push( @loop_data, \%subfield_data );
3085 if ( $itemrecord && $itemrecord->field($itemtagfield) ) {
3086 $itemnumber = $itemrecord->subfield( $itemtagfield, $itemtagsubfield );
3089 'itemtagfield' => $itemtagfield,
3090 'itemtagsubfield' => $itemtagsubfield,
3091 'itemnumber' => $itemnumber,
3092 'iteminformation' => \@loop_data
3096 sub ToggleNewStatus {
3097 my ( $params ) = @_;
3098 my @rules = @{ $params->{rules} };
3099 my $report_only = $params->{report_only};
3101 my $dbh = C4::Context->dbh;
3103 my @item_columns = map { "items.$_" } Koha::Items->columns;
3104 my @biblioitem_columns = map { "biblioitems.$_" } Koha::Biblioitems->columns;
3106 for my $rule ( @rules ) {
3107 my $age = $rule->{age};
3108 my $conditions = $rule->{conditions};
3109 my $substitutions = $rule->{substitutions};
3113 SELECT items.biblionumber, items.itemnumber
3115 LEFT JOIN biblioitems ON biblioitems.biblionumber = items.biblionumber
3118 for my $condition ( @$conditions ) {
3120 grep {/^$condition->{field}$/} @item_columns
3121 or grep {/^$condition->{field}$/} @biblioitem_columns
3123 if ( $condition->{value} =~ /\|/ ) {
3124 my @values = split /\|/, $condition->{value};
3125 $query .= qq| AND $condition->{field} IN (|
3126 . join( ',', ('?') x scalar @values )
3128 push @params, @values;
3130 $query .= qq| AND $condition->{field} = ?|;
3131 push @params, $condition->{value};
3135 if ( defined $age ) {
3136 $query .= q| AND TO_DAYS(NOW()) - TO_DAYS(dateaccessioned) >= ? |;
3139 my $sth = $dbh->prepare($query);
3140 $sth->execute( @params );
3141 while ( my $values = $sth->fetchrow_hashref ) {
3142 my $biblionumber = $values->{biblionumber};
3143 my $itemnumber = $values->{itemnumber};
3144 my $item = C4::Items::GetItem( $itemnumber );
3145 for my $substitution ( @$substitutions ) {
3146 next unless $substitution->{field};
3147 C4::Items::ModItem( {$substitution->{field} => $substitution->{value}}, $biblionumber, $itemnumber )
3148 unless $report_only;
3149 push @{ $report->{$itemnumber} }, $substitution;