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
38 use Koha::AuthorisedValues;
39 use Koha::DateUtils qw/dt_from_string/;
42 use Koha::Biblioitems;
45 use Koha::SearchEngine;
46 use Koha::SearchEngine::Search;
49 use vars qw(@ISA @EXPORT);
54 @ISA = qw( Exporter );
74 GetItemsByBiblioitemnumber
78 GetItemnumbersForBiblio
79 get_hostitemnumbers_of
80 GetItemnumberFromBarcode
81 GetBarcodeFromItemnumber
96 PrepareItemrecordDisplay
103 C4::Items - item management functions
107 This module contains an API for manipulating item
108 records in Koha, and is used by cataloguing, circulation,
109 acquisitions, and serials management.
111 # FIXME This POD is not up-to-date
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 $item = Koha::Items->find( $itemnumber );
161 $item = Koha::Items->find( { barcode => $barcode } );
164 return unless ( $item );
166 my $data = $item->unblessed();
167 $data->{itype} = $item->effective_itemtype(); # set the correct itype
170 my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=?");
171 $ssth->execute( $data->{'itemnumber'} );
172 ( $data->{'serialseq'}, $data->{'publisheddate'} ) = $ssth->fetchrow_array();
180 CartToShelf($itemnumber);
182 Set the current shelving location of the item record
183 to its stored permanent shelving location. This is
184 primarily used to indicate when an item whose current
185 location is a special processing ('PROC') or shelving cart
186 ('CART') location is back in the stacks.
191 my ( $itemnumber ) = @_;
193 unless ( $itemnumber ) {
194 croak "FAILED CartToShelf() - no itemnumber supplied";
197 my $item = GetItem($itemnumber);
198 if ( $item->{location} eq 'CART' ) {
199 $item->{location} = $item->{permanent_location};
200 ModItem($item, undef, $itemnumber);
206 ShelfToCart($itemnumber);
208 Set the current shelving location of the item
209 to shelving cart ('CART').
214 my ( $itemnumber ) = @_;
216 unless ( $itemnumber ) {
217 croak "FAILED ShelfToCart() - no itemnumber supplied";
220 my $item = GetItem($itemnumber);
221 $item->{'location'} = 'CART';
222 ModItem($item, undef, $itemnumber);
225 =head2 AddItemFromMarc
227 my ($biblionumber, $biblioitemnumber, $itemnumber)
228 = AddItemFromMarc($source_item_marc, $biblionumber);
230 Given a MARC::Record object containing an embedded item
231 record and a biblionumber, create a new item record.
235 sub AddItemFromMarc {
236 my ( $source_item_marc, $biblionumber ) = @_;
237 my $dbh = C4::Context->dbh;
239 # parse item hash from MARC
240 my $frameworkcode = GetFrameworkCode( $biblionumber );
241 my ($itemtag,$itemsubfield)=GetMarcFromKohaField("items.itemnumber",$frameworkcode);
243 my $localitemmarc=MARC::Record->new;
244 $localitemmarc->append_fields($source_item_marc->field($itemtag));
245 my $item = &TransformMarcToKoha( $localitemmarc, $frameworkcode ,'items');
246 my $unlinked_item_subfields = _get_unlinked_item_subfields($localitemmarc, $frameworkcode);
247 return AddItem($item, $biblionumber, $dbh, $frameworkcode, $unlinked_item_subfields);
252 my ($biblionumber, $biblioitemnumber, $itemnumber)
253 = AddItem($item, $biblionumber[, $dbh, $frameworkcode, $unlinked_item_subfields]);
255 Given a hash containing item column names as keys,
256 create a new Koha item record.
258 The first two optional parameters (C<$dbh> and C<$frameworkcode>)
259 do not need to be supplied for general use; they exist
260 simply to allow them to be picked up from AddItemFromMarc.
262 The final optional parameter, C<$unlinked_item_subfields>, contains
263 an arrayref containing subfields present in the original MARC
264 representation of the item (e.g., from the item editor) that are
265 not mapped to C<items> columns directly but should instead
266 be stored in C<items.more_subfields_xml> and included in
267 the biblio items tag for display and indexing.
273 my $biblionumber = shift;
275 my $dbh = @_ ? shift : C4::Context->dbh;
276 my $frameworkcode = @_ ? shift : GetFrameworkCode($biblionumber);
277 my $unlinked_item_subfields;
279 $unlinked_item_subfields = shift;
282 # needs old biblionumber and biblioitemnumber
283 $item->{'biblionumber'} = $biblionumber;
284 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
285 $sth->execute( $item->{'biblionumber'} );
286 ( $item->{'biblioitemnumber'} ) = $sth->fetchrow;
288 _set_defaults_for_add($item);
289 _set_derived_columns_for_add($item);
290 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
292 # FIXME - checks here
293 unless ( $item->{itype} ) { # default to biblioitem.itemtype if no itype
294 my $itype_sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
295 $itype_sth->execute( $item->{'biblionumber'} );
296 ( $item->{'itype'} ) = $itype_sth->fetchrow_array;
299 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
302 $item->{'itemnumber'} = $itemnumber;
304 ModZebra( $item->{biblionumber}, "specialUpdate", "biblioserver" );
306 logaction( "CATALOGUING", "ADD", $itemnumber, "item" )
307 if C4::Context->preference("CataloguingLog");
309 return ( $item->{biblionumber}, $item->{biblioitemnumber}, $itemnumber );
312 =head2 AddItemBatchFromMarc
314 ($itemnumber_ref, $error_ref) = AddItemBatchFromMarc($record,
315 $biblionumber, $biblioitemnumber, $frameworkcode);
317 Efficiently create item records from a MARC biblio record with
318 embedded item fields. This routine is suitable for batch jobs.
320 This API assumes that the bib record has already been
321 saved to the C<biblio> and C<biblioitems> tables. It does
322 not expect that C<biblio_metadata.metadata> is populated, but it
323 will do so via a call to ModBibiloMarc.
325 The goal of this API is to have a similar effect to using AddBiblio
326 and AddItems in succession, but without inefficient repeated
327 parsing of the MARC XML bib record.
329 This function returns an arrayref of new itemsnumbers and an arrayref of item
330 errors encountered during the processing. Each entry in the errors
331 list is a hashref containing the following keys:
337 Sequence number of original item tag in the MARC record.
341 Item barcode, provide to assist in the construction of
342 useful error messages.
346 Code representing the error condition. Can be 'duplicate_barcode',
347 'invalid_homebranch', or 'invalid_holdingbranch'.
349 =item error_information
351 Additional information appropriate to the error condition.
357 sub AddItemBatchFromMarc {
358 my ($record, $biblionumber, $biblioitemnumber, $frameworkcode) = @_;
360 my @itemnumbers = ();
362 my $dbh = C4::Context->dbh;
364 # We modify the record, so lets work on a clone so we don't change the
366 $record = $record->clone();
367 # loop through the item tags and start creating items
368 my @bad_item_fields = ();
369 my ($itemtag, $itemsubfield) = &GetMarcFromKohaField("items.itemnumber",'');
370 my $item_sequence_num = 0;
371 ITEMFIELD: foreach my $item_field ($record->field($itemtag)) {
372 $item_sequence_num++;
373 # we take the item field and stick it into a new
374 # MARC record -- this is required so far because (FIXME)
375 # TransformMarcToKoha requires a MARC::Record, not a MARC::Field
376 # and there is no TransformMarcFieldToKoha
377 my $temp_item_marc = MARC::Record->new();
378 $temp_item_marc->append_fields($item_field);
380 # add biblionumber and biblioitemnumber
381 my $item = TransformMarcToKoha( $temp_item_marc, $frameworkcode, 'items' );
382 my $unlinked_item_subfields = _get_unlinked_item_subfields($temp_item_marc, $frameworkcode);
383 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
384 $item->{'biblionumber'} = $biblionumber;
385 $item->{'biblioitemnumber'} = $biblioitemnumber;
387 # check for duplicate barcode
388 my %item_errors = CheckItemPreSave($item);
390 push @errors, _repack_item_errors($item_sequence_num, $item, \%item_errors);
391 push @bad_item_fields, $item_field;
395 _set_defaults_for_add($item);
396 _set_derived_columns_for_add($item);
397 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
398 warn $error if $error;
399 push @itemnumbers, $itemnumber; # FIXME not checking error
400 $item->{'itemnumber'} = $itemnumber;
402 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
404 my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
405 $item_field->replace_with($new_item_marc->field($itemtag));
408 # remove any MARC item fields for rejected items
409 foreach my $item_field (@bad_item_fields) {
410 $record->delete_field($item_field);
413 # update the MARC biblio
414 # $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode );
416 return (\@itemnumbers, \@errors);
419 =head2 ModItemFromMarc
421 ModItemFromMarc($item_marc, $biblionumber, $itemnumber);
423 This function updates an item record based on a supplied
424 C<MARC::Record> object containing an embedded item field.
425 This API is meant for the use of C<additem.pl>; for
426 other purposes, C<ModItem> should be used.
428 This function uses the hash %default_values_for_mod_from_marc,
429 which contains default values for item fields to
430 apply when modifying an item. This is needed because
431 if an item field's value is cleared, TransformMarcToKoha
432 does not include the column in the
433 hash that's passed to ModItem, which without
434 use of this hash makes it impossible to clear
435 an item field's value. See bug 2466.
437 Note that only columns that can be directly
438 changed from the cataloging and serials
439 item editors are included in this hash.
445 sub _build_default_values_for_mod_marc {
446 my ($frameworkcode) = @_;
448 my $cache = Koha::Caches->get_instance();
449 my $cache_key = "default_value_for_mod_marc-$frameworkcode";
450 my $cached = $cache->get_from_cache($cache_key);
451 return $cached if $cached;
453 my $default_values = {
455 booksellerid => undef,
457 'items.cn_source' => undef,
458 coded_location_qualifier => undef,
462 holdingbranch => undef,
464 itemcallnumber => undef,
467 itemnotes_nonpublic => undef,
470 permanent_location => undef,
474 # paidfor => undef, # commented, see bug 12817
476 replacementprice => undef,
477 replacementpricedate => undef,
480 stocknumber => undef,
484 my %default_values_for_mod_from_marc;
485 while ( my ( $field, $default_value ) = each %$default_values ) {
486 my $kohafield = $field;
487 $kohafield =~ s|^([^\.]+)$|items.$1|;
488 $default_values_for_mod_from_marc{$field} =
490 if C4::Koha::IsKohaFieldLinked(
491 { kohafield => $kohafield, frameworkcode => $frameworkcode } );
494 $cache->set_in_cache($cache_key, \%default_values_for_mod_from_marc);
495 return \%default_values_for_mod_from_marc;
498 sub ModItemFromMarc {
499 my $item_marc = shift;
500 my $biblionumber = shift;
501 my $itemnumber = shift;
503 my $dbh = C4::Context->dbh;
504 my $frameworkcode = GetFrameworkCode($biblionumber);
505 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
507 my $localitemmarc = MARC::Record->new;
508 $localitemmarc->append_fields( $item_marc->field($itemtag) );
509 my $item = &TransformMarcToKoha( $localitemmarc, $frameworkcode, 'items' );
510 my $default_values = _build_default_values_for_mod_marc($frameworkcode);
511 foreach my $item_field ( keys %$default_values ) {
512 $item->{$item_field} = $default_values->{$item_field}
513 unless exists $item->{$item_field};
515 my $unlinked_item_subfields = _get_unlinked_item_subfields( $localitemmarc, $frameworkcode );
517 ModItem($item, $biblionumber, $itemnumber, $dbh, $frameworkcode, $unlinked_item_subfields);
523 ModItem({ column => $newvalue }, $biblionumber, $itemnumber);
525 Change one or more columns in an item record and update
526 the MARC representation of the item.
528 The first argument is a hashref mapping from item column
529 names to the new values. The second and third arguments
530 are the biblionumber and itemnumber, respectively.
532 The fourth, optional parameter, C<$unlinked_item_subfields>, contains
533 an arrayref containing subfields present in the original MARC
534 representation of the item (e.g., from the item editor) that are
535 not mapped to C<items> columns directly but should instead
536 be stored in C<items.more_subfields_xml> and included in
537 the biblio items tag for display and indexing.
539 If one of the changed columns is used to calculate
540 the derived value of a column such as C<items.cn_sort>,
541 this routine will perform the necessary calculation
548 my $biblionumber = shift;
549 my $itemnumber = shift;
551 # if $biblionumber is undefined, get it from the current item
552 unless (defined $biblionumber) {
553 $biblionumber = _get_single_item_column('biblionumber', $itemnumber);
556 my $dbh = @_ ? shift : C4::Context->dbh;
557 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
559 my $unlinked_item_subfields;
561 $unlinked_item_subfields = shift;
562 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
565 $item->{'itemnumber'} = $itemnumber or return;
567 my @fields = qw( itemlost withdrawn );
569 # Only call GetItem if we need to set an "on" date field
570 if ( $item->{itemlost} || $item->{withdrawn} ) {
571 my $pre_mod_item = GetItem( $item->{'itemnumber'} );
572 for my $field (@fields) {
573 if ( defined( $item->{$field} )
574 and not $pre_mod_item->{$field}
575 and $item->{$field} )
577 $item->{ $field . '_on' } =
578 DateTime::Format::MySQL->format_datetime( dt_from_string() );
583 # If the field is defined but empty, we are removing and,
584 # and thus need to clear out the 'on' field as well
585 for my $field (@fields) {
586 if ( defined( $item->{$field} ) && !$item->{$field} ) {
587 $item->{ $field . '_on' } = undef;
592 _set_derived_columns_for_mod($item);
593 _do_column_fixes_for_mod($item);
596 # attempt to change itemnumber
597 # attempt to change biblionumber (if we want
598 # an API to relink an item to a different bib,
599 # it should be a separate function)
602 _koha_modify_item($item);
604 # request that bib be reindexed so that searching on current
605 # item status is possible
606 ModZebra( $biblionumber, "specialUpdate", "biblioserver" );
608 logaction("CATALOGUING", "MODIFY", $itemnumber, "item ".Dumper($item)) if C4::Context->preference("CataloguingLog");
611 =head2 ModItemTransfer
613 ModItemTransfer($itenumber, $frombranch, $tobranch);
615 Marks an item as being transferred from one branch
620 sub ModItemTransfer {
621 my ( $itemnumber, $frombranch, $tobranch ) = @_;
623 my $dbh = C4::Context->dbh;
625 # Remove the 'shelving cart' location status if it is being used.
626 CartToShelf( $itemnumber ) if ( C4::Context->preference("ReturnToShelvingCart") );
628 #new entry in branchtransfers....
629 my $sth = $dbh->prepare(
630 "INSERT INTO branchtransfers (itemnumber, frombranch, datesent, tobranch)
631 VALUES (?, ?, NOW(), ?)");
632 $sth->execute($itemnumber, $frombranch, $tobranch);
634 ModItem({ holdingbranch => $tobranch }, undef, $itemnumber);
635 ModDateLastSeen($itemnumber);
639 =head2 ModDateLastSeen
641 ModDateLastSeen($itemnum);
643 Mark item as seen. Is called when an item is issued, returned or manually marked during inventory/stocktaking.
644 C<$itemnum> is the item number
648 sub ModDateLastSeen {
649 my ($itemnumber) = @_;
651 my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
652 ModItem({ itemlost => 0, datelastseen => $today }, undef, $itemnumber);
657 DelItem({ itemnumber => $itemnumber, [ biblionumber => $biblionumber ] } );
659 Exported function (core API) for deleting an item record in Koha.
666 my $itemnumber = $params->{itemnumber};
667 my $biblionumber = $params->{biblionumber};
669 unless ($biblionumber) {
670 $biblionumber = C4::Biblio::GetBiblionumberFromItemnumber($itemnumber);
673 # If there is no biblionumber for the given itemnumber, there is nothing to delete
674 return 0 unless $biblionumber;
676 # FIXME check the item has no current issues
677 my $deleted = _koha_delete_item( $itemnumber );
679 ModZebra( $biblionumber, "specialUpdate", "biblioserver" );
681 #search item field code
682 logaction("CATALOGUING", "DELETE", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
686 =head2 CheckItemPreSave
688 my $item_ref = TransformMarcToKoha($marc, 'items');
690 my %errors = CheckItemPreSave($item_ref);
691 if (exists $errors{'duplicate_barcode'}) {
692 print "item has duplicate barcode: ", $errors{'duplicate_barcode'}, "\n";
693 } elsif (exists $errors{'invalid_homebranch'}) {
694 print "item has invalid home branch: ", $errors{'invalid_homebranch'}, "\n";
695 } elsif (exists $errors{'invalid_holdingbranch'}) {
696 print "item has invalid holding branch: ", $errors{'invalid_holdingbranch'}, "\n";
701 Given a hashref containing item fields, determine if it can be
702 inserted or updated in the database. Specifically, checks for
703 database integrity issues, and returns a hash containing any
704 of the following keys, if applicable.
708 =item duplicate_barcode
710 Barcode, if it duplicates one already found in the database.
712 =item invalid_homebranch
714 Home branch, if not defined in branches table.
716 =item invalid_holdingbranch
718 Holding branch, if not defined in branches table.
722 This function does NOT implement any policy-related checks,
723 e.g., whether current operator is allowed to save an
724 item that has a given branch code.
728 sub CheckItemPreSave {
729 my $item_ref = shift;
733 # check for duplicate barcode
734 if (exists $item_ref->{'barcode'} and defined $item_ref->{'barcode'}) {
735 my $existing_itemnumber = GetItemnumberFromBarcode($item_ref->{'barcode'});
736 if ($existing_itemnumber) {
737 if (!exists $item_ref->{'itemnumber'} # new item
738 or $item_ref->{'itemnumber'} != $existing_itemnumber) { # existing item
739 $errors{'duplicate_barcode'} = $item_ref->{'barcode'};
744 # check for valid home branch
745 if (exists $item_ref->{'homebranch'} and defined $item_ref->{'homebranch'}) {
746 my $home_library = Koha::Libraries->find( $item_ref->{homebranch} );
747 unless (defined $home_library) {
748 $errors{'invalid_homebranch'} = $item_ref->{'homebranch'};
752 # check for valid holding branch
753 if (exists $item_ref->{'holdingbranch'} and defined $item_ref->{'holdingbranch'}) {
754 my $holding_library = Koha::Libraries->find( $item_ref->{holdingbranch} );
755 unless (defined $holding_library) {
756 $errors{'invalid_holdingbranch'} = $item_ref->{'holdingbranch'};
764 =head1 EXPORTED SPECIAL ACCESSOR FUNCTIONS
766 The following functions provide various ways of
767 getting an item record, a set of item records, or
768 lists of authorized values for certain item fields.
770 Some of the functions in this group are candidates
771 for refactoring -- for example, some of the code
772 in C<GetItemsByBiblioitemnumber> and C<GetItemsInfo>
773 has copy-and-paste work.
777 =head2 GetItemsForInventory
779 ($itemlist, $iTotalRecords) = GetItemsForInventory( {
780 minlocation => $minlocation,
781 maxlocation => $maxlocation,
782 location => $location,
783 itemtype => $itemtype,
784 ignoreissued => $ignoreissued,
785 datelastseen => $datelastseen,
786 branchcode => $branchcode,
790 statushash => $statushash,
793 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
795 The sub returns a reference to a list of hashes, each containing
796 itemnumber, author, title, barcode, item callnumber, and date last
797 seen. It is ordered by callnumber then title.
799 The required minlocation & maxlocation parameters are used to specify a range of item callnumbers
800 the datelastseen can be used to specify that you want to see items not seen since a past date only.
801 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
802 $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.
804 $iTotalRecords is the number of rows that would have been returned without the $offset, $size limit clause
808 sub GetItemsForInventory {
809 my ( $parameters ) = @_;
810 my $minlocation = $parameters->{'minlocation'} // '';
811 my $maxlocation = $parameters->{'maxlocation'} // '';
812 my $location = $parameters->{'location'} // '';
813 my $itemtype = $parameters->{'itemtype'} // '';
814 my $ignoreissued = $parameters->{'ignoreissued'} // '';
815 my $datelastseen = $parameters->{'datelastseen'} // '';
816 my $branchcode = $parameters->{'branchcode'} // '';
817 my $branch = $parameters->{'branch'} // '';
818 my $offset = $parameters->{'offset'} // '';
819 my $size = $parameters->{'size'} // '';
820 my $statushash = $parameters->{'statushash'} // '';
822 my $dbh = C4::Context->dbh;
823 my ( @bind_params, @where_strings );
825 my $select_columns = q{
826 SELECT items.itemnumber, barcode, itemcallnumber, title, author, biblio.biblionumber, biblio.frameworkcode, datelastseen, homebranch, location, notforloan, damaged, itemlost, withdrawn, stocknumber
828 my $select_count = q{SELECT COUNT(*)};
831 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
832 LEFT JOIN biblioitems on items.biblionumber = biblioitems.biblionumber
835 for my $authvfield (keys %$statushash){
836 if ( scalar @{$statushash->{$authvfield}} > 0 ){
837 my $joinedvals = join ',', @{$statushash->{$authvfield}};
838 push @where_strings, "$authvfield in (" . $joinedvals . ")";
844 push @where_strings, 'itemcallnumber >= ?';
845 push @bind_params, $minlocation;
849 push @where_strings, 'itemcallnumber <= ?';
850 push @bind_params, $maxlocation;
854 $datelastseen = output_pref({ str => $datelastseen, dateformat => 'iso', dateonly => 1 });
855 push @where_strings, '(datelastseen < ? OR datelastseen IS NULL)';
856 push @bind_params, $datelastseen;
860 push @where_strings, 'items.location = ?';
861 push @bind_params, $location;
865 if($branch eq "homebranch"){
866 push @where_strings, 'items.homebranch = ?';
868 push @where_strings, 'items.holdingbranch = ?';
870 push @bind_params, $branchcode;
874 push @where_strings, 'biblioitems.itemtype = ?';
875 push @bind_params, $itemtype;
878 if ( $ignoreissued) {
879 $query .= "LEFT JOIN issues ON items.itemnumber = issues.itemnumber ";
880 push @where_strings, 'issues.date_due IS NULL';
883 if ( @where_strings ) {
885 $query .= join ' AND ', @where_strings;
887 $query .= ' ORDER BY items.cn_sort, itemcallnumber, title';
888 my $count_query = $select_count . $query;
889 $query .= " LIMIT $offset, $size" if ($offset and $size);
890 $query = $select_columns . $query;
891 my $sth = $dbh->prepare($query);
892 $sth->execute( @bind_params );
895 my $tmpresults = $sth->fetchall_arrayref({});
896 $sth = $dbh->prepare( $count_query );
897 $sth->execute( @bind_params );
898 my ($iTotalRecords) = $sth->fetchrow_array();
900 my @avs = Koha::AuthorisedValues->search(
901 { 'marc_subfield_structures.kohafield' => { '>' => '' },
902 'me.authorised_value' => { '>' => '' },
904 { join => { category => 'marc_subfield_structures' },
905 distinct => ['marc_subfield_structures.kohafield, me.category, frameworkcode, me.authorised_value'],
906 '+select' => [ 'marc_subfield_structures.kohafield', 'marc_subfield_structures.frameworkcode', 'me.authorised_value', 'me.lib' ],
907 '+as' => [ 'kohafield', 'frameworkcode', 'authorised_value', 'lib' ],
911 my $avmapping = { map { $_->get_column('kohafield') . ',' . $_->get_column('frameworkcode') . ',' . $_->get_column('authorised_value') => $_->get_column('lib') } @avs };
913 foreach my $row (@$tmpresults) {
916 foreach (keys %$row) {
917 if (defined($avmapping->{"items.$_,".$row->{'frameworkcode'}.",".$row->{$_}})) {
918 $row->{$_} = $avmapping->{"items.$_,".$row->{'frameworkcode'}.",".$row->{$_}};
924 return (\@results, $iTotalRecords);
927 =head2 GetItemInfosOf
929 GetItemInfosOf(@itemnumbers);
934 my @itemnumbers = @_;
936 my $itemnumber_values = @itemnumbers ? join( ',', @itemnumbers ) : "''";
938 my $dbh = C4::Context->dbh;
942 WHERE itemnumber IN ($itemnumber_values)
944 return $dbh->selectall_hashref($query, 'itemnumber');
947 =head2 GetItemsByBiblioitemnumber
949 GetItemsByBiblioitemnumber($biblioitemnumber);
951 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
952 Called by C<C4::XISBN>
956 sub GetItemsByBiblioitemnumber {
957 my ( $bibitem ) = @_;
958 my $dbh = C4::Context->dbh;
959 my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
960 # Get all items attached to a biblioitem
963 $sth->execute($bibitem) || die $sth->errstr;
964 while ( my $data = $sth->fetchrow_hashref ) {
965 # Foreach item, get circulation information
966 my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
968 AND issues.borrowernumber = borrowers.borrowernumber"
970 $sth2->execute( $data->{'itemnumber'} );
971 if ( my $data2 = $sth2->fetchrow_hashref ) {
972 # if item is out, set the due date and who it is out too
973 $data->{'date_due'} = $data2->{'date_due'};
974 $data->{'cardnumber'} = $data2->{'cardnumber'};
975 $data->{'borrowernumber'} = $data2->{'borrowernumber'};
978 # set date_due to blank, so in the template we check itemlost, and withdrawn
979 $data->{'date_due'} = '';
981 # Find the last 3 people who borrowed this item.
982 my $query2 = "SELECT * FROM old_issues, borrowers WHERE itemnumber = ?
983 AND old_issues.borrowernumber = borrowers.borrowernumber
984 ORDER BY returndate desc,timestamp desc LIMIT 3";
985 $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
986 $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
988 while ( my $data2 = $sth2->fetchrow_hashref ) {
989 $data->{"timestamp$i2"} = $data2->{'timestamp'};
990 $data->{"card$i2"} = $data2->{'cardnumber'};
991 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
994 push(@results,$data);
1001 @results = GetItemsInfo($biblionumber);
1003 Returns information about items with the given biblionumber.
1005 C<GetItemsInfo> returns a list of references-to-hash. Each element
1006 contains a number of keys. Most of them are attributes from the
1007 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
1008 Koha database. Other keys include:
1012 =item C<$data-E<gt>{branchname}>
1014 The name (not the code) of the branch to which the book belongs.
1016 =item C<$data-E<gt>{datelastseen}>
1018 This is simply C<items.datelastseen>, except that while the date is
1019 stored in YYYY-MM-DD format in the database, here it is converted to
1020 DD/MM/YYYY format. A NULL date is returned as C<//>.
1022 =item C<$data-E<gt>{datedue}>
1024 =item C<$data-E<gt>{class}>
1026 This is the concatenation of C<biblioitems.classification>, the book's
1027 Dewey code, and C<biblioitems.subclass>.
1029 =item C<$data-E<gt>{ocount}>
1031 I think this is the number of copies of the book available.
1033 =item C<$data-E<gt>{order}>
1035 If this is set, it is set to C<One Order>.
1042 my ( $biblionumber ) = @_;
1043 my $dbh = C4::Context->dbh;
1044 require C4::Languages;
1045 my $language = C4::Languages::getlanguage();
1051 biblioitems.itemtype,
1054 biblioitems.publicationyear,
1055 biblioitems.publishercode,
1056 biblioitems.volumedate,
1057 biblioitems.volumedesc,
1060 items.notforloan as itemnotforloan,
1061 issues.borrowernumber,
1062 issues.date_due as datedue,
1063 issues.onsite_checkout,
1064 borrowers.cardnumber,
1066 borrowers.firstname,
1067 borrowers.branchcode as bcode,
1069 serial.publisheddate,
1070 itemtypes.description,
1071 COALESCE( localization.translation, itemtypes.description ) AS translated_description,
1072 itemtypes.notforloan as notforloan_per_itemtype,
1076 holding.opac_info as holding_branch_opac_info,
1077 home.opac_info as home_branch_opac_info
1081 LEFT JOIN branches AS holding ON items.holdingbranch = holding.branchcode
1082 LEFT JOIN branches AS home ON items.homebranch=home.branchcode
1083 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1084 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1085 LEFT JOIN issues USING (itemnumber)
1086 LEFT JOIN borrowers USING (borrowernumber)
1087 LEFT JOIN serialitems USING (itemnumber)
1088 LEFT JOIN serial USING (serialid)
1089 LEFT JOIN itemtypes ON itemtypes.itemtype = "
1090 . (C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype');
1092 LEFT JOIN localization ON itemtypes.itemtype = localization.code
1093 AND localization.entity = 'itemtypes'
1094 AND localization.lang = ?
1097 $query .= " WHERE items.biblionumber = ? ORDER BY home.branchname, items.enumchron, LPAD( items.copynumber, 8, '0' ), items.dateaccessioned DESC" ;
1098 my $sth = $dbh->prepare($query);
1099 $sth->execute($language, $biblionumber);
1104 my $userenv = C4::Context->userenv;
1105 my $want_not_same_branch = C4::Context->preference("IndependentBranches") && !C4::Context->IsSuperLibrarian();
1106 while ( my $data = $sth->fetchrow_hashref ) {
1107 if ( $data->{borrowernumber} && $want_not_same_branch) {
1108 $data->{'NOTSAMEBRANCH'} = $data->{'bcode'} ne $userenv->{branch};
1111 $serial ||= $data->{'serial'};
1114 # get notforloan complete status if applicable
1115 $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({frameworkcode => $data->{frameworkcode}, kohafield => 'items.notforloan', authorised_value => $data->{itemnotforloan} });
1116 $data->{notforloanvalue} = $descriptions->{lib} // '';
1117 $data->{notforloanvalueopac} = $descriptions->{opac_description} // '';
1119 # get restricted status and description if applicable
1120 $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({frameworkcode => $data->{frameworkcode}, kohafield => 'items.restricted', authorised_value => $data->{restricted} });
1121 $data->{restricted} = $descriptions->{lib} // '';
1122 $data->{restrictedopac} = $descriptions->{opac_description} // '';
1124 # my stack procedures
1125 $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({frameworkcode => $data->{frameworkcode}, kohafield => 'items.stack', authorised_value => $data->{stack} });
1126 $data->{stack} = $descriptions->{lib} // '';
1128 # Find the last 3 people who borrowed this item.
1129 my $sth2 = $dbh->prepare("SELECT * FROM old_issues,borrowers
1130 WHERE itemnumber = ?
1131 AND old_issues.borrowernumber = borrowers.borrowernumber
1132 ORDER BY returndate DESC
1134 $sth2->execute($data->{'itemnumber'});
1136 while (my $data2 = $sth2->fetchrow_hashref()) {
1137 $data->{"timestamp$ii"} = $data2->{'timestamp'} if $data2->{'timestamp'};
1138 $data->{"card$ii"} = $data2->{'cardnumber'} if $data2->{'cardnumber'};
1139 $data->{"borrower$ii"} = $data2->{'borrowernumber'} if $data2->{'borrowernumber'};
1143 $results[$i] = $data;
1148 ? sort { ($b->{'publisheddate'} || $b->{'enumchron'}) cmp ($a->{'publisheddate'} || $a->{'enumchron'}) } @results
1152 =head2 GetItemsLocationInfo
1154 my @itemlocinfo = GetItemsLocationInfo($biblionumber);
1156 Returns the branch names, shelving location and itemcallnumber for each item attached to the biblio in question
1158 C<GetItemsInfo> returns a list of references-to-hash. Data returned:
1162 =item C<$data-E<gt>{homebranch}>
1164 Branch Name of the item's homebranch
1166 =item C<$data-E<gt>{holdingbranch}>
1168 Branch Name of the item's holdingbranch
1170 =item C<$data-E<gt>{location}>
1172 Item's shelving location code
1174 =item C<$data-E<gt>{location_intranet}>
1176 The intranet description for the Shelving Location as set in authorised_values 'LOC'
1178 =item C<$data-E<gt>{location_opac}>
1180 The OPAC description for the Shelving Location as set in authorised_values 'LOC'. Falls back to intranet description if no OPAC
1183 =item C<$data-E<gt>{itemcallnumber}>
1185 Item's itemcallnumber
1187 =item C<$data-E<gt>{cn_sort}>
1189 Item's call number normalized for sorting
1195 sub GetItemsLocationInfo {
1196 my $biblionumber = shift;
1199 my $dbh = C4::Context->dbh;
1200 my $query = "SELECT a.branchname as homebranch, b.branchname as holdingbranch,
1201 location, itemcallnumber, cn_sort
1202 FROM items, branches as a, branches as b
1203 WHERE homebranch = a.branchcode AND holdingbranch = b.branchcode
1204 AND biblionumber = ?
1205 ORDER BY cn_sort ASC";
1206 my $sth = $dbh->prepare($query);
1207 $sth->execute($biblionumber);
1209 while ( my $data = $sth->fetchrow_hashref ) {
1210 my $av = Koha::AuthorisedValues->search({ category => 'LOC', authorised_value => $data->{location} });
1211 $av = $av->count ? $av->next : undef;
1212 $data->{location_intranet} = $av ? $av->lib : '';
1213 $data->{location_opac} = $av ? $av->opac_description : '';
1214 push @results, $data;
1219 =head2 GetHostItemsInfo
1221 $hostiteminfo = GetHostItemsInfo($hostfield);
1222 Returns the iteminfo for items linked to records via a host field
1226 sub GetHostItemsInfo {
1228 my @returnitemsInfo;
1230 if (C4::Context->preference('marcflavour') eq 'MARC21' ||
1231 C4::Context->preference('marcflavour') eq 'NORMARC'){
1232 foreach my $hostfield ( $record->field('773') ) {
1233 my $hostbiblionumber = $hostfield->subfield("0");
1234 my $linkeditemnumber = $hostfield->subfield("9");
1235 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1236 foreach my $hostitemInfo (@hostitemInfos){
1237 if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1238 push (@returnitemsInfo,$hostitemInfo);
1243 } elsif ( C4::Context->preference('marcflavour') eq 'UNIMARC'){
1244 foreach my $hostfield ( $record->field('461') ) {
1245 my $hostbiblionumber = $hostfield->subfield("0");
1246 my $linkeditemnumber = $hostfield->subfield("9");
1247 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1248 foreach my $hostitemInfo (@hostitemInfos){
1249 if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1250 push (@returnitemsInfo,$hostitemInfo);
1256 return @returnitemsInfo;
1260 =head2 GetLastAcquisitions
1262 my $lastacq = GetLastAcquisitions({'branches' => ('branch1','branch2'),
1263 'itemtypes' => ('BK','BD')}, 10);
1267 sub GetLastAcquisitions {
1268 my ($data,$max) = @_;
1270 my $itemtype = C4::Context->preference('item-level_itypes') ? 'itype' : 'itemtype';
1272 my $number_of_branches = @{$data->{branches}};
1273 my $number_of_itemtypes = @{$data->{itemtypes}};
1276 my @where = ('WHERE 1 ');
1277 $number_of_branches and push @where
1278 , 'AND holdingbranch IN ('
1279 , join(',', ('?') x $number_of_branches )
1283 $number_of_itemtypes and push @where
1284 , "AND $itemtype IN ("
1285 , join(',', ('?') x $number_of_itemtypes )
1289 my $query = "SELECT biblio.biblionumber as biblionumber, title, dateaccessioned
1290 FROM items RIGHT JOIN biblio ON (items.biblionumber=biblio.biblionumber)
1291 RIGHT JOIN biblioitems ON (items.biblioitemnumber=biblioitems.biblioitemnumber)
1293 GROUP BY biblio.biblionumber
1294 ORDER BY dateaccessioned DESC LIMIT $max";
1296 my $dbh = C4::Context->dbh;
1297 my $sth = $dbh->prepare($query);
1299 $sth->execute((@{$data->{branches}}, @{$data->{itemtypes}}));
1302 while( my $row = $sth->fetchrow_hashref){
1303 push @results, {date => $row->{dateaccessioned}
1304 , biblionumber => $row->{biblionumber}
1305 , title => $row->{title}};
1311 =head2 GetItemnumbersForBiblio
1313 my $itemnumbers = GetItemnumbersForBiblio($biblionumber);
1315 Given a single biblionumber, return an arrayref of all the corresponding itemnumbers
1319 sub GetItemnumbersForBiblio {
1320 my $biblionumber = shift;
1322 my $dbh = C4::Context->dbh;
1323 my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber = ?");
1324 $sth->execute($biblionumber);
1325 while (my $result = $sth->fetchrow_hashref) {
1326 push @items, $result->{'itemnumber'};
1331 =head2 get_hostitemnumbers_of
1333 my @itemnumbers_of = get_hostitemnumbers_of($biblionumber);
1335 Given a biblionumber, return the list of corresponding itemnumbers that are linked to it via host fields
1337 Return a reference on a hash where key is a biblionumber and values are
1338 references on array of itemnumbers.
1343 sub get_hostitemnumbers_of {
1344 my ($biblionumber) = @_;
1345 my $marcrecord = GetMarcBiblio($biblionumber);
1347 return unless $marcrecord;
1349 my ( @returnhostitemnumbers, $tag, $biblio_s, $item_s );
1351 my $marcflavor = C4::Context->preference('marcflavour');
1352 if ( $marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC' ) {
1357 elsif ( $marcflavor eq 'UNIMARC' ) {
1363 foreach my $hostfield ( $marcrecord->field($tag) ) {
1364 my $hostbiblionumber = $hostfield->subfield($biblio_s);
1365 my $linkeditemnumber = $hostfield->subfield($item_s);
1366 my $is_from_biblio = Koha::Items->search({ itemnumber => $linkeditemnumber, biblionumber => $hostbiblionumber });
1367 push @returnhostitemnumbers, $linkeditemnumber
1371 return @returnhostitemnumbers;
1375 =head2 GetItemnumberFromBarcode
1377 $result = GetItemnumberFromBarcode($barcode);
1381 sub GetItemnumberFromBarcode {
1383 my $dbh = C4::Context->dbh;
1386 $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1387 $rq->execute($barcode);
1388 my ($result) = $rq->fetchrow;
1392 =head2 GetBarcodeFromItemnumber
1394 $result = GetBarcodeFromItemnumber($itemnumber);
1398 sub GetBarcodeFromItemnumber {
1399 my ($itemnumber) = @_;
1400 my $dbh = C4::Context->dbh;
1403 $dbh->prepare("SELECT barcode FROM items WHERE items.itemnumber=?");
1404 $rq->execute($itemnumber);
1405 my ($result) = $rq->fetchrow;
1409 =head2 GetHiddenItemnumbers
1411 my @itemnumbers_to_hide = GetHiddenItemnumbers(@items);
1413 Given a list of items it checks which should be hidden from the OPAC given
1414 the current configuration. Returns a list of itemnumbers corresponding to
1415 those that should be hidden.
1419 sub GetHiddenItemnumbers {
1423 my $yaml = C4::Context->preference('OpacHiddenItems');
1424 return () if (! $yaml =~ /\S/ );
1425 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1428 $hidingrules = YAML::Load($yaml);
1431 warn "Unable to parse OpacHiddenItems syspref : $@";
1434 my $dbh = C4::Context->dbh;
1437 foreach my $item (@items) {
1439 # We check each rule
1440 foreach my $field (keys %$hidingrules) {
1442 if (exists $item->{$field}) {
1443 $val = $item->{$field};
1446 my $query = "SELECT $field from items where itemnumber = ?";
1447 $val = $dbh->selectrow_array($query, undef, $item->{'itemnumber'});
1449 $val = '' unless defined $val;
1451 # If the results matches the values in the yaml file
1452 if (any { $val eq $_ } @{$hidingrules->{$field}}) {
1454 # We add the itemnumber to the list
1455 push @resultitems, $item->{'itemnumber'};
1457 # If at least one rule matched for an item, no need to test the others
1462 return @resultitems;
1465 =head1 LIMITED USE FUNCTIONS
1467 The following functions, while part of the public API,
1468 are not exported. This is generally because they are
1469 meant to be used by only one script for a specific
1470 purpose, and should not be used in any other context
1471 without careful thought.
1477 my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1479 Returns MARC::Record of the item passed in parameter.
1480 This function is meant for use only in C<cataloguing/additem.pl>,
1481 where it is needed to support that script's MARC-like
1487 my ( $biblionumber, $itemnumber ) = @_;
1489 # GetMarcItem has been revised so that it does the following:
1490 # 1. Gets the item information from the items table.
1491 # 2. Converts it to a MARC field for storage in the bib record.
1493 # The previous behavior was:
1494 # 1. Get the bib record.
1495 # 2. Return the MARC tag corresponding to the item record.
1497 # The difference is that one treats the items row as authoritative,
1498 # while the other treats the MARC representation as authoritative
1499 # under certain circumstances.
1501 my $itemrecord = GetItem($itemnumber);
1503 # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1504 # Also, don't emit a subfield if the underlying field is blank.
1507 return Item2Marc($itemrecord,$biblionumber);
1511 my ($itemrecord,$biblionumber)=@_;
1514 defined($itemrecord->{$_}) && $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : ()
1515 } keys %{ $itemrecord }
1517 my $itemmarc = TransformKohaToMarc($mungeditem);
1518 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",GetFrameworkCode($biblionumber)||'');
1520 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1521 if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1522 foreach my $field ($itemmarc->field($itemtag)){
1523 $field->add_subfields(@$unlinked_item_subfields);
1529 =head1 PRIVATE FUNCTIONS AND VARIABLES
1531 The following functions are not meant to be called
1532 directly, but are documented in order to explain
1533 the inner workings of C<C4::Items>.
1537 =head2 %derived_columns
1539 This hash keeps track of item columns that
1540 are strictly derived from other columns in
1541 the item record and are not meant to be set
1544 Each key in the hash should be the name of a
1545 column (as named by TransformMarcToKoha). Each
1546 value should be hashref whose keys are the
1547 columns on which the derived column depends. The
1548 hashref should also contain a 'BUILDER' key
1549 that is a reference to a sub that calculates
1554 my %derived_columns = (
1555 'items.cn_sort' => {
1556 'itemcallnumber' => 1,
1557 'items.cn_source' => 1,
1558 'BUILDER' => \&_calc_items_cn_sort,
1562 =head2 _set_derived_columns_for_add
1564 _set_derived_column_for_add($item);
1566 Given an item hash representing a new item to be added,
1567 calculate any derived columns. Currently the only
1568 such column is C<items.cn_sort>.
1572 sub _set_derived_columns_for_add {
1575 foreach my $column (keys %derived_columns) {
1576 my $builder = $derived_columns{$column}->{'BUILDER'};
1577 my $source_values = {};
1578 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1579 next if $source_column eq 'BUILDER';
1580 $source_values->{$source_column} = $item->{$source_column};
1582 $builder->($item, $source_values);
1586 =head2 _set_derived_columns_for_mod
1588 _set_derived_column_for_mod($item);
1590 Given an item hash representing a new item to be modified.
1591 calculate any derived columns. Currently the only
1592 such column is C<items.cn_sort>.
1594 This routine differs from C<_set_derived_columns_for_add>
1595 in that it needs to handle partial item records. In other
1596 words, the caller of C<ModItem> may have supplied only one
1597 or two columns to be changed, so this function needs to
1598 determine whether any of the columns to be changed affect
1599 any of the derived columns. Also, if a derived column
1600 depends on more than one column, but the caller is not
1601 changing all of then, this routine retrieves the unchanged
1602 values from the database in order to ensure a correct
1607 sub _set_derived_columns_for_mod {
1610 foreach my $column (keys %derived_columns) {
1611 my $builder = $derived_columns{$column}->{'BUILDER'};
1612 my $source_values = {};
1613 my %missing_sources = ();
1614 my $must_recalc = 0;
1615 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1616 next if $source_column eq 'BUILDER';
1617 if (exists $item->{$source_column}) {
1619 $source_values->{$source_column} = $item->{$source_column};
1621 $missing_sources{$source_column} = 1;
1625 foreach my $source_column (keys %missing_sources) {
1626 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
1628 $builder->($item, $source_values);
1633 =head2 _do_column_fixes_for_mod
1635 _do_column_fixes_for_mod($item);
1637 Given an item hashref containing one or more
1638 columns to modify, fix up certain values.
1639 Specifically, set to 0 any passed value
1640 of C<notforloan>, C<damaged>, C<itemlost>, or
1641 C<withdrawn> that is either undefined or
1642 contains the empty string.
1646 sub _do_column_fixes_for_mod {
1649 if (exists $item->{'notforloan'} and
1650 (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
1651 $item->{'notforloan'} = 0;
1653 if (exists $item->{'damaged'} and
1654 (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
1655 $item->{'damaged'} = 0;
1657 if (exists $item->{'itemlost'} and
1658 (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
1659 $item->{'itemlost'} = 0;
1661 if (exists $item->{'withdrawn'} and
1662 (not defined $item->{'withdrawn'} or $item->{'withdrawn'} eq '')) {
1663 $item->{'withdrawn'} = 0;
1665 if (exists $item->{location}
1666 and $item->{location} ne 'CART'
1667 and $item->{location} ne 'PROC'
1668 and not $item->{permanent_location}
1670 $item->{'permanent_location'} = $item->{'location'};
1672 if (exists $item->{'timestamp'}) {
1673 delete $item->{'timestamp'};
1677 =head2 _get_single_item_column
1679 _get_single_item_column($column, $itemnumber);
1681 Retrieves the value of a single column from an C<items>
1682 row specified by C<$itemnumber>.
1686 sub _get_single_item_column {
1688 my $itemnumber = shift;
1690 my $dbh = C4::Context->dbh;
1691 my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
1692 $sth->execute($itemnumber);
1693 my ($value) = $sth->fetchrow();
1697 =head2 _calc_items_cn_sort
1699 _calc_items_cn_sort($item, $source_values);
1701 Helper routine to calculate C<items.cn_sort>.
1705 sub _calc_items_cn_sort {
1707 my $source_values = shift;
1709 $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
1712 =head2 _set_defaults_for_add
1714 _set_defaults_for_add($item_hash);
1716 Given an item hash representing an item to be added, set
1717 correct default values for columns whose default value
1718 is not handled by the DBMS. This includes the following
1725 C<items.dateaccessioned>
1747 sub _set_defaults_for_add {
1749 $item->{dateaccessioned} ||= output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
1750 $item->{$_} ||= 0 for (qw( notforloan damaged itemlost withdrawn));
1753 =head2 _koha_new_item
1755 my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
1757 Perform the actual insert into the C<items> table.
1761 sub _koha_new_item {
1762 my ( $item, $barcode ) = @_;
1763 my $dbh=C4::Context->dbh;
1765 $item->{permanent_location} //= $item->{location};
1766 _mod_item_dates( $item );
1768 "INSERT INTO items SET
1770 biblioitemnumber = ?,
1772 dateaccessioned = ?,
1776 replacementprice = ?,
1777 replacementpricedate = ?,
1778 datelastborrowed = ?,
1786 coded_location_qualifier = ?,
1789 itemnotes_nonpublic = ?,
1793 permanent_location = ?,
1805 more_subfields_xml = ?,
1810 my $sth = $dbh->prepare($query);
1811 my $today = output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 });
1813 $item->{'biblionumber'},
1814 $item->{'biblioitemnumber'},
1816 $item->{'dateaccessioned'},
1817 $item->{'booksellerid'},
1818 $item->{'homebranch'},
1820 $item->{'replacementprice'},
1821 $item->{'replacementpricedate'} || $today,
1822 $item->{datelastborrowed},
1823 $item->{datelastseen} || $today,
1825 $item->{'notforloan'},
1827 $item->{'itemlost'},
1828 $item->{'withdrawn'},
1829 $item->{'itemcallnumber'},
1830 $item->{'coded_location_qualifier'},
1831 $item->{'restricted'},
1832 $item->{'itemnotes'},
1833 $item->{'itemnotes_nonpublic'},
1834 $item->{'holdingbranch'},
1836 $item->{'location'},
1837 $item->{'permanent_location'},
1840 $item->{'renewals'},
1841 $item->{'reserves'},
1842 $item->{'items.cn_source'},
1843 $item->{'items.cn_sort'},
1846 $item->{'materials'},
1848 $item->{'enumchron'},
1849 $item->{'more_subfields_xml'},
1850 $item->{'copynumber'},
1851 $item->{'stocknumber'},
1852 $item->{'new_status'},
1856 if ( defined $sth->errstr ) {
1857 $error.="ERROR in _koha_new_item $query".$sth->errstr;
1860 $itemnumber = $dbh->{'mysql_insertid'};
1863 return ( $itemnumber, $error );
1866 =head2 MoveItemFromBiblio
1868 MoveItemFromBiblio($itenumber, $frombiblio, $tobiblio);
1870 Moves an item from a biblio to another
1872 Returns undef if the move failed or the biblionumber of the destination record otherwise
1876 sub MoveItemFromBiblio {
1877 my ($itemnumber, $frombiblio, $tobiblio) = @_;
1878 my $dbh = C4::Context->dbh;
1879 my ( $tobiblioitem ) = $dbh->selectrow_array(q|
1880 SELECT biblioitemnumber
1882 WHERE biblionumber = ?
1883 |, undef, $tobiblio );
1884 my $return = $dbh->do(q|
1886 SET biblioitemnumber = ?,
1888 WHERE itemnumber = ?
1889 AND biblionumber = ?
1890 |, undef, $tobiblioitem, $tobiblio, $itemnumber, $frombiblio );
1892 ModZebra( $tobiblio, "specialUpdate", "biblioserver" );
1893 ModZebra( $frombiblio, "specialUpdate", "biblioserver" );
1894 # Checking if the item we want to move is in an order
1895 require C4::Acquisition;
1896 my $order = C4::Acquisition::GetOrderFromItemnumber($itemnumber);
1898 # Replacing the biblionumber within the order if necessary
1899 $order->{'biblionumber'} = $tobiblio;
1900 C4::Acquisition::ModOrder($order);
1903 # Update reserves, hold_fill_targets, tmp_holdsqueue and linktracker tables
1904 for my $table_name ( qw( reserves hold_fill_targets tmp_holdsqueue linktracker ) ) {
1907 SET biblionumber = ?
1908 WHERE itemnumber = ?
1909 |, undef, $tobiblio, $itemnumber );
1916 =head2 ItemSafeToDelete
1918 ItemSafeToDelete( $biblionumber, $itemnumber);
1920 Exported function (core API) for checking whether an item record is safe to delete.
1922 returns 1 if the item is safe to delete,
1924 "book_on_loan" if the item is checked out,
1926 "not_same_branch" if the item is blocked by independent branches,
1928 "book_reserved" if the there are holds aganst the item, or
1930 "linked_analytics" if the item has linked analytic records.
1934 sub ItemSafeToDelete {
1935 my ( $biblionumber, $itemnumber ) = @_;
1937 my $dbh = C4::Context->dbh;
1941 my $countanalytics = GetAnalyticsCount($itemnumber);
1943 # check that there is no issue on this item before deletion.
1944 my $sth = $dbh->prepare(
1946 SELECT COUNT(*) FROM issues
1947 WHERE itemnumber = ?
1950 $sth->execute($itemnumber);
1951 my ($onloan) = $sth->fetchrow;
1953 my $item = GetItem($itemnumber);
1956 $status = "book_on_loan";
1958 elsif ( defined C4::Context->userenv
1959 and !C4::Context->IsSuperLibrarian()
1960 and C4::Context->preference("IndependentBranches")
1961 and ( C4::Context->userenv->{branch} ne $item->{'homebranch'} ) )
1963 $status = "not_same_branch";
1966 # check it doesn't have a waiting reserve
1967 $sth = $dbh->prepare(
1969 SELECT COUNT(*) FROM reserves
1970 WHERE (found = 'W' OR found = 'T')
1974 $sth->execute($itemnumber);
1975 my ($reserve) = $sth->fetchrow;
1977 $status = "book_reserved";
1979 elsif ( $countanalytics > 0 ) {
1980 $status = "linked_analytics";
1991 DelItemCheck( $biblionumber, $itemnumber);
1993 Exported function (core API) for deleting an item record in Koha if there no current issue.
1995 DelItemCheck wraps ItemSafeToDelete around DelItem.
2000 my ( $biblionumber, $itemnumber ) = @_;
2001 my $status = ItemSafeToDelete( $biblionumber, $itemnumber );
2003 if ( $status == 1 ) {
2006 biblionumber => $biblionumber,
2007 itemnumber => $itemnumber
2014 =head2 _koha_modify_item
2016 my ($itemnumber,$error) =_koha_modify_item( $item );
2018 Perform the actual update of the C<items> row. Note that this
2019 routine accepts a hashref specifying the columns to update.
2023 sub _koha_modify_item {
2025 my $dbh=C4::Context->dbh;
2028 my $query = "UPDATE items SET ";
2030 _mod_item_dates( $item );
2031 for my $key ( keys %$item ) {
2032 next if ( $key eq 'itemnumber' );
2034 push @bind, $item->{$key};
2037 $query .= " WHERE itemnumber=?";
2038 push @bind, $item->{'itemnumber'};
2039 my $sth = $dbh->prepare($query);
2040 $sth->execute(@bind);
2042 $error.="ERROR in _koha_modify_item $query: ".$sth->errstr;
2045 return ($item->{'itemnumber'},$error);
2048 sub _mod_item_dates { # date formatting for date fields in item hash
2050 return if !$item || ref($item) ne 'HASH';
2053 { $_ =~ /^onloan$|^date|date$|datetime$/ }
2055 # Incl. dateaccessioned,replacementpricedate,datelastborrowed,datelastseen
2056 # NOTE: We do not (yet) have items fields ending with datetime
2057 # Fields with _on$ have been handled already
2059 foreach my $key ( @keys ) {
2060 next if !defined $item->{$key}; # skip undefs
2061 my $dt = eval { dt_from_string( $item->{$key} ) };
2062 # eval: dt_from_string will die on us if we pass illegal dates
2065 if( defined $dt && ref($dt) eq 'DateTime' ) {
2066 if( $key =~ /datetime/ ) {
2067 $newstr = DateTime::Format::MySQL->format_datetime($dt);
2069 $newstr = DateTime::Format::MySQL->format_date($dt);
2072 $item->{$key} = $newstr; # might be undef to clear garbage
2076 =head2 _koha_delete_item
2078 _koha_delete_item( $itemnum );
2080 Internal function to delete an item record from the koha tables
2084 sub _koha_delete_item {
2085 my ( $itemnum ) = @_;
2087 my $dbh = C4::Context->dbh;
2088 # save the deleted item to deleteditems table
2089 my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
2090 $sth->execute($itemnum);
2091 my $data = $sth->fetchrow_hashref();
2093 # There is no item to delete
2094 return 0 unless $data;
2096 my $query = "INSERT INTO deleteditems SET ";
2098 foreach my $key ( keys %$data ) {
2099 next if ( $key eq 'timestamp' ); # timestamp will be set by db
2100 $query .= "$key = ?,";
2101 push( @bind, $data->{$key} );
2104 $sth = $dbh->prepare($query);
2105 $sth->execute(@bind);
2107 # delete from items table
2108 $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
2109 my $deleted = $sth->execute($itemnum);
2110 return ( $deleted == 1 ) ? 1 : 0;
2113 =head2 _marc_from_item_hash
2115 my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
2117 Given an item hash representing a complete item record,
2118 create a C<MARC::Record> object containing an embedded
2119 tag representing that item.
2121 The third, optional parameter C<$unlinked_item_subfields> is
2122 an arrayref of subfields (not mapped to C<items> fields per the
2123 framework) to be added to the MARC representation
2128 sub _marc_from_item_hash {
2130 my $frameworkcode = shift;
2131 my $unlinked_item_subfields;
2133 $unlinked_item_subfields = shift;
2136 # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
2137 # Also, don't emit a subfield if the underlying field is blank.
2138 my $mungeditem = { map { (defined($item->{$_}) and $item->{$_} ne '') ?
2139 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
2140 : () } keys %{ $item } };
2142 my $item_marc = MARC::Record->new();
2143 foreach my $item_field ( keys %{$mungeditem} ) {
2144 my ( $tag, $subfield ) = GetMarcFromKohaField( $item_field, $frameworkcode );
2145 next unless defined $tag and defined $subfield; # skip if not mapped to MARC field
2146 my @values = split(/\s?\|\s?/, $mungeditem->{$item_field}, -1);
2147 foreach my $value (@values){
2148 if ( my $field = $item_marc->field($tag) ) {
2149 $field->add_subfields( $subfield => $value );
2151 my $add_subfields = [];
2152 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2153 $add_subfields = $unlinked_item_subfields;
2155 $item_marc->add_fields( $tag, " ", " ", $subfield => $value, @$add_subfields );
2163 =head2 _repack_item_errors
2165 Add an error message hash generated by C<CheckItemPreSave>
2166 to a list of errors.
2170 sub _repack_item_errors {
2171 my $item_sequence_num = shift;
2172 my $item_ref = shift;
2173 my $error_ref = shift;
2175 my @repacked_errors = ();
2177 foreach my $error_code (sort keys %{ $error_ref }) {
2178 my $repacked_error = {};
2179 $repacked_error->{'item_sequence'} = $item_sequence_num;
2180 $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
2181 $repacked_error->{'error_code'} = $error_code;
2182 $repacked_error->{'error_information'} = $error_ref->{$error_code};
2183 push @repacked_errors, $repacked_error;
2186 return @repacked_errors;
2189 =head2 _get_unlinked_item_subfields
2191 my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
2195 sub _get_unlinked_item_subfields {
2196 my $original_item_marc = shift;
2197 my $frameworkcode = shift;
2199 my $marcstructure = GetMarcStructure(1, $frameworkcode, { unsafe => 1 });
2201 # assume that this record has only one field, and that that
2202 # field contains only the item information
2204 my @fields = $original_item_marc->fields();
2205 if ($#fields > -1) {
2206 my $field = $fields[0];
2207 my $tag = $field->tag();
2208 foreach my $subfield ($field->subfields()) {
2209 if (defined $subfield->[1] and
2210 $subfield->[1] ne '' and
2211 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
2212 push @$subfields, $subfield->[0] => $subfield->[1];
2219 =head2 _get_unlinked_subfields_xml
2221 my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
2225 sub _get_unlinked_subfields_xml {
2226 my $unlinked_item_subfields = shift;
2229 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2230 my $marc = MARC::Record->new();
2231 # use of tag 999 is arbitrary, and doesn't need to match the item tag
2232 # used in the framework
2233 $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
2234 $marc->encoding("UTF-8");
2235 $xml = $marc->as_xml("USMARC");
2241 =head2 _parse_unlinked_item_subfields_from_xml
2243 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2247 sub _parse_unlinked_item_subfields_from_xml {
2249 require C4::Charset;
2250 return unless defined $xml and $xml ne "";
2251 my $marc = MARC::Record->new_from_xml(C4::Charset::StripNonXmlChars($xml),'UTF-8');
2252 my $unlinked_subfields = [];
2253 my @fields = $marc->fields();
2254 if ($#fields > -1) {
2255 foreach my $subfield ($fields[0]->subfields()) {
2256 push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2259 return $unlinked_subfields;
2262 =head2 GetAnalyticsCount
2264 $count= &GetAnalyticsCount($itemnumber)
2266 counts Usage of itemnumber in Analytical bibliorecords.
2270 sub GetAnalyticsCount {
2271 my ($itemnumber) = @_;
2273 ### ZOOM search here
2275 $query= "hi=".$itemnumber;
2276 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
2277 my ($err,$res,$result) = $searcher->simple_search_compat($query,0,10);
2281 =head2 SearchItemsByField
2283 my $items = SearchItemsByField($field, $value);
2285 SearchItemsByField will search for items on a specific given field.
2286 For instance you can search all items with a specific stocknumber like this:
2288 my $items = SearchItemsByField('stocknumber', $stocknumber);
2292 sub SearchItemsByField {
2293 my ($field, $value) = @_;
2300 my ($results) = SearchItems($filters);
2304 sub _SearchItems_build_where_fragment {
2307 my $dbh = C4::Context->dbh;
2310 if (exists($filter->{conjunction})) {
2311 my (@where_strs, @where_args);
2312 foreach my $f (@{ $filter->{filters} }) {
2313 my $fragment = _SearchItems_build_where_fragment($f);
2315 push @where_strs, $fragment->{str};
2316 push @where_args, @{ $fragment->{args} };
2321 $where_str = '(' . join (' ' . $filter->{conjunction} . ' ', @where_strs) . ')';
2324 args => \@where_args,
2328 my @columns = Koha::Database->new()->schema()->resultset('Item')->result_source->columns;
2329 push @columns, Koha::Database->new()->schema()->resultset('Biblio')->result_source->columns;
2330 push @columns, Koha::Database->new()->schema()->resultset('Biblioitem')->result_source->columns;
2331 my @operators = qw(= != > < >= <= like);
2332 my $field = $filter->{field};
2333 if ( (0 < grep /^$field$/, @columns) or (substr($field, 0, 5) eq 'marc:') ) {
2334 my $op = $filter->{operator};
2335 my $query = $filter->{query};
2337 if (!$op or (0 == grep /^$op$/, @operators)) {
2338 $op = '='; # default operator
2342 if ($field =~ /^marc:(\d{3})(?:\$(\w))?$/) {
2344 my $marcsubfield = $2;
2345 my ($kohafield) = $dbh->selectrow_array(q|
2346 SELECT kohafield FROM marc_subfield_structure
2347 WHERE tagfield=? AND tagsubfield=? AND frameworkcode=''
2348 |, undef, $marcfield, $marcsubfield);
2351 $column = $kohafield;
2353 # MARC field is not linked to a DB field so we need to use
2354 # ExtractValue on marcxml from biblio_metadata or
2355 # items.more_subfields_xml, depending on the MARC field.
2358 my ($itemfield) = GetMarcFromKohaField('items.itemnumber');
2359 if ($marcfield eq $itemfield) {
2360 $sqlfield = 'more_subfields_xml';
2361 $xpath = '//record/datafield/subfield[@code="' . $marcsubfield . '"]';
2363 $sqlfield = 'metadata'; # From biblio_metadata
2364 if ($marcfield < 10) {
2365 $xpath = "//record/controlfield[\@tag=\"$marcfield\"]";
2367 $xpath = "//record/datafield[\@tag=\"$marcfield\"]/subfield[\@code=\"$marcsubfield\"]";
2370 $column = "ExtractValue($sqlfield, '$xpath')";
2376 if (ref $query eq 'ARRAY') {
2379 } elsif ($op eq '!=') {
2383 str => "$column $op (" . join (',', ('?') x @$query) . ")",
2388 str => "$column $op ?",
2395 return $where_fragment;
2400 my ($items, $total) = SearchItems($filter, $params);
2402 Perform a search among items
2404 $filter is a reference to a hash which can be a filter, or a combination of filters.
2406 A filter has the following keys:
2410 =item * field: the name of a SQL column in table items
2412 =item * query: the value to search in this column
2414 =item * operator: comparison operator. Can be one of = != > < >= <= like
2418 A combination of filters hash the following keys:
2422 =item * conjunction: 'AND' or 'OR'
2424 =item * filters: array ref of filters
2428 $params is a reference to a hash that can contain the following parameters:
2432 =item * rows: Number of items to return. 0 returns everything (default: 0)
2434 =item * page: Page to return (return items from (page-1)*rows to (page*rows)-1)
2437 =item * sortby: A SQL column name in items table to sort on
2439 =item * sortorder: 'ASC' or 'DESC'
2446 my ($filter, $params) = @_;
2450 return unless ref $filter eq 'HASH';
2451 return unless ref $params eq 'HASH';
2453 # Default parameters
2454 $params->{rows} ||= 0;
2455 $params->{page} ||= 1;
2456 $params->{sortby} ||= 'itemnumber';
2457 $params->{sortorder} ||= 'ASC';
2459 my ($where_str, @where_args);
2460 my $where_fragment = _SearchItems_build_where_fragment($filter);
2461 if ($where_fragment) {
2462 $where_str = $where_fragment->{str};
2463 @where_args = @{ $where_fragment->{args} };
2466 my $dbh = C4::Context->dbh;
2468 SELECT SQL_CALC_FOUND_ROWS items.*
2470 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2471 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
2472 LEFT JOIN biblio_metadata ON biblio_metadata.biblionumber = biblio.biblionumber
2475 if (defined $where_str and $where_str ne '') {
2476 $query .= qq{ AND $where_str };
2479 $query .= q{ AND biblio_metadata.format = 'marcxml' AND biblio_metadata.marcflavour = ? };
2480 push @where_args, C4::Context->preference('marcflavour');
2482 my @columns = Koha::Database->new()->schema()->resultset('Item')->result_source->columns;
2483 push @columns, Koha::Database->new()->schema()->resultset('Biblio')->result_source->columns;
2484 push @columns, Koha::Database->new()->schema()->resultset('Biblioitem')->result_source->columns;
2485 my $sortby = (0 < grep {$params->{sortby} eq $_} @columns)
2486 ? $params->{sortby} : 'itemnumber';
2487 my $sortorder = (uc($params->{sortorder}) eq 'ASC') ? 'ASC' : 'DESC';
2488 $query .= qq{ ORDER BY $sortby $sortorder };
2490 my $rows = $params->{rows};
2493 my $offset = $rows * ($params->{page}-1);
2494 $query .= qq { LIMIT ?, ? };
2495 push @limit_args, $offset, $rows;
2498 my $sth = $dbh->prepare($query);
2499 my $rv = $sth->execute(@where_args, @limit_args);
2501 return unless ($rv);
2502 my ($total_rows) = $dbh->selectrow_array(q{ SELECT FOUND_ROWS() });
2504 return ($sth->fetchall_arrayref({}), $total_rows);
2508 =head1 OTHER FUNCTIONS
2512 ($indicators, $value) = _find_value($tag, $subfield, $record,$encoding);
2514 Find the given $subfield in the given $tag in the given
2515 MARC::Record $record. If the subfield is found, returns
2516 the (indicators, value) pair; otherwise, (undef, undef) is
2520 Such a function is used in addbiblio AND additem and serial-edit and maybe could be used in Authorities.
2521 I suggest we export it from this module.
2526 my ( $tagfield, $insubfield, $record, $encoding ) = @_;
2529 if ( $tagfield < 10 ) {
2530 if ( $record->field($tagfield) ) {
2531 push @result, $record->field($tagfield)->data();
2536 foreach my $field ( $record->field($tagfield) ) {
2537 my @subfields = $field->subfields();
2538 foreach my $subfield (@subfields) {
2539 if ( @$subfield[0] eq $insubfield ) {
2540 push @result, @$subfield[1];
2541 $indicator = $field->indicator(1) . $field->indicator(2);
2546 return ( $indicator, @result );
2550 =head2 PrepareItemrecordDisplay
2552 PrepareItemrecordDisplay($itemrecord,$bibnum,$itemumber,$frameworkcode);
2554 Returns a hash with all the fields for Display a given item data in a template
2556 The $frameworkcode returns the item for the given frameworkcode, ONLY if bibnum is not provided
2560 sub PrepareItemrecordDisplay {
2562 my ( $bibnum, $itemnum, $defaultvalues, $frameworkcode ) = @_;
2564 my $dbh = C4::Context->dbh;
2565 $frameworkcode = &GetFrameworkCode($bibnum) if $bibnum;
2566 my ( $itemtagfield, $itemtagsubfield ) = &GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
2568 # Note: $tagslib obtained from GetMarcStructure() in 'unsafe' mode is
2569 # a shared data structure. No plugin (including custom ones) should change
2570 # its contents. See also GetMarcStructure.
2571 my $tagslib = &GetMarcStructure( 1, $frameworkcode, { unsafe => 1 } );
2573 # return nothing if we don't have found an existing framework.
2574 return q{} unless $tagslib;
2577 $itemrecord = C4::Items::GetMarcItem( $bibnum, $itemnum );
2581 my $branch_limit = C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
2583 SELECT authorised_value,lib FROM authorised_values
2586 LEFT JOIN authorised_values_branches ON ( id = av_id )
2591 $query .= qq{ AND ( branchcode = ? OR branchcode IS NULL )} if $branch_limit;
2592 $query .= qq{ ORDER BY lib};
2593 my $authorised_values_sth = $dbh->prepare( $query );
2594 foreach my $tag ( sort keys %{$tagslib} ) {
2597 # loop through each subfield
2599 foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
2600 next if IsMarcStructureInternal($tagslib->{$tag}{$subfield});
2601 next unless ( $tagslib->{$tag}->{$subfield}->{'tab'} );
2602 next if ( $tagslib->{$tag}->{$subfield}->{'tab'} ne "10" );
2604 $subfield_data{tag} = $tag;
2605 $subfield_data{subfield} = $subfield;
2606 $subfield_data{countsubfield} = $cntsubf++;
2607 $subfield_data{kohafield} = $tagslib->{$tag}->{$subfield}->{'kohafield'};
2608 $subfield_data{id} = "tag_".$tag."_subfield_".$subfield."_".int(rand(1000000));
2610 # $subfield_data{marc_lib}=$tagslib->{$tag}->{$subfield}->{lib};
2611 $subfield_data{marc_lib} = $tagslib->{$tag}->{$subfield}->{lib};
2612 $subfield_data{mandatory} = $tagslib->{$tag}->{$subfield}->{mandatory};
2613 $subfield_data{repeatable} = $tagslib->{$tag}->{$subfield}->{repeatable};
2614 $subfield_data{hidden} = "display:none"
2615 if ( ( $tagslib->{$tag}->{$subfield}->{hidden} > 4 )
2616 || ( $tagslib->{$tag}->{$subfield}->{hidden} < -4 ) );
2617 my ( $x, $defaultvalue );
2619 ( $x, $defaultvalue ) = _find_value( $tag, $subfield, $itemrecord );
2621 $defaultvalue = $tagslib->{$tag}->{$subfield}->{defaultvalue} unless $defaultvalue;
2622 if ( !defined $defaultvalue ) {
2623 $defaultvalue = q||;
2625 $defaultvalue =~ s/"/"/g;
2628 # search for itemcallnumber if applicable
2629 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.itemcallnumber'
2630 && C4::Context->preference('itemcallnumber') ) {
2631 my $CNtag = substr( C4::Context->preference('itemcallnumber'), 0, 3 );
2632 my $CNsubfield = substr( C4::Context->preference('itemcallnumber'), 3, 1 );
2633 if ( $itemrecord and my $field = $itemrecord->field($CNtag) ) {
2634 $defaultvalue = $field->subfield($CNsubfield);
2637 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.itemcallnumber'
2639 && $defaultvalues->{'callnumber'} ) {
2640 if( $itemrecord and $defaultvalues and not $itemrecord->subfield($tag,$subfield) ){
2641 # if the item record exists, only use default value if the item has no callnumber
2642 $defaultvalue = $defaultvalues->{callnumber};
2643 } elsif ( !$itemrecord and $defaultvalues ) {
2644 # if the item record *doesn't* exists, always use the default value
2645 $defaultvalue = $defaultvalues->{callnumber};
2648 if ( ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.holdingbranch' || $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.homebranch' )
2650 && $defaultvalues->{'branchcode'} ) {
2651 if ( $itemrecord and $defaultvalues and not $itemrecord->subfield($tag,$subfield) ) {
2652 $defaultvalue = $defaultvalues->{branchcode};
2655 if ( ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.location' )
2657 && $defaultvalues->{'location'} ) {
2659 if ( $itemrecord and $defaultvalues and not $itemrecord->subfield($tag,$subfield) ) {
2660 # if the item record exists, only use default value if the item has no locationr
2661 $defaultvalue = $defaultvalues->{location};
2662 } elsif ( !$itemrecord and $defaultvalues ) {
2663 # if the item record *doesn't* exists, always use the default value
2664 $defaultvalue = $defaultvalues->{location};
2667 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
2668 my @authorised_values;
2671 # builds list, depending on authorised value...
2673 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
2674 if ( ( C4::Context->preference("IndependentBranches") )
2675 && !C4::Context->IsSuperLibrarian() ) {
2676 my $sth = $dbh->prepare( "SELECT branchcode,branchname FROM branches WHERE branchcode = ? ORDER BY branchname" );
2677 $sth->execute( C4::Context->userenv->{branch} );
2678 push @authorised_values, ""
2679 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2680 while ( my ( $branchcode, $branchname ) = $sth->fetchrow_array ) {
2681 push @authorised_values, $branchcode;
2682 $authorised_lib{$branchcode} = $branchname;
2685 my $sth = $dbh->prepare( "SELECT branchcode,branchname FROM branches ORDER BY branchname" );
2687 push @authorised_values, ""
2688 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2689 while ( my ( $branchcode, $branchname ) = $sth->fetchrow_array ) {
2690 push @authorised_values, $branchcode;
2691 $authorised_lib{$branchcode} = $branchname;
2695 $defaultvalue = C4::Context->userenv ? C4::Context->userenv->{branch} : undef;
2696 if ( $defaultvalues and $defaultvalues->{branchcode} ) {
2697 $defaultvalue = $defaultvalues->{branchcode};
2701 } elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "itemtypes" ) {
2702 my $itemtypes = Koha::ItemTypes->search_with_localization;
2703 push @authorised_values, ""
2704 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2705 while ( my $itemtype = $itemtypes->next ) {
2706 push @authorised_values, $itemtype->itemtype;
2707 $authorised_lib{$itemtype->itemtype} = $itemtype->translated_description;
2709 if ($defaultvalues && $defaultvalues->{'itemtype'}) {
2710 $defaultvalue = $defaultvalues->{'itemtype'};
2714 } elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "cn_source" ) {
2715 push @authorised_values, "" unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2717 my $class_sources = GetClassSources();
2718 my $default_source = C4::Context->preference("DefaultClassificationSource");
2720 foreach my $class_source (sort keys %$class_sources) {
2721 next unless $class_sources->{$class_source}->{'used'} or
2722 ($class_source eq $default_source);
2723 push @authorised_values, $class_source;
2724 $authorised_lib{$class_source} = $class_sources->{$class_source}->{'description'};
2727 $defaultvalue = $default_source;
2729 #---- "true" authorised value
2731 $authorised_values_sth->execute(
2732 $tagslib->{$tag}->{$subfield}->{authorised_value},
2733 $branch_limit ? $branch_limit : ()
2735 push @authorised_values, ""
2736 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2737 while ( my ( $value, $lib ) = $authorised_values_sth->fetchrow_array ) {
2738 push @authorised_values, $value;
2739 $authorised_lib{$value} = $lib;
2742 $subfield_data{marc_value} = {
2744 values => \@authorised_values,
2745 default => "$defaultvalue",
2746 labels => \%authorised_lib,
2748 } elsif ( $tagslib->{$tag}->{$subfield}->{value_builder} ) {
2750 require Koha::FrameworkPlugin;
2751 my $plugin = Koha::FrameworkPlugin->new({
2752 name => $tagslib->{$tag}->{$subfield}->{value_builder},
2755 my $pars = { dbh => $dbh, record => undef, tagslib =>$tagslib, id => $subfield_data{id}, tabloop => undef };
2756 $plugin->build( $pars );
2757 if ( $itemrecord and my $field = $itemrecord->field($tag) ) {
2758 $defaultvalue = $field->subfield($subfield);
2760 if( !$plugin->errstr ) {
2761 #TODO Move html to template; see report 12176/13397
2762 my $tab= $plugin->noclick? '-1': '';
2763 my $class= $plugin->noclick? ' disabled': '';
2764 my $title= $plugin->noclick? 'No popup': 'Tag editor';
2765 $subfield_data{marc_value} = qq[<input type="text" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" maxlength="255" value="$defaultvalue" /><a href="#" id="buttonDot_$subfield_data{id}" tabindex="$tab" class="buttonDot $class" title="$title">...</a>\n].$plugin->javascript;
2767 warn $plugin->errstr;
2768 $subfield_data{marc_value} = qq(<input type="text" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" maxlength="255" value="$defaultvalue" />); # supply default input form
2771 elsif ( $tag eq '' ) { # it's an hidden field
2772 $subfield_data{marc_value} = qq(<input type="hidden" tabindex="1" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" maxlength="255" value="$defaultvalue" />);
2774 elsif ( $tagslib->{$tag}->{$subfield}->{'hidden'} ) { # FIXME: shouldn't input type be "hidden" ?
2775 $subfield_data{marc_value} = qq(<input type="text" tabindex="1" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" maxlength="255" value="$defaultvalue" />);
2777 elsif ( length($defaultvalue) > 100
2778 or (C4::Context->preference("marcflavour") eq "UNIMARC" and
2779 300 <= $tag && $tag < 400 && $subfield eq 'a' )
2780 or (C4::Context->preference("marcflavour") eq "MARC21" and
2781 500 <= $tag && $tag < 600 )
2783 # oversize field (textarea)
2784 $subfield_data{marc_value} = qq(<textarea tabindex="1" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" maxlength="255">$defaultvalue</textarea>\n");
2786 $subfield_data{marc_value} = "<input type=\"text\" name=\"field_value\" value=\"$defaultvalue\" size=\"50\" maxlength=\"255\" />";
2788 push( @loop_data, \%subfield_data );
2793 if ( $itemrecord && $itemrecord->field($itemtagfield) ) {
2794 $itemnumber = $itemrecord->subfield( $itemtagfield, $itemtagsubfield );
2797 'itemtagfield' => $itemtagfield,
2798 'itemtagsubfield' => $itemtagsubfield,
2799 'itemnumber' => $itemnumber,
2800 'iteminformation' => \@loop_data
2804 sub ToggleNewStatus {
2805 my ( $params ) = @_;
2806 my @rules = @{ $params->{rules} };
2807 my $report_only = $params->{report_only};
2809 my $dbh = C4::Context->dbh;
2811 my @item_columns = map { "items.$_" } Koha::Items->columns;
2812 my @biblioitem_columns = map { "biblioitems.$_" } Koha::Biblioitems->columns;
2814 for my $rule ( @rules ) {
2815 my $age = $rule->{age};
2816 my $conditions = $rule->{conditions};
2817 my $substitutions = $rule->{substitutions};
2821 SELECT items.biblionumber, items.itemnumber
2823 LEFT JOIN biblioitems ON biblioitems.biblionumber = items.biblionumber
2826 for my $condition ( @$conditions ) {
2828 grep {/^$condition->{field}$/} @item_columns
2829 or grep {/^$condition->{field}$/} @biblioitem_columns
2831 if ( $condition->{value} =~ /\|/ ) {
2832 my @values = split /\|/, $condition->{value};
2833 $query .= qq| AND $condition->{field} IN (|
2834 . join( ',', ('?') x scalar @values )
2836 push @params, @values;
2838 $query .= qq| AND $condition->{field} = ?|;
2839 push @params, $condition->{value};
2843 if ( defined $age ) {
2844 $query .= q| AND TO_DAYS(NOW()) - TO_DAYS(dateaccessioned) >= ? |;
2847 my $sth = $dbh->prepare($query);
2848 $sth->execute( @params );
2849 while ( my $values = $sth->fetchrow_hashref ) {
2850 my $biblionumber = $values->{biblionumber};
2851 my $itemnumber = $values->{itemnumber};
2852 my $item = C4::Items::GetItem( $itemnumber );
2853 for my $substitution ( @$substitutions ) {
2854 next unless $substitution->{field};
2855 C4::Items::ModItem( {$substitution->{field} => $substitution->{value}}, $biblionumber, $itemnumber )
2856 unless $report_only;
2857 push @{ $report->{$itemnumber} }, $substitution;