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;
45 use vars qw(@ISA @EXPORT);
50 @ISA = qw( Exporter );
73 GetItemsByBiblioitemnumber
77 GetItemnumbersForBiblio
79 get_hostitemnumbers_of
80 GetItemnumberFromBarcode
81 GetBarcodeFromItemnumber
97 PrepareItemrecordDisplay
104 C4::Items - item management functions
108 This module contains an API for manipulating item
109 records in Koha, and is used by cataloguing, circulation,
110 acquisitions, and serials management.
112 A Koha item record is stored in two places: the
113 items table and embedded in a MARC tag in the XML
114 version of the associated bib record in C<biblioitems.marcxml>.
115 This is done to allow the item information to be readily
116 indexed (e.g., by Zebra), but means that each item
117 modification transaction must keep the items table
118 and the MARC XML in sync at all times.
120 Consequently, all code that creates, modifies, or deletes
121 item records B<must> use an appropriate function from
122 C<C4::Items>. If no existing function is suitable, it is
123 better to add one to C<C4::Items> than to use add
124 one-off SQL statements to add or modify items.
126 The items table will be considered authoritative. In other
127 words, if there is ever a discrepancy between the items
128 table and the MARC XML, the items table should be considered
131 =head1 HISTORICAL NOTE
133 Most of the functions in C<C4::Items> were originally in
134 the C<C4::Biblio> module.
136 =head1 CORE EXPORTED FUNCTIONS
138 The following functions are meant for use by users
145 $item = GetItem($itemnumber,$barcode,$serial);
147 Return item information, for a given itemnumber or barcode.
148 The return value is a hashref mapping item column
149 names to values. If C<$serial> is true, include serial publication data.
154 my ($itemnumber,$barcode, $serial) = @_;
155 my $dbh = C4::Context->dbh;
159 my $sth = $dbh->prepare("
161 WHERE itemnumber = ?");
162 $sth->execute($itemnumber);
163 $data = $sth->fetchrow_hashref;
165 my $sth = $dbh->prepare("
169 $sth->execute($barcode);
170 $data = $sth->fetchrow_hashref;
173 return unless ( $data );
176 my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=?");
177 $ssth->execute($data->{'itemnumber'}) ;
178 ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
180 #if we don't have an items.itype, use biblioitems.itemtype.
181 # FIXME this should respect the itypes systempreference
182 # if (C4::Context->preference('item-level_itypes')) {
183 if( ! $data->{'itype'} ) {
184 my $sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
185 $sth->execute($data->{'biblionumber'});
186 ($data->{'itype'}) = $sth->fetchrow_array;
193 CartToShelf($itemnumber);
195 Set the current shelving location of the item record
196 to its stored permanent shelving location. This is
197 primarily used to indicate when an item whose current
198 location is a special processing ('PROC') or shelving cart
199 ('CART') location is back in the stacks.
204 my ( $itemnumber ) = @_;
206 unless ( $itemnumber ) {
207 croak "FAILED CartToShelf() - no itemnumber supplied";
210 my $item = GetItem($itemnumber);
211 if ( $item->{location} eq 'CART' ) {
212 $item->{location} = $item->{permanent_location};
213 ModItem($item, undef, $itemnumber);
219 ShelfToCart($itemnumber);
221 Set the current shelving location of the item
222 to shelving cart ('CART').
227 my ( $itemnumber ) = @_;
229 unless ( $itemnumber ) {
230 croak "FAILED ShelfToCart() - no itemnumber supplied";
233 my $item = GetItem($itemnumber);
234 $item->{'location'} = 'CART';
235 ModItem($item, undef, $itemnumber);
238 =head2 AddItemFromMarc
240 my ($biblionumber, $biblioitemnumber, $itemnumber)
241 = AddItemFromMarc($source_item_marc, $biblionumber);
243 Given a MARC::Record object containing an embedded item
244 record and a biblionumber, create a new item record.
248 sub AddItemFromMarc {
249 my ( $source_item_marc, $biblionumber ) = @_;
250 my $dbh = C4::Context->dbh;
252 # parse item hash from MARC
253 my $frameworkcode = GetFrameworkCode( $biblionumber );
254 my ($itemtag,$itemsubfield)=GetMarcFromKohaField("items.itemnumber",$frameworkcode);
256 my $localitemmarc=MARC::Record->new;
257 $localitemmarc->append_fields($source_item_marc->field($itemtag));
258 my $item = &TransformMarcToKoha( $localitemmarc, $frameworkcode ,'items');
259 my $unlinked_item_subfields = _get_unlinked_item_subfields($localitemmarc, $frameworkcode);
260 return AddItem($item, $biblionumber, $dbh, $frameworkcode, $unlinked_item_subfields);
265 my ($biblionumber, $biblioitemnumber, $itemnumber)
266 = AddItem($item, $biblionumber[, $dbh, $frameworkcode, $unlinked_item_subfields]);
268 Given a hash containing item column names as keys,
269 create a new Koha item record.
271 The first two optional parameters (C<$dbh> and C<$frameworkcode>)
272 do not need to be supplied for general use; they exist
273 simply to allow them to be picked up from AddItemFromMarc.
275 The final optional parameter, C<$unlinked_item_subfields>, contains
276 an arrayref containing subfields present in the original MARC
277 representation of the item (e.g., from the item editor) that are
278 not mapped to C<items> columns directly but should instead
279 be stored in C<items.more_subfields_xml> and included in
280 the biblio items tag for display and indexing.
286 my $biblionumber = shift;
288 my $dbh = @_ ? shift : C4::Context->dbh;
289 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
290 my $unlinked_item_subfields;
292 $unlinked_item_subfields = shift
295 # needs old biblionumber and biblioitemnumber
296 $item->{'biblionumber'} = $biblionumber;
297 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
298 $sth->execute( $item->{'biblionumber'} );
299 ($item->{'biblioitemnumber'}) = $sth->fetchrow;
301 _set_defaults_for_add($item);
302 _set_derived_columns_for_add($item);
303 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
304 # FIXME - checks here
305 unless ( $item->{itype} ) { # default to biblioitem.itemtype if no itype
306 my $itype_sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
307 $itype_sth->execute( $item->{'biblionumber'} );
308 ( $item->{'itype'} ) = $itype_sth->fetchrow_array;
311 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
312 $item->{'itemnumber'} = $itemnumber;
314 ModZebra( $item->{biblionumber}, "specialUpdate", "biblioserver" );
316 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
318 return ($item->{biblionumber}, $item->{biblioitemnumber}, $itemnumber);
321 =head2 AddItemBatchFromMarc
323 ($itemnumber_ref, $error_ref) = AddItemBatchFromMarc($record,
324 $biblionumber, $biblioitemnumber, $frameworkcode);
326 Efficiently create item records from a MARC biblio record with
327 embedded item fields. This routine is suitable for batch jobs.
329 This API assumes that the bib record has already been
330 saved to the C<biblio> and C<biblioitems> tables. It does
331 not expect that C<biblioitems.marc> and C<biblioitems.marcxml>
332 are populated, but it will do so via a call to ModBibiloMarc.
334 The goal of this API is to have a similar effect to using AddBiblio
335 and AddItems in succession, but without inefficient repeated
336 parsing of the MARC XML bib record.
338 This function returns an arrayref of new itemsnumbers and an arrayref of item
339 errors encountered during the processing. Each entry in the errors
340 list is a hashref containing the following keys:
346 Sequence number of original item tag in the MARC record.
350 Item barcode, provide to assist in the construction of
351 useful error messages.
355 Code representing the error condition. Can be 'duplicate_barcode',
356 'invalid_homebranch', or 'invalid_holdingbranch'.
358 =item error_information
360 Additional information appropriate to the error condition.
366 sub AddItemBatchFromMarc {
367 my ($record, $biblionumber, $biblioitemnumber, $frameworkcode) = @_;
369 my @itemnumbers = ();
371 my $dbh = C4::Context->dbh;
373 # We modify the record, so lets work on a clone so we don't change the
375 $record = $record->clone();
376 # loop through the item tags and start creating items
377 my @bad_item_fields = ();
378 my ($itemtag, $itemsubfield) = &GetMarcFromKohaField("items.itemnumber",'');
379 my $item_sequence_num = 0;
380 ITEMFIELD: foreach my $item_field ($record->field($itemtag)) {
381 $item_sequence_num++;
382 # we take the item field and stick it into a new
383 # MARC record -- this is required so far because (FIXME)
384 # TransformMarcToKoha requires a MARC::Record, not a MARC::Field
385 # and there is no TransformMarcFieldToKoha
386 my $temp_item_marc = MARC::Record->new();
387 $temp_item_marc->append_fields($item_field);
389 # add biblionumber and biblioitemnumber
390 my $item = TransformMarcToKoha( $temp_item_marc, $frameworkcode, 'items' );
391 my $unlinked_item_subfields = _get_unlinked_item_subfields($temp_item_marc, $frameworkcode);
392 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
393 $item->{'biblionumber'} = $biblionumber;
394 $item->{'biblioitemnumber'} = $biblioitemnumber;
396 # check for duplicate barcode
397 my %item_errors = CheckItemPreSave($item);
399 push @errors, _repack_item_errors($item_sequence_num, $item, \%item_errors);
400 push @bad_item_fields, $item_field;
404 _set_defaults_for_add($item);
405 _set_derived_columns_for_add($item);
406 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
407 warn $error if $error;
408 push @itemnumbers, $itemnumber; # FIXME not checking error
409 $item->{'itemnumber'} = $itemnumber;
411 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
413 my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
414 $item_field->replace_with($new_item_marc->field($itemtag));
417 # remove any MARC item fields for rejected items
418 foreach my $item_field (@bad_item_fields) {
419 $record->delete_field($item_field);
422 # update the MARC biblio
423 # $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode );
425 return (\@itemnumbers, \@errors);
428 =head2 ModItemFromMarc
430 ModItemFromMarc($item_marc, $biblionumber, $itemnumber);
432 This function updates an item record based on a supplied
433 C<MARC::Record> object containing an embedded item field.
434 This API is meant for the use of C<additem.pl>; for
435 other purposes, C<ModItem> should be used.
437 This function uses the hash %default_values_for_mod_from_marc,
438 which contains default values for item fields to
439 apply when modifying an item. This is needed because
440 if an item field's value is cleared, TransformMarcToKoha
441 does not include the column in the
442 hash that's passed to ModItem, which without
443 use of this hash makes it impossible to clear
444 an item field's value. See bug 2466.
446 Note that only columns that can be directly
447 changed from the cataloging and serials
448 item editors are included in this hash.
454 sub _build_default_values_for_mod_marc {
455 my ($frameworkcode) = @_;
457 my $cache = Koha::Caches->get_instance();
458 my $cache_key = "default_value_for_mod_marc-$frameworkcode";
459 my $cached = $cache->get_from_cache($cache_key);
460 return $cached if $cached;
462 my $default_values = {
464 booksellerid => undef,
466 'items.cn_source' => undef,
467 coded_location_qualifier => undef,
471 holdingbranch => undef,
473 itemcallnumber => undef,
476 itemnotes_nonpublic => undef,
479 permanent_location => undef,
483 # paidfor => undef, # commented, see bug 12817
485 replacementprice => undef,
486 replacementpricedate => undef,
489 stocknumber => undef,
493 my %default_values_for_mod_from_marc;
494 while ( my ( $field, $default_value ) = each %$default_values ) {
495 my $kohafield = $field;
496 $kohafield =~ s|^([^\.]+)$|items.$1|;
497 $default_values_for_mod_from_marc{$field} =
499 if C4::Koha::IsKohaFieldLinked(
500 { kohafield => $kohafield, frameworkcode => $frameworkcode } );
503 $cache->set_in_cache($cache_key, \%default_values_for_mod_from_marc);
504 return \%default_values_for_mod_from_marc;
507 sub ModItemFromMarc {
508 my $item_marc = shift;
509 my $biblionumber = shift;
510 my $itemnumber = shift;
512 my $dbh = C4::Context->dbh;
513 my $frameworkcode = GetFrameworkCode($biblionumber);
514 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
516 my $localitemmarc = MARC::Record->new;
517 $localitemmarc->append_fields( $item_marc->field($itemtag) );
518 my $item = &TransformMarcToKoha( $localitemmarc, $frameworkcode, 'items' );
519 my $default_values = _build_default_values_for_mod_marc($frameworkcode);
520 foreach my $item_field ( keys %$default_values ) {
521 $item->{$item_field} = $default_values->{$item_field}
522 unless exists $item->{$item_field};
524 my $unlinked_item_subfields = _get_unlinked_item_subfields( $localitemmarc, $frameworkcode );
526 ModItem($item, $biblionumber, $itemnumber, $dbh, $frameworkcode, $unlinked_item_subfields);
532 ModItem({ column => $newvalue }, $biblionumber, $itemnumber);
534 Change one or more columns in an item record and update
535 the MARC representation of the item.
537 The first argument is a hashref mapping from item column
538 names to the new values. The second and third arguments
539 are the biblionumber and itemnumber, respectively.
541 The fourth, optional parameter, C<$unlinked_item_subfields>, contains
542 an arrayref containing subfields present in the original MARC
543 representation of the item (e.g., from the item editor) that are
544 not mapped to C<items> columns directly but should instead
545 be stored in C<items.more_subfields_xml> and included in
546 the biblio items tag for display and indexing.
548 If one of the changed columns is used to calculate
549 the derived value of a column such as C<items.cn_sort>,
550 this routine will perform the necessary calculation
557 my $biblionumber = shift;
558 my $itemnumber = shift;
560 # if $biblionumber is undefined, get it from the current item
561 unless (defined $biblionumber) {
562 $biblionumber = _get_single_item_column('biblionumber', $itemnumber);
565 my $dbh = @_ ? shift : C4::Context->dbh;
566 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
568 my $unlinked_item_subfields;
570 $unlinked_item_subfields = shift;
571 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
574 $item->{'itemnumber'} = $itemnumber or return;
576 my @fields = qw( itemlost withdrawn );
578 # Only call GetItem if we need to set an "on" date field
579 if ( $item->{itemlost} || $item->{withdrawn} ) {
580 my $pre_mod_item = GetItem( $item->{'itemnumber'} );
581 for my $field (@fields) {
582 if ( defined( $item->{$field} )
583 and not $pre_mod_item->{$field}
584 and $item->{$field} )
586 $item->{ $field . '_on' } =
587 DateTime::Format::MySQL->format_datetime( dt_from_string() );
592 # If the field is defined but empty, we are removing and,
593 # and thus need to clear out the 'on' field as well
594 for my $field (@fields) {
595 if ( defined( $item->{$field} ) && !$item->{$field} ) {
596 $item->{ $field . '_on' } = undef;
601 _set_derived_columns_for_mod($item);
602 _do_column_fixes_for_mod($item);
605 # attempt to change itemnumber
606 # attempt to change biblionumber (if we want
607 # an API to relink an item to a different bib,
608 # it should be a separate function)
611 _koha_modify_item($item);
613 # request that bib be reindexed so that searching on current
614 # item status is possible
615 ModZebra( $biblionumber, "specialUpdate", "biblioserver" );
617 logaction("CATALOGUING", "MODIFY", $itemnumber, "item ".Dumper($item)) if C4::Context->preference("CataloguingLog");
620 =head2 ModItemTransfer
622 ModItemTransfer($itenumber, $frombranch, $tobranch);
624 Marks an item as being transferred from one branch
629 sub ModItemTransfer {
630 my ( $itemnumber, $frombranch, $tobranch ) = @_;
632 my $dbh = C4::Context->dbh;
634 # Remove the 'shelving cart' location status if it is being used.
635 CartToShelf( $itemnumber ) if ( C4::Context->preference("ReturnToShelvingCart") );
637 #new entry in branchtransfers....
638 my $sth = $dbh->prepare(
639 "INSERT INTO branchtransfers (itemnumber, frombranch, datesent, tobranch)
640 VALUES (?, ?, NOW(), ?)");
641 $sth->execute($itemnumber, $frombranch, $tobranch);
643 ModItem({ holdingbranch => $tobranch }, undef, $itemnumber);
644 ModDateLastSeen($itemnumber);
648 =head2 ModDateLastSeen
650 ModDateLastSeen($itemnum);
652 Mark item as seen. Is called when an item is issued, returned or manually marked during inventory/stocktaking.
653 C<$itemnum> is the item number
657 sub ModDateLastSeen {
658 my ($itemnumber) = @_;
660 my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
661 ModItem({ itemlost => 0, datelastseen => $today }, undef, $itemnumber);
666 DelItem({ itemnumber => $itemnumber, [ biblionumber => $biblionumber ] } );
668 Exported function (core API) for deleting an item record in Koha.
675 my $itemnumber = $params->{itemnumber};
676 my $biblionumber = $params->{biblionumber};
678 unless ($biblionumber) {
679 $biblionumber = C4::Biblio::GetBiblionumberFromItemnumber($itemnumber);
682 # If there is no biblionumber for the given itemnumber, there is nothing to delete
683 return 0 unless $biblionumber;
685 # FIXME check the item has no current issues
686 my $deleted = _koha_delete_item( $itemnumber );
688 # get the MARC record
689 my $record = GetMarcBiblio($biblionumber);
690 ModZebra( $biblionumber, "specialUpdate", "biblioserver" );
692 #search item field code
693 logaction("CATALOGUING", "DELETE", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
697 =head2 CheckItemPreSave
699 my $item_ref = TransformMarcToKoha($marc, 'items');
701 my %errors = CheckItemPreSave($item_ref);
702 if (exists $errors{'duplicate_barcode'}) {
703 print "item has duplicate barcode: ", $errors{'duplicate_barcode'}, "\n";
704 } elsif (exists $errors{'invalid_homebranch'}) {
705 print "item has invalid home branch: ", $errors{'invalid_homebranch'}, "\n";
706 } elsif (exists $errors{'invalid_holdingbranch'}) {
707 print "item has invalid holding branch: ", $errors{'invalid_holdingbranch'}, "\n";
712 Given a hashref containing item fields, determine if it can be
713 inserted or updated in the database. Specifically, checks for
714 database integrity issues, and returns a hash containing any
715 of the following keys, if applicable.
719 =item duplicate_barcode
721 Barcode, if it duplicates one already found in the database.
723 =item invalid_homebranch
725 Home branch, if not defined in branches table.
727 =item invalid_holdingbranch
729 Holding branch, if not defined in branches table.
733 This function does NOT implement any policy-related checks,
734 e.g., whether current operator is allowed to save an
735 item that has a given branch code.
739 sub CheckItemPreSave {
740 my $item_ref = shift;
745 # check for duplicate barcode
746 if (exists $item_ref->{'barcode'} and defined $item_ref->{'barcode'}) {
747 my $existing_itemnumber = GetItemnumberFromBarcode($item_ref->{'barcode'});
748 if ($existing_itemnumber) {
749 if (!exists $item_ref->{'itemnumber'} # new item
750 or $item_ref->{'itemnumber'} != $existing_itemnumber) { # existing item
751 $errors{'duplicate_barcode'} = $item_ref->{'barcode'};
756 # check for valid home branch
757 if (exists $item_ref->{'homebranch'} and defined $item_ref->{'homebranch'}) {
758 my $branch_name = C4::Branch::GetBranchName($item_ref->{'homebranch'});
759 unless (defined $branch_name) {
760 # relies on fact that branches.branchname is a non-NULL column,
761 # so GetBranchName returns undef only if branch does not exist
762 $errors{'invalid_homebranch'} = $item_ref->{'homebranch'};
766 # check for valid holding branch
767 if (exists $item_ref->{'holdingbranch'} and defined $item_ref->{'holdingbranch'}) {
768 my $branch_name = C4::Branch::GetBranchName($item_ref->{'holdingbranch'});
769 unless (defined $branch_name) {
770 # relies on fact that branches.branchname is a non-NULL column,
771 # so GetBranchName returns undef only if branch does not exist
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,
1344 holding.opac_info as holding_branch_opac_info,
1345 home.opac_info as home_branch_opac_info
1349 LEFT JOIN branches AS holding ON items.holdingbranch = holding.branchcode
1350 LEFT JOIN branches AS home ON items.homebranch=home.branchcode
1351 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1352 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1353 LEFT JOIN issues USING (itemnumber)
1354 LEFT JOIN borrowers USING (borrowernumber)
1355 LEFT JOIN serialitems USING (itemnumber)
1356 LEFT JOIN serial USING (serialid)
1357 LEFT JOIN itemtypes ON itemtypes.itemtype = "
1358 . (C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype');
1360 LEFT JOIN localization ON itemtypes.itemtype = localization.code
1361 AND localization.entity = 'itemtypes'
1362 AND localization.lang = ?
1365 $query .= " WHERE items.biblionumber = ? ORDER BY home.branchname, items.enumchron, LPAD( items.copynumber, 8, '0' ), items.dateaccessioned DESC" ;
1366 my $sth = $dbh->prepare($query);
1367 $sth->execute($language, $biblionumber);
1372 my $userenv = C4::Context->userenv;
1373 my $want_not_same_branch = C4::Context->preference("IndependentBranches") && !C4::Context->IsSuperLibrarian();
1374 while ( my $data = $sth->fetchrow_hashref ) {
1375 if ( $data->{borrowernumber} && $want_not_same_branch) {
1376 $data->{'NOTSAMEBRANCH'} = $data->{'bcode'} ne $userenv->{branch};
1379 $serial ||= $data->{'serial'};
1381 # get notforloan complete status if applicable
1382 if ( my $code = C4::Koha::GetAuthValCode( 'items.notforloan', $data->{frameworkcode} ) ) {
1383 $data->{notforloanvalue} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{itemnotforloan} );
1384 $data->{notforloanvalueopac} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{itemnotforloan}, 1 );
1387 # get restricted status and description if applicable
1388 if ( my $code = C4::Koha::GetAuthValCode( 'items.restricted', $data->{frameworkcode} ) ) {
1389 $data->{restrictedopac} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{restricted}, 1 );
1390 $data->{restricted} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{restricted} );
1393 # my stack procedures
1394 if ( my $code = C4::Koha::GetAuthValCode( 'items.stack', $data->{frameworkcode} ) ) {
1395 $data->{stack} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{stack} );
1398 # Find the last 3 people who borrowed this item.
1399 my $sth2 = $dbh->prepare("SELECT * FROM old_issues,borrowers
1400 WHERE itemnumber = ?
1401 AND old_issues.borrowernumber = borrowers.borrowernumber
1402 ORDER BY returndate DESC
1404 $sth2->execute($data->{'itemnumber'});
1406 while (my $data2 = $sth2->fetchrow_hashref()) {
1407 $data->{"timestamp$ii"} = $data2->{'timestamp'} if $data2->{'timestamp'};
1408 $data->{"card$ii"} = $data2->{'cardnumber'} if $data2->{'cardnumber'};
1409 $data->{"borrower$ii"} = $data2->{'borrowernumber'} if $data2->{'borrowernumber'};
1413 $results[$i] = $data;
1418 ? sort { ($b->{'publisheddate'} || $b->{'enumchron'}) cmp ($a->{'publisheddate'} || $a->{'enumchron'}) } @results
1422 =head2 GetItemsLocationInfo
1424 my @itemlocinfo = GetItemsLocationInfo($biblionumber);
1426 Returns the branch names, shelving location and itemcallnumber for each item attached to the biblio in question
1428 C<GetItemsInfo> returns a list of references-to-hash. Data returned:
1432 =item C<$data-E<gt>{homebranch}>
1434 Branch Name of the item's homebranch
1436 =item C<$data-E<gt>{holdingbranch}>
1438 Branch Name of the item's holdingbranch
1440 =item C<$data-E<gt>{location}>
1442 Item's shelving location code
1444 =item C<$data-E<gt>{location_intranet}>
1446 The intranet description for the Shelving Location as set in authorised_values 'LOC'
1448 =item C<$data-E<gt>{location_opac}>
1450 The OPAC description for the Shelving Location as set in authorised_values 'LOC'. Falls back to intranet description if no OPAC
1453 =item C<$data-E<gt>{itemcallnumber}>
1455 Item's itemcallnumber
1457 =item C<$data-E<gt>{cn_sort}>
1459 Item's call number normalized for sorting
1465 sub GetItemsLocationInfo {
1466 my $biblionumber = shift;
1469 my $dbh = C4::Context->dbh;
1470 my $query = "SELECT a.branchname as homebranch, b.branchname as holdingbranch,
1471 location, itemcallnumber, cn_sort
1472 FROM items, branches as a, branches as b
1473 WHERE homebranch = a.branchcode AND holdingbranch = b.branchcode
1474 AND biblionumber = ?
1475 ORDER BY cn_sort ASC";
1476 my $sth = $dbh->prepare($query);
1477 $sth->execute($biblionumber);
1479 while ( my $data = $sth->fetchrow_hashref ) {
1480 $data->{location_intranet} = GetKohaAuthorisedValueLib('LOC', $data->{location});
1481 $data->{location_opac}= GetKohaAuthorisedValueLib('LOC', $data->{location}, 1);
1482 push @results, $data;
1487 =head2 GetHostItemsInfo
1489 $hostiteminfo = GetHostItemsInfo($hostfield);
1490 Returns the iteminfo for items linked to records via a host field
1494 sub GetHostItemsInfo {
1496 my @returnitemsInfo;
1498 if (C4::Context->preference('marcflavour') eq 'MARC21' ||
1499 C4::Context->preference('marcflavour') eq 'NORMARC'){
1500 foreach my $hostfield ( $record->field('773') ) {
1501 my $hostbiblionumber = $hostfield->subfield("0");
1502 my $linkeditemnumber = $hostfield->subfield("9");
1503 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1504 foreach my $hostitemInfo (@hostitemInfos){
1505 if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1506 push (@returnitemsInfo,$hostitemInfo);
1511 } elsif ( C4::Context->preference('marcflavour') eq 'UNIMARC'){
1512 foreach my $hostfield ( $record->field('461') ) {
1513 my $hostbiblionumber = $hostfield->subfield("0");
1514 my $linkeditemnumber = $hostfield->subfield("9");
1515 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1516 foreach my $hostitemInfo (@hostitemInfos){
1517 if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1518 push (@returnitemsInfo,$hostitemInfo);
1524 return @returnitemsInfo;
1528 =head2 GetLastAcquisitions
1530 my $lastacq = GetLastAcquisitions({'branches' => ('branch1','branch2'),
1531 'itemtypes' => ('BK','BD')}, 10);
1535 sub GetLastAcquisitions {
1536 my ($data,$max) = @_;
1538 my $itemtype = C4::Context->preference('item-level_itypes') ? 'itype' : 'itemtype';
1540 my $number_of_branches = @{$data->{branches}};
1541 my $number_of_itemtypes = @{$data->{itemtypes}};
1544 my @where = ('WHERE 1 ');
1545 $number_of_branches and push @where
1546 , 'AND holdingbranch IN ('
1547 , join(',', ('?') x $number_of_branches )
1551 $number_of_itemtypes and push @where
1552 , "AND $itemtype IN ("
1553 , join(',', ('?') x $number_of_itemtypes )
1557 my $query = "SELECT biblio.biblionumber as biblionumber, title, dateaccessioned
1558 FROM items RIGHT JOIN biblio ON (items.biblionumber=biblio.biblionumber)
1559 RIGHT JOIN biblioitems ON (items.biblioitemnumber=biblioitems.biblioitemnumber)
1561 GROUP BY biblio.biblionumber
1562 ORDER BY dateaccessioned DESC LIMIT $max";
1564 my $dbh = C4::Context->dbh;
1565 my $sth = $dbh->prepare($query);
1567 $sth->execute((@{$data->{branches}}, @{$data->{itemtypes}}));
1570 while( my $row = $sth->fetchrow_hashref){
1571 push @results, {date => $row->{dateaccessioned}
1572 , biblionumber => $row->{biblionumber}
1573 , title => $row->{title}};
1579 =head2 GetItemnumbersForBiblio
1581 my $itemnumbers = GetItemnumbersForBiblio($biblionumber);
1583 Given a single biblionumber, return an arrayref of all the corresponding itemnumbers
1587 sub GetItemnumbersForBiblio {
1588 my $biblionumber = shift;
1590 my $dbh = C4::Context->dbh;
1591 my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber = ?");
1592 $sth->execute($biblionumber);
1593 while (my $result = $sth->fetchrow_hashref) {
1594 push @items, $result->{'itemnumber'};
1599 =head2 get_itemnumbers_of
1601 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1603 Given a list of biblionumbers, return the list of corresponding itemnumbers
1604 for each biblionumber.
1606 Return a reference on a hash where keys are biblionumbers and values are
1607 references on array of itemnumbers.
1611 sub get_itemnumbers_of {
1612 my @biblionumbers = @_;
1614 my $dbh = C4::Context->dbh;
1620 WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1622 my $sth = $dbh->prepare($query);
1623 $sth->execute(@biblionumbers);
1627 while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1628 push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1631 return \%itemnumbers_of;
1634 =head2 get_hostitemnumbers_of
1636 my @itemnumbers_of = get_hostitemnumbers_of($biblionumber);
1638 Given a biblionumber, return the list of corresponding itemnumbers that are linked to it via host fields
1640 Return a reference on a hash where key is a biblionumber and values are
1641 references on array of itemnumbers.
1646 sub get_hostitemnumbers_of {
1647 my ($biblionumber) = @_;
1648 my $marcrecord = GetMarcBiblio($biblionumber);
1650 return unless $marcrecord;
1652 my ( @returnhostitemnumbers, $tag, $biblio_s, $item_s );
1654 my $marcflavor = C4::Context->preference('marcflavour');
1655 if ( $marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC' ) {
1660 elsif ( $marcflavor eq 'UNIMARC' ) {
1666 foreach my $hostfield ( $marcrecord->field($tag) ) {
1667 my $hostbiblionumber = $hostfield->subfield($biblio_s);
1668 my $linkeditemnumber = $hostfield->subfield($item_s);
1670 if ( my $itemnumbers =
1671 get_itemnumbers_of($hostbiblionumber)->{$hostbiblionumber} )
1673 @itemnumbers = @$itemnumbers;
1675 foreach my $itemnumber (@itemnumbers) {
1676 if ( $itemnumber eq $linkeditemnumber ) {
1677 push( @returnhostitemnumbers, $itemnumber );
1683 return @returnhostitemnumbers;
1687 =head2 GetItemnumberFromBarcode
1689 $result = GetItemnumberFromBarcode($barcode);
1693 sub GetItemnumberFromBarcode {
1695 my $dbh = C4::Context->dbh;
1698 $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1699 $rq->execute($barcode);
1700 my ($result) = $rq->fetchrow;
1704 =head2 GetBarcodeFromItemnumber
1706 $result = GetBarcodeFromItemnumber($itemnumber);
1710 sub GetBarcodeFromItemnumber {
1711 my ($itemnumber) = @_;
1712 my $dbh = C4::Context->dbh;
1715 $dbh->prepare("SELECT barcode FROM items WHERE items.itemnumber=?");
1716 $rq->execute($itemnumber);
1717 my ($result) = $rq->fetchrow;
1721 =head2 GetHiddenItemnumbers
1723 my @itemnumbers_to_hide = GetHiddenItemnumbers(@items);
1725 Given a list of items it checks which should be hidden from the OPAC given
1726 the current configuration. Returns a list of itemnumbers corresponding to
1727 those that should be hidden.
1731 sub GetHiddenItemnumbers {
1735 my $yaml = C4::Context->preference('OpacHiddenItems');
1736 return () if (! $yaml =~ /\S/ );
1737 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1740 $hidingrules = YAML::Load($yaml);
1743 warn "Unable to parse OpacHiddenItems syspref : $@";
1746 my $dbh = C4::Context->dbh;
1749 foreach my $item (@items) {
1751 # We check each rule
1752 foreach my $field (keys %$hidingrules) {
1754 if (exists $item->{$field}) {
1755 $val = $item->{$field};
1758 my $query = "SELECT $field from items where itemnumber = ?";
1759 $val = $dbh->selectrow_array($query, undef, $item->{'itemnumber'});
1761 $val = '' unless defined $val;
1763 # If the results matches the values in the yaml file
1764 if (any { $val eq $_ } @{$hidingrules->{$field}}) {
1766 # We add the itemnumber to the list
1767 push @resultitems, $item->{'itemnumber'};
1769 # If at least one rule matched for an item, no need to test the others
1774 return @resultitems;
1777 =head1 LIMITED USE FUNCTIONS
1779 The following functions, while part of the public API,
1780 are not exported. This is generally because they are
1781 meant to be used by only one script for a specific
1782 purpose, and should not be used in any other context
1783 without careful thought.
1789 my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1791 Returns MARC::Record of the item passed in parameter.
1792 This function is meant for use only in C<cataloguing/additem.pl>,
1793 where it is needed to support that script's MARC-like
1799 my ( $biblionumber, $itemnumber ) = @_;
1801 # GetMarcItem has been revised so that it does the following:
1802 # 1. Gets the item information from the items table.
1803 # 2. Converts it to a MARC field for storage in the bib record.
1805 # The previous behavior was:
1806 # 1. Get the bib record.
1807 # 2. Return the MARC tag corresponding to the item record.
1809 # The difference is that one treats the items row as authoritative,
1810 # while the other treats the MARC representation as authoritative
1811 # under certain circumstances.
1813 my $itemrecord = GetItem($itemnumber);
1815 # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1816 # Also, don't emit a subfield if the underlying field is blank.
1819 return Item2Marc($itemrecord,$biblionumber);
1823 my ($itemrecord,$biblionumber)=@_;
1826 defined($itemrecord->{$_}) && $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : ()
1827 } keys %{ $itemrecord }
1829 my $itemmarc = TransformKohaToMarc($mungeditem);
1830 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",GetFrameworkCode($biblionumber)||'');
1832 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1833 if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1834 foreach my $field ($itemmarc->field($itemtag)){
1835 $field->add_subfields(@$unlinked_item_subfields);
1841 =head1 PRIVATE FUNCTIONS AND VARIABLES
1843 The following functions are not meant to be called
1844 directly, but are documented in order to explain
1845 the inner workings of C<C4::Items>.
1849 =head2 %derived_columns
1851 This hash keeps track of item columns that
1852 are strictly derived from other columns in
1853 the item record and are not meant to be set
1856 Each key in the hash should be the name of a
1857 column (as named by TransformMarcToKoha). Each
1858 value should be hashref whose keys are the
1859 columns on which the derived column depends. The
1860 hashref should also contain a 'BUILDER' key
1861 that is a reference to a sub that calculates
1866 my %derived_columns = (
1867 'items.cn_sort' => {
1868 'itemcallnumber' => 1,
1869 'items.cn_source' => 1,
1870 'BUILDER' => \&_calc_items_cn_sort,
1874 =head2 _set_derived_columns_for_add
1876 _set_derived_column_for_add($item);
1878 Given an item hash representing a new item to be added,
1879 calculate any derived columns. Currently the only
1880 such column is C<items.cn_sort>.
1884 sub _set_derived_columns_for_add {
1887 foreach my $column (keys %derived_columns) {
1888 my $builder = $derived_columns{$column}->{'BUILDER'};
1889 my $source_values = {};
1890 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1891 next if $source_column eq 'BUILDER';
1892 $source_values->{$source_column} = $item->{$source_column};
1894 $builder->($item, $source_values);
1898 =head2 _set_derived_columns_for_mod
1900 _set_derived_column_for_mod($item);
1902 Given an item hash representing a new item to be modified.
1903 calculate any derived columns. Currently the only
1904 such column is C<items.cn_sort>.
1906 This routine differs from C<_set_derived_columns_for_add>
1907 in that it needs to handle partial item records. In other
1908 words, the caller of C<ModItem> may have supplied only one
1909 or two columns to be changed, so this function needs to
1910 determine whether any of the columns to be changed affect
1911 any of the derived columns. Also, if a derived column
1912 depends on more than one column, but the caller is not
1913 changing all of then, this routine retrieves the unchanged
1914 values from the database in order to ensure a correct
1919 sub _set_derived_columns_for_mod {
1922 foreach my $column (keys %derived_columns) {
1923 my $builder = $derived_columns{$column}->{'BUILDER'};
1924 my $source_values = {};
1925 my %missing_sources = ();
1926 my $must_recalc = 0;
1927 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1928 next if $source_column eq 'BUILDER';
1929 if (exists $item->{$source_column}) {
1931 $source_values->{$source_column} = $item->{$source_column};
1933 $missing_sources{$source_column} = 1;
1937 foreach my $source_column (keys %missing_sources) {
1938 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
1940 $builder->($item, $source_values);
1945 =head2 _do_column_fixes_for_mod
1947 _do_column_fixes_for_mod($item);
1949 Given an item hashref containing one or more
1950 columns to modify, fix up certain values.
1951 Specifically, set to 0 any passed value
1952 of C<notforloan>, C<damaged>, C<itemlost>, or
1953 C<withdrawn> that is either undefined or
1954 contains the empty string.
1958 sub _do_column_fixes_for_mod {
1961 if (exists $item->{'notforloan'} and
1962 (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
1963 $item->{'notforloan'} = 0;
1965 if (exists $item->{'damaged'} and
1966 (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
1967 $item->{'damaged'} = 0;
1969 if (exists $item->{'itemlost'} and
1970 (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
1971 $item->{'itemlost'} = 0;
1973 if (exists $item->{'withdrawn'} and
1974 (not defined $item->{'withdrawn'} or $item->{'withdrawn'} eq '')) {
1975 $item->{'withdrawn'} = 0;
1977 if (exists $item->{location}
1978 and $item->{location} ne 'CART'
1979 and $item->{location} ne 'PROC'
1980 and not $item->{permanent_location}
1982 $item->{'permanent_location'} = $item->{'location'};
1984 if (exists $item->{'timestamp'}) {
1985 delete $item->{'timestamp'};
1989 =head2 _get_single_item_column
1991 _get_single_item_column($column, $itemnumber);
1993 Retrieves the value of a single column from an C<items>
1994 row specified by C<$itemnumber>.
1998 sub _get_single_item_column {
2000 my $itemnumber = shift;
2002 my $dbh = C4::Context->dbh;
2003 my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
2004 $sth->execute($itemnumber);
2005 my ($value) = $sth->fetchrow();
2009 =head2 _calc_items_cn_sort
2011 _calc_items_cn_sort($item, $source_values);
2013 Helper routine to calculate C<items.cn_sort>.
2017 sub _calc_items_cn_sort {
2019 my $source_values = shift;
2021 $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
2024 =head2 _set_defaults_for_add
2026 _set_defaults_for_add($item_hash);
2028 Given an item hash representing an item to be added, set
2029 correct default values for columns whose default value
2030 is not handled by the DBMS. This includes the following
2037 C<items.dateaccessioned>
2059 sub _set_defaults_for_add {
2061 $item->{dateaccessioned} ||= output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
2062 $item->{$_} ||= 0 for (qw( notforloan damaged itemlost withdrawn));
2065 =head2 _koha_new_item
2067 my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
2069 Perform the actual insert into the C<items> table.
2073 sub _koha_new_item {
2074 my ( $item, $barcode ) = @_;
2075 my $dbh=C4::Context->dbh;
2077 $item->{permanent_location} //= $item->{location};
2079 "INSERT INTO items SET
2081 biblioitemnumber = ?,
2083 dateaccessioned = ?,
2087 replacementprice = ?,
2088 replacementpricedate = ?,
2089 datelastborrowed = ?,
2097 coded_location_qualifier = ?,
2100 itemnotes_nonpublic = ?,
2104 permanent_location = ?,
2116 more_subfields_xml = ?,
2121 my $sth = $dbh->prepare($query);
2122 my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
2124 $item->{'biblionumber'},
2125 $item->{'biblioitemnumber'},
2127 $item->{'dateaccessioned'},
2128 $item->{'booksellerid'},
2129 $item->{'homebranch'},
2131 $item->{'replacementprice'},
2132 $item->{'replacementpricedate'} || $today,
2133 $item->{datelastborrowed},
2134 $item->{datelastseen} || $today,
2136 $item->{'notforloan'},
2138 $item->{'itemlost'},
2139 $item->{'withdrawn'},
2140 $item->{'itemcallnumber'},
2141 $item->{'coded_location_qualifier'},
2142 $item->{'restricted'},
2143 $item->{'itemnotes'},
2144 $item->{'itemnotes_nonpublic'},
2145 $item->{'holdingbranch'},
2147 $item->{'location'},
2148 $item->{'permanent_location'},
2151 $item->{'renewals'},
2152 $item->{'reserves'},
2153 $item->{'items.cn_source'},
2154 $item->{'items.cn_sort'},
2157 $item->{'materials'},
2159 $item->{'enumchron'},
2160 $item->{'more_subfields_xml'},
2161 $item->{'copynumber'},
2162 $item->{'stocknumber'},
2163 $item->{'new_status'},
2167 if ( defined $sth->errstr ) {
2168 $error.="ERROR in _koha_new_item $query".$sth->errstr;
2171 $itemnumber = $dbh->{'mysql_insertid'};
2174 return ( $itemnumber, $error );
2177 =head2 MoveItemFromBiblio
2179 MoveItemFromBiblio($itenumber, $frombiblio, $tobiblio);
2181 Moves an item from a biblio to another
2183 Returns undef if the move failed or the biblionumber of the destination record otherwise
2187 sub MoveItemFromBiblio {
2188 my ($itemnumber, $frombiblio, $tobiblio) = @_;
2189 my $dbh = C4::Context->dbh;
2190 my ( $tobiblioitem ) = $dbh->selectrow_array(q|
2191 SELECT biblioitemnumber
2193 WHERE biblionumber = ?
2194 |, undef, $tobiblio );
2195 my $return = $dbh->do(q|
2197 SET biblioitemnumber = ?,
2199 WHERE itemnumber = ?
2200 AND biblionumber = ?
2201 |, undef, $tobiblioitem, $tobiblio, $itemnumber, $frombiblio );
2203 ModZebra( $tobiblio, "specialUpdate", "biblioserver" );
2204 ModZebra( $frombiblio, "specialUpdate", "biblioserver" );
2205 # Checking if the item we want to move is in an order
2206 require C4::Acquisition;
2207 my $order = C4::Acquisition::GetOrderFromItemnumber($itemnumber);
2209 # Replacing the biblionumber within the order if necessary
2210 $order->{'biblionumber'} = $tobiblio;
2211 C4::Acquisition::ModOrder($order);
2214 # Update reserves, hold_fill_targets, tmp_holdsqueue and linktracker tables
2215 for my $table_name ( qw( reserves hold_fill_targets tmp_holdsqueue linktracker ) ) {
2218 SET biblionumber = ?
2219 WHERE itemnumber = ?
2220 |, undef, $tobiblio, $itemnumber );
2227 =head2 ItemSafeToDelete
2229 ItemSafeToDelete( $biblionumber, $itemnumber);
2231 Exported function (core API) for checking whether an item record is safe to delete.
2233 returns 1 if the item is safe to delete,
2235 "book_on_loan" if the item is checked out,
2237 "not_same_branch" if the item is blocked by independent branches,
2239 "book_reserved" if the there are holds aganst the item, or
2241 "linked_analytics" if the item has linked analytic records.
2245 sub ItemSafeToDelete {
2246 my ( $biblionumber, $itemnumber ) = @_;
2248 my $dbh = C4::Context->dbh;
2252 my $countanalytics = GetAnalyticsCount($itemnumber);
2254 # check that there is no issue on this item before deletion.
2255 my $sth = $dbh->prepare(
2257 SELECT COUNT(*) FROM issues
2258 WHERE itemnumber = ?
2261 $sth->execute($itemnumber);
2262 my ($onloan) = $sth->fetchrow;
2264 my $item = GetItem($itemnumber);
2267 $status = "book_on_loan";
2269 elsif ( defined C4::Context->userenv
2270 and !C4::Context->IsSuperLibrarian()
2271 and C4::Context->preference("IndependentBranches")
2272 and ( C4::Context->userenv->{branch} ne $item->{'homebranch'} ) )
2274 $status = "not_same_branch";
2277 # check it doesn't have a waiting reserve
2278 $sth = $dbh->prepare(
2280 SELECT COUNT(*) FROM reserves
2281 WHERE (found = 'W' OR found = 'T')
2285 $sth->execute($itemnumber);
2286 my ($reserve) = $sth->fetchrow;
2288 $status = "book_reserved";
2290 elsif ( $countanalytics > 0 ) {
2291 $status = "linked_analytics";
2302 DelItemCheck( $biblionumber, $itemnumber);
2304 Exported function (core API) for deleting an item record in Koha if there no current issue.
2306 DelItemCheck wraps ItemSafeToDelete around DelItem.
2311 my ( $biblionumber, $itemnumber ) = @_;
2312 my $status = ItemSafeToDelete( $biblionumber, $itemnumber );
2314 if ( $status == 1 ) {
2317 biblionumber => $biblionumber,
2318 itemnumber => $itemnumber
2325 =head2 _koha_modify_item
2327 my ($itemnumber,$error) =_koha_modify_item( $item );
2329 Perform the actual update of the C<items> row. Note that this
2330 routine accepts a hashref specifying the columns to update.
2334 sub _koha_modify_item {
2336 my $dbh=C4::Context->dbh;
2339 my $query = "UPDATE items SET ";
2341 for my $key ( keys %$item ) {
2342 next if ( $key eq 'itemnumber' );
2344 push @bind, $item->{$key};
2347 $query .= " WHERE itemnumber=?";
2348 push @bind, $item->{'itemnumber'};
2349 my $sth = $dbh->prepare($query);
2350 $sth->execute(@bind);
2352 $error.="ERROR in _koha_modify_item $query: ".$sth->errstr;
2355 return ($item->{'itemnumber'},$error);
2358 =head2 _koha_delete_item
2360 _koha_delete_item( $itemnum );
2362 Internal function to delete an item record from the koha tables
2366 sub _koha_delete_item {
2367 my ( $itemnum ) = @_;
2369 my $dbh = C4::Context->dbh;
2370 # save the deleted item to deleteditems table
2371 my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
2372 $sth->execute($itemnum);
2373 my $data = $sth->fetchrow_hashref();
2375 # There is no item to delete
2376 return 0 unless $data;
2378 my $query = "INSERT INTO deleteditems SET ";
2380 foreach my $key ( keys %$data ) {
2381 next if ( $key eq 'timestamp' ); # timestamp will be set by db
2382 $query .= "$key = ?,";
2383 push( @bind, $data->{$key} );
2386 $sth = $dbh->prepare($query);
2387 $sth->execute(@bind);
2389 # delete from items table
2390 $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
2391 my $deleted = $sth->execute($itemnum);
2392 return ( $deleted == 1 ) ? 1 : 0;
2395 =head2 _marc_from_item_hash
2397 my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
2399 Given an item hash representing a complete item record,
2400 create a C<MARC::Record> object containing an embedded
2401 tag representing that item.
2403 The third, optional parameter C<$unlinked_item_subfields> is
2404 an arrayref of subfields (not mapped to C<items> fields per the
2405 framework) to be added to the MARC representation
2410 sub _marc_from_item_hash {
2412 my $frameworkcode = shift;
2413 my $unlinked_item_subfields;
2415 $unlinked_item_subfields = shift;
2418 # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
2419 # Also, don't emit a subfield if the underlying field is blank.
2420 my $mungeditem = { map { (defined($item->{$_}) and $item->{$_} ne '') ?
2421 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
2422 : () } keys %{ $item } };
2424 my $item_marc = MARC::Record->new();
2425 foreach my $item_field ( keys %{$mungeditem} ) {
2426 my ( $tag, $subfield ) = GetMarcFromKohaField( $item_field, $frameworkcode );
2427 next unless defined $tag and defined $subfield; # skip if not mapped to MARC field
2428 my @values = split(/\s?\|\s?/, $mungeditem->{$item_field}, -1);
2429 foreach my $value (@values){
2430 if ( my $field = $item_marc->field($tag) ) {
2431 $field->add_subfields( $subfield => $value );
2433 my $add_subfields = [];
2434 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2435 $add_subfields = $unlinked_item_subfields;
2437 $item_marc->add_fields( $tag, " ", " ", $subfield => $value, @$add_subfields );
2445 =head2 _repack_item_errors
2447 Add an error message hash generated by C<CheckItemPreSave>
2448 to a list of errors.
2452 sub _repack_item_errors {
2453 my $item_sequence_num = shift;
2454 my $item_ref = shift;
2455 my $error_ref = shift;
2457 my @repacked_errors = ();
2459 foreach my $error_code (sort keys %{ $error_ref }) {
2460 my $repacked_error = {};
2461 $repacked_error->{'item_sequence'} = $item_sequence_num;
2462 $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
2463 $repacked_error->{'error_code'} = $error_code;
2464 $repacked_error->{'error_information'} = $error_ref->{$error_code};
2465 push @repacked_errors, $repacked_error;
2468 return @repacked_errors;
2471 =head2 _get_unlinked_item_subfields
2473 my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
2477 sub _get_unlinked_item_subfields {
2478 my $original_item_marc = shift;
2479 my $frameworkcode = shift;
2481 my $marcstructure = GetMarcStructure(1, $frameworkcode);
2483 # assume that this record has only one field, and that that
2484 # field contains only the item information
2486 my @fields = $original_item_marc->fields();
2487 if ($#fields > -1) {
2488 my $field = $fields[0];
2489 my $tag = $field->tag();
2490 foreach my $subfield ($field->subfields()) {
2491 if (defined $subfield->[1] and
2492 $subfield->[1] ne '' and
2493 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
2494 push @$subfields, $subfield->[0] => $subfield->[1];
2501 =head2 _get_unlinked_subfields_xml
2503 my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
2507 sub _get_unlinked_subfields_xml {
2508 my $unlinked_item_subfields = shift;
2511 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2512 my $marc = MARC::Record->new();
2513 # use of tag 999 is arbitrary, and doesn't need to match the item tag
2514 # used in the framework
2515 $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
2516 $marc->encoding("UTF-8");
2517 $xml = $marc->as_xml("USMARC");
2523 =head2 _parse_unlinked_item_subfields_from_xml
2525 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2529 sub _parse_unlinked_item_subfields_from_xml {
2531 require C4::Charset;
2532 return unless defined $xml and $xml ne "";
2533 my $marc = MARC::Record->new_from_xml(C4::Charset::StripNonXmlChars($xml),'UTF-8');
2534 my $unlinked_subfields = [];
2535 my @fields = $marc->fields();
2536 if ($#fields > -1) {
2537 foreach my $subfield ($fields[0]->subfields()) {
2538 push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2541 return $unlinked_subfields;
2544 =head2 GetAnalyticsCount
2546 $count= &GetAnalyticsCount($itemnumber)
2548 counts Usage of itemnumber in Analytical bibliorecords.
2552 sub GetAnalyticsCount {
2553 my ($itemnumber) = @_;
2555 ### ZOOM search here
2557 $query= "hi=".$itemnumber;
2558 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
2559 my ($err,$res,$result) = $searcher->simple_search_compat($query,0,10);
2565 $holds = &GetItemHolds($biblionumber, $itemnumber);
2567 This function return the count of holds with $biblionumber and $itemnumber
2572 my ($biblionumber, $itemnumber) = @_;
2574 my $dbh = C4::Context->dbh;
2575 my $query = "SELECT count(*)
2577 WHERE biblionumber=? AND itemnumber=?";
2578 my $sth = $dbh->prepare($query);
2579 $sth->execute($biblionumber, $itemnumber);
2580 $holds = $sth->fetchrow;
2584 =head2 SearchItemsByField
2586 my $items = SearchItemsByField($field, $value);
2588 SearchItemsByField will search for items on a specific given field.
2589 For instance you can search all items with a specific stocknumber like this:
2591 my $items = SearchItemsByField('stocknumber', $stocknumber);
2595 sub SearchItemsByField {
2596 my ($field, $value) = @_;
2603 my ($results) = SearchItems($filters);
2607 sub _SearchItems_build_where_fragment {
2610 my $dbh = C4::Context->dbh;
2613 if (exists($filter->{conjunction})) {
2614 my (@where_strs, @where_args);
2615 foreach my $f (@{ $filter->{filters} }) {
2616 my $fragment = _SearchItems_build_where_fragment($f);
2618 push @where_strs, $fragment->{str};
2619 push @where_args, @{ $fragment->{args} };
2624 $where_str = '(' . join (' ' . $filter->{conjunction} . ' ', @where_strs) . ')';
2627 args => \@where_args,
2631 my @columns = Koha::Database->new()->schema()->resultset('Item')->result_source->columns;
2632 push @columns, Koha::Database->new()->schema()->resultset('Biblio')->result_source->columns;
2633 push @columns, Koha::Database->new()->schema()->resultset('Biblioitem')->result_source->columns;
2634 my @operators = qw(= != > < >= <= like);
2635 my $field = $filter->{field};
2636 if ( (0 < grep /^$field$/, @columns) or (substr($field, 0, 5) eq 'marc:') ) {
2637 my $op = $filter->{operator};
2638 my $query = $filter->{query};
2640 if (!$op or (0 == grep /^$op$/, @operators)) {
2641 $op = '='; # default operator
2645 if ($field =~ /^marc:(\d{3})(?:\$(\w))?$/) {
2647 my $marcsubfield = $2;
2648 my ($kohafield) = $dbh->selectrow_array(q|
2649 SELECT kohafield FROM marc_subfield_structure
2650 WHERE tagfield=? AND tagsubfield=? AND frameworkcode=''
2651 |, undef, $marcfield, $marcsubfield);
2654 $column = $kohafield;
2656 # MARC field is not linked to a DB field so we need to use
2657 # ExtractValue on biblioitems.marcxml or
2658 # items.more_subfields_xml, depending on the MARC field.
2661 my ($itemfield) = GetMarcFromKohaField('items.itemnumber');
2662 if ($marcfield eq $itemfield) {
2663 $sqlfield = 'more_subfields_xml';
2664 $xpath = '//record/datafield/subfield[@code="' . $marcsubfield . '"]';
2666 $sqlfield = 'marcxml';
2667 if ($marcfield < 10) {
2668 $xpath = "//record/controlfield[\@tag=\"$marcfield\"]";
2670 $xpath = "//record/datafield[\@tag=\"$marcfield\"]/subfield[\@code=\"$marcsubfield\"]";
2673 $column = "ExtractValue($sqlfield, '$xpath')";
2679 if (ref $query eq 'ARRAY') {
2682 } elsif ($op eq '!=') {
2686 str => "$column $op (" . join (',', ('?') x @$query) . ")",
2691 str => "$column $op ?",
2698 return $where_fragment;
2703 my ($items, $total) = SearchItems($filter, $params);
2705 Perform a search among items
2707 $filter is a reference to a hash which can be a filter, or a combination of filters.
2709 A filter has the following keys:
2713 =item * field: the name of a SQL column in table items
2715 =item * query: the value to search in this column
2717 =item * operator: comparison operator. Can be one of = != > < >= <= like
2721 A combination of filters hash the following keys:
2725 =item * conjunction: 'AND' or 'OR'
2727 =item * filters: array ref of filters
2731 $params is a reference to a hash that can contain the following parameters:
2735 =item * rows: Number of items to return. 0 returns everything (default: 0)
2737 =item * page: Page to return (return items from (page-1)*rows to (page*rows)-1)
2740 =item * sortby: A SQL column name in items table to sort on
2742 =item * sortorder: 'ASC' or 'DESC'
2749 my ($filter, $params) = @_;
2753 return unless ref $filter eq 'HASH';
2754 return unless ref $params eq 'HASH';
2756 # Default parameters
2757 $params->{rows} ||= 0;
2758 $params->{page} ||= 1;
2759 $params->{sortby} ||= 'itemnumber';
2760 $params->{sortorder} ||= 'ASC';
2762 my ($where_str, @where_args);
2763 my $where_fragment = _SearchItems_build_where_fragment($filter);
2764 if ($where_fragment) {
2765 $where_str = $where_fragment->{str};
2766 @where_args = @{ $where_fragment->{args} };
2769 my $dbh = C4::Context->dbh;
2771 SELECT SQL_CALC_FOUND_ROWS items.*
2773 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2774 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
2776 if (defined $where_str and $where_str ne '') {
2777 $query .= qq{ WHERE $where_str };
2780 my @columns = Koha::Database->new()->schema()->resultset('Item')->result_source->columns;
2781 push @columns, Koha::Database->new()->schema()->resultset('Biblio')->result_source->columns;
2782 push @columns, Koha::Database->new()->schema()->resultset('Biblioitem')->result_source->columns;
2783 my $sortby = (0 < grep {$params->{sortby} eq $_} @columns)
2784 ? $params->{sortby} : 'itemnumber';
2785 my $sortorder = (uc($params->{sortorder}) eq 'ASC') ? 'ASC' : 'DESC';
2786 $query .= qq{ ORDER BY $sortby $sortorder };
2788 my $rows = $params->{rows};
2791 my $offset = $rows * ($params->{page}-1);
2792 $query .= qq { LIMIT ?, ? };
2793 push @limit_args, $offset, $rows;
2796 my $sth = $dbh->prepare($query);
2797 my $rv = $sth->execute(@where_args, @limit_args);
2799 return unless ($rv);
2800 my ($total_rows) = $dbh->selectrow_array(q{ SELECT FOUND_ROWS() });
2802 return ($sth->fetchall_arrayref({}), $total_rows);
2806 =head1 OTHER FUNCTIONS
2810 ($indicators, $value) = _find_value($tag, $subfield, $record,$encoding);
2812 Find the given $subfield in the given $tag in the given
2813 MARC::Record $record. If the subfield is found, returns
2814 the (indicators, value) pair; otherwise, (undef, undef) is
2818 Such a function is used in addbiblio AND additem and serial-edit and maybe could be used in Authorities.
2819 I suggest we export it from this module.
2824 my ( $tagfield, $insubfield, $record, $encoding ) = @_;
2827 if ( $tagfield < 10 ) {
2828 if ( $record->field($tagfield) ) {
2829 push @result, $record->field($tagfield)->data();
2834 foreach my $field ( $record->field($tagfield) ) {
2835 my @subfields = $field->subfields();
2836 foreach my $subfield (@subfields) {
2837 if ( @$subfield[0] eq $insubfield ) {
2838 push @result, @$subfield[1];
2839 $indicator = $field->indicator(1) . $field->indicator(2);
2844 return ( $indicator, @result );
2848 =head2 PrepareItemrecordDisplay
2850 PrepareItemrecordDisplay($itemrecord,$bibnum,$itemumber,$frameworkcode);
2852 Returns a hash with all the fields for Display a given item data in a template
2854 The $frameworkcode returns the item for the given frameworkcode, ONLY if bibnum is not provided
2858 sub PrepareItemrecordDisplay {
2860 my ( $bibnum, $itemnum, $defaultvalues, $frameworkcode ) = @_;
2862 my $dbh = C4::Context->dbh;
2863 $frameworkcode = &GetFrameworkCode($bibnum) if $bibnum;
2864 my ( $itemtagfield, $itemtagsubfield ) = &GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
2865 my $tagslib = &GetMarcStructure( 1, $frameworkcode );
2867 # return nothing if we don't have found an existing framework.
2868 return q{} unless $tagslib;
2871 $itemrecord = C4::Items::GetMarcItem( $bibnum, $itemnum );
2875 my $branch_limit = C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
2877 SELECT authorised_value,lib FROM authorised_values
2880 LEFT JOIN authorised_values_branches ON ( id = av_id )
2885 $query .= qq{ AND ( branchcode = ? OR branchcode IS NULL )} if $branch_limit;
2886 $query .= qq{ ORDER BY lib};
2887 my $authorised_values_sth = $dbh->prepare( $query );
2888 foreach my $tag ( sort keys %{$tagslib} ) {
2889 my $previous_tag = '';
2892 # loop through each subfield
2894 foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
2895 next if IsMarcStructureInternal($tagslib->{$tag}{$subfield});
2896 next if ( $tagslib->{$tag}->{$subfield}->{'tab'} ne "10" );
2898 $subfield_data{tag} = $tag;
2899 $subfield_data{subfield} = $subfield;
2900 $subfield_data{countsubfield} = $cntsubf++;
2901 $subfield_data{kohafield} = $tagslib->{$tag}->{$subfield}->{'kohafield'};
2902 $subfield_data{id} = "tag_".$tag."_subfield_".$subfield."_".int(rand(1000000));
2904 # $subfield_data{marc_lib}=$tagslib->{$tag}->{$subfield}->{lib};
2905 $subfield_data{marc_lib} = $tagslib->{$tag}->{$subfield}->{lib};
2906 $subfield_data{mandatory} = $tagslib->{$tag}->{$subfield}->{mandatory};
2907 $subfield_data{repeatable} = $tagslib->{$tag}->{$subfield}->{repeatable};
2908 $subfield_data{hidden} = "display:none"
2909 if ( ( $tagslib->{$tag}->{$subfield}->{hidden} > 4 )
2910 || ( $tagslib->{$tag}->{$subfield}->{hidden} < -4 ) );
2911 my ( $x, $defaultvalue );
2913 ( $x, $defaultvalue ) = _find_value( $tag, $subfield, $itemrecord );
2915 $defaultvalue = $tagslib->{$tag}->{$subfield}->{defaultvalue} unless $defaultvalue;
2916 if ( !defined $defaultvalue ) {
2917 $defaultvalue = q||;
2919 $defaultvalue =~ s/"/"/g;
2922 # search for itemcallnumber if applicable
2923 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.itemcallnumber'
2924 && C4::Context->preference('itemcallnumber') ) {
2925 my $CNtag = substr( C4::Context->preference('itemcallnumber'), 0, 3 );
2926 my $CNsubfield = substr( C4::Context->preference('itemcallnumber'), 3, 1 );
2927 if ( $itemrecord and my $field = $itemrecord->field($CNtag) ) {
2928 $defaultvalue = $field->subfield($CNsubfield);
2931 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.itemcallnumber'
2933 && $defaultvalues->{'callnumber'} ) {
2934 if( $itemrecord and $defaultvalues and not $itemrecord->field($subfield) ){
2935 # if the item record exists, only use default value if the item has no callnumber
2936 $defaultvalue = $defaultvalues->{callnumber};
2937 } elsif ( !$itemrecord and $defaultvalues ) {
2938 # if the item record *doesn't* exists, always use the default value
2939 $defaultvalue = $defaultvalues->{callnumber};
2942 if ( ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.holdingbranch' || $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.homebranch' )
2944 && $defaultvalues->{'branchcode'} ) {
2945 if ( $itemrecord and $defaultvalues and not $itemrecord->field($subfield) ) {
2946 $defaultvalue = $defaultvalues->{branchcode};
2949 if ( ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.location' )
2951 && $defaultvalues->{'location'} ) {
2953 if ( $itemrecord and $defaultvalues and not $itemrecord->field($subfield) ) {
2954 # if the item record exists, only use default value if the item has no locationr
2955 $defaultvalue = $defaultvalues->{location};
2956 } elsif ( !$itemrecord and $defaultvalues ) {
2957 # if the item record *doesn't* exists, always use the default value
2958 $defaultvalue = $defaultvalues->{location};
2961 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
2962 my @authorised_values;
2965 # builds list, depending on authorised value...
2967 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
2968 if ( ( C4::Context->preference("IndependentBranches") )
2969 && !C4::Context->IsSuperLibrarian() ) {
2970 my $sth = $dbh->prepare( "SELECT branchcode,branchname FROM branches WHERE branchcode = ? ORDER BY branchname" );
2971 $sth->execute( C4::Context->userenv->{branch} );
2972 push @authorised_values, ""
2973 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2974 while ( my ( $branchcode, $branchname ) = $sth->fetchrow_array ) {
2975 push @authorised_values, $branchcode;
2976 $authorised_lib{$branchcode} = $branchname;
2979 my $sth = $dbh->prepare( "SELECT branchcode,branchname FROM branches ORDER BY branchname" );
2981 push @authorised_values, ""
2982 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2983 while ( my ( $branchcode, $branchname ) = $sth->fetchrow_array ) {
2984 push @authorised_values, $branchcode;
2985 $authorised_lib{$branchcode} = $branchname;
2989 $defaultvalue = C4::Context->userenv ? C4::Context->userenv->{branch} : undef;
2990 if ( $defaultvalues and $defaultvalues->{branchcode} ) {
2991 $defaultvalue = $defaultvalues->{branchcode};
2995 } elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "itemtypes" ) {
2996 my $itemtypes = GetItemTypes( style => 'array' );
2997 push @authorised_values, ""
2998 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2999 for my $itemtype ( @$itemtypes ) {
3000 push @authorised_values, $itemtype->{itemtype};
3001 $authorised_lib{$itemtype->{itemtype}} = $itemtype->{translated_description};
3004 } elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "cn_source" ) {
3005 push @authorised_values, "" unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
3007 my $class_sources = GetClassSources();
3008 my $default_source = C4::Context->preference("DefaultClassificationSource");
3010 foreach my $class_source (sort keys %$class_sources) {
3011 next unless $class_sources->{$class_source}->{'used'} or
3012 ($class_source eq $default_source);
3013 push @authorised_values, $class_source;
3014 $authorised_lib{$class_source} = $class_sources->{$class_source}->{'description'};
3017 $defaultvalue = $default_source;
3019 #---- "true" authorised value
3021 $authorised_values_sth->execute(
3022 $tagslib->{$tag}->{$subfield}->{authorised_value},
3023 $branch_limit ? $branch_limit : ()
3025 push @authorised_values, ""
3026 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
3027 while ( my ( $value, $lib ) = $authorised_values_sth->fetchrow_array ) {
3028 push @authorised_values, $value;
3029 $authorised_lib{$value} = $lib;
3032 $subfield_data{marc_value} = {
3034 values => \@authorised_values,
3035 default => "$defaultvalue",
3036 labels => \%authorised_lib,
3038 } elsif ( $tagslib->{$tag}->{$subfield}->{value_builder} ) {
3040 require Koha::FrameworkPlugin;
3041 my $plugin = Koha::FrameworkPlugin->new({
3042 name => $tagslib->{$tag}->{$subfield}->{value_builder},
3045 my $pars = { dbh => $dbh, record => undef, tagslib =>$tagslib, id => $subfield_data{id}, tabloop => undef };
3046 $plugin->build( $pars );
3047 if( !$plugin->errstr ) {
3048 #TODO Move html to template; see report 12176/13397
3049 my $tab= $plugin->noclick? '-1': '';
3050 my $class= $plugin->noclick? ' disabled': '';
3051 my $title= $plugin->noclick? 'No popup': 'Tag editor';
3052 $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;
3054 warn $plugin->errstr;
3055 $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
3058 elsif ( $tag eq '' ) { # it's an hidden field
3059 $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" />);
3061 elsif ( $tagslib->{$tag}->{$subfield}->{'hidden'} ) { # FIXME: shouldn't input type be "hidden" ?
3062 $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" />);
3064 elsif ( length($defaultvalue) > 100
3065 or (C4::Context->preference("marcflavour") eq "UNIMARC" and
3066 300 <= $tag && $tag < 400 && $subfield eq 'a' )
3067 or (C4::Context->preference("marcflavour") eq "MARC21" and
3068 500 <= $tag && $tag < 600 )
3070 # oversize field (textarea)
3071 $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");
3073 $subfield_data{marc_value} = "<input type=\"text\" name=\"field_value\" value=\"$defaultvalue\" size=\"50\" maxlength=\"255\" />";
3075 push( @loop_data, \%subfield_data );
3080 if ( $itemrecord && $itemrecord->field($itemtagfield) ) {
3081 $itemnumber = $itemrecord->subfield( $itemtagfield, $itemtagsubfield );
3084 'itemtagfield' => $itemtagfield,
3085 'itemtagsubfield' => $itemtagsubfield,
3086 'itemnumber' => $itemnumber,
3087 'iteminformation' => \@loop_data
3091 sub ToggleNewStatus {
3092 my ( $params ) = @_;
3093 my @rules = @{ $params->{rules} };
3094 my $report_only = $params->{report_only};
3096 my $dbh = C4::Context->dbh;
3098 my @item_columns = map { "items.$_" } Koha::Items->columns;
3099 my @biblioitem_columns = map { "biblioitems.$_" } Koha::Biblioitems->columns;
3101 for my $rule ( @rules ) {
3102 my $age = $rule->{age};
3103 my $conditions = $rule->{conditions};
3104 my $substitutions = $rule->{substitutions};
3108 SELECT items.biblionumber, items.itemnumber
3110 LEFT JOIN biblioitems ON biblioitems.biblionumber = items.biblionumber
3113 for my $condition ( @$conditions ) {
3115 grep {/^$condition->{field}$/} @item_columns
3116 or grep {/^$condition->{field}$/} @biblioitem_columns
3118 if ( $condition->{value} =~ /\|/ ) {
3119 my @values = split /\|/, $condition->{value};
3120 $query .= qq| AND $condition->{field} IN (|
3121 . join( ',', ('?') x scalar @values )
3123 push @params, @values;
3125 $query .= qq| AND $condition->{field} = ?|;
3126 push @params, $condition->{value};
3130 if ( defined $age ) {
3131 $query .= q| AND TO_DAYS(NOW()) - TO_DAYS(dateaccessioned) >= ? |;
3134 my $sth = $dbh->prepare($query);
3135 $sth->execute( @params );
3136 while ( my $values = $sth->fetchrow_hashref ) {
3137 my $biblionumber = $values->{biblionumber};
3138 my $itemnumber = $values->{itemnumber};
3139 my $item = C4::Items::GetItem( $itemnumber );
3140 for my $substitution ( @$substitutions ) {
3141 next unless $substitution->{field};
3142 C4::Items::ModItem( {$substitution->{field} => $substitution->{value}}, $biblionumber, $itemnumber )
3143 unless $report_only;
3144 push @{ $report->{$itemnumber} }, $substitution;