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
28 use C4::Dates qw/format_date format_date_in_iso/;
32 use List::MoreUtils qw/any/;
34 use DateTime::Format::MySQL;
35 use Data::Dumper; # used as part of logging item record changes, not just for
36 # debugging; so please don't remove this
37 use Koha::DateUtils qw/dt_from_string/;
41 use vars qw($VERSION @ISA @EXPORT);
44 $VERSION = 3.07.00.049;
47 @ISA = qw( Exporter );
70 GetItemsByBiblioitemnumber
74 GetItemnumbersForBiblio
76 get_hostitemnumbers_of
77 GetItemnumberFromBarcode
78 GetBarcodeFromItemnumber
93 PrepareItemrecordDisplay
100 C4::Items - item management functions
104 This module contains an API for manipulating item
105 records in Koha, and is used by cataloguing, circulation,
106 acquisitions, and serials management.
108 A Koha item record is stored in two places: the
109 items table and embedded in a MARC tag in the XML
110 version of the associated bib record in C<biblioitems.marcxml>.
111 This is done to allow the item information to be readily
112 indexed (e.g., by Zebra), but means that each item
113 modification transaction must keep the items table
114 and the MARC XML in sync at all times.
116 Consequently, all code that creates, modifies, or deletes
117 item records B<must> use an appropriate function from
118 C<C4::Items>. If no existing function is suitable, it is
119 better to add one to C<C4::Items> than to use add
120 one-off SQL statements to add or modify items.
122 The items table will be considered authoritative. In other
123 words, if there is ever a discrepancy between the items
124 table and the MARC XML, the items table should be considered
127 =head1 HISTORICAL NOTE
129 Most of the functions in C<C4::Items> were originally in
130 the C<C4::Biblio> module.
132 =head1 CORE EXPORTED FUNCTIONS
134 The following functions are meant for use by users
141 $item = GetItem($itemnumber,$barcode,$serial);
143 Return item information, for a given itemnumber or barcode.
144 The return value is a hashref mapping item column
145 names to values. If C<$serial> is true, include serial publication data.
150 my ($itemnumber,$barcode, $serial) = @_;
151 my $dbh = C4::Context->dbh;
155 my $sth = $dbh->prepare("
157 WHERE itemnumber = ?");
158 $sth->execute($itemnumber);
159 $data = $sth->fetchrow_hashref;
161 my $sth = $dbh->prepare("
165 $sth->execute($barcode);
166 $data = $sth->fetchrow_hashref;
169 return unless ( $data );
172 my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=?");
173 $ssth->execute($data->{'itemnumber'}) ;
174 ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
176 #if we don't have an items.itype, use biblioitems.itemtype.
177 # FIXME this should respect the itypes systempreference
178 # if (C4::Context->preference('item-level_itypes')) {
179 if( ! $data->{'itype'} ) {
180 my $sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
181 $sth->execute($data->{'biblionumber'});
182 ($data->{'itype'}) = $sth->fetchrow_array;
189 CartToShelf($itemnumber);
191 Set the current shelving location of the item record
192 to its stored permanent shelving location. This is
193 primarily used to indicate when an item whose current
194 location is a special processing ('PROC') or shelving cart
195 ('CART') location is back in the stacks.
200 my ( $itemnumber ) = @_;
202 unless ( $itemnumber ) {
203 croak "FAILED CartToShelf() - no itemnumber supplied";
206 my $item = GetItem($itemnumber);
207 if ( $item->{location} eq 'CART' ) {
208 $item->{location} = $item->{permanent_location};
209 ModItem($item, undef, $itemnumber);
215 ShelfToCart($itemnumber);
217 Set the current shelving location of the item
218 to shelving cart ('CART').
223 my ( $itemnumber ) = @_;
225 unless ( $itemnumber ) {
226 croak "FAILED ShelfToCart() - no itemnumber supplied";
229 my $item = GetItem($itemnumber);
230 $item->{'location'} = 'CART';
231 ModItem($item, undef, $itemnumber);
234 =head2 AddItemFromMarc
236 my ($biblionumber, $biblioitemnumber, $itemnumber)
237 = AddItemFromMarc($source_item_marc, $biblionumber);
239 Given a MARC::Record object containing an embedded item
240 record and a biblionumber, create a new item record.
244 sub AddItemFromMarc {
245 my ( $source_item_marc, $biblionumber ) = @_;
246 my $dbh = C4::Context->dbh;
248 # parse item hash from MARC
249 my $frameworkcode = GetFrameworkCode( $biblionumber );
250 my ($itemtag,$itemsubfield)=GetMarcFromKohaField("items.itemnumber",$frameworkcode);
252 my $localitemmarc=MARC::Record->new;
253 $localitemmarc->append_fields($source_item_marc->field($itemtag));
254 my $item = &TransformMarcToKoha( $dbh, $localitemmarc, $frameworkcode ,'items');
255 my $unlinked_item_subfields = _get_unlinked_item_subfields($localitemmarc, $frameworkcode);
256 return AddItem($item, $biblionumber, $dbh, $frameworkcode, $unlinked_item_subfields);
261 my ($biblionumber, $biblioitemnumber, $itemnumber)
262 = AddItem($item, $biblionumber[, $dbh, $frameworkcode, $unlinked_item_subfields]);
264 Given a hash containing item column names as keys,
265 create a new Koha item record.
267 The first two optional parameters (C<$dbh> and C<$frameworkcode>)
268 do not need to be supplied for general use; they exist
269 simply to allow them to be picked up from AddItemFromMarc.
271 The final optional parameter, C<$unlinked_item_subfields>, contains
272 an arrayref containing subfields present in the original MARC
273 representation of the item (e.g., from the item editor) that are
274 not mapped to C<items> columns directly but should instead
275 be stored in C<items.more_subfields_xml> and included in
276 the biblio items tag for display and indexing.
282 my $biblionumber = shift;
284 my $dbh = @_ ? shift : C4::Context->dbh;
285 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
286 my $unlinked_item_subfields;
288 $unlinked_item_subfields = shift
291 # needs old biblionumber and biblioitemnumber
292 $item->{'biblionumber'} = $biblionumber;
293 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
294 $sth->execute( $item->{'biblionumber'} );
295 ($item->{'biblioitemnumber'}) = $sth->fetchrow;
297 _set_defaults_for_add($item);
298 _set_derived_columns_for_add($item);
299 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
300 # FIXME - checks here
301 unless ( $item->{itype} ) { # default to biblioitem.itemtype if no itype
302 my $itype_sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
303 $itype_sth->execute( $item->{'biblionumber'} );
304 ( $item->{'itype'} ) = $itype_sth->fetchrow_array;
307 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
308 $item->{'itemnumber'} = $itemnumber;
310 ModZebra( $item->{biblionumber}, "specialUpdate", "biblioserver" );
312 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
314 return ($item->{biblionumber}, $item->{biblioitemnumber}, $itemnumber);
317 =head2 AddItemBatchFromMarc
319 ($itemnumber_ref, $error_ref) = AddItemBatchFromMarc($record,
320 $biblionumber, $biblioitemnumber, $frameworkcode);
322 Efficiently create item records from a MARC biblio record with
323 embedded item fields. This routine is suitable for batch jobs.
325 This API assumes that the bib record has already been
326 saved to the C<biblio> and C<biblioitems> tables. It does
327 not expect that C<biblioitems.marc> and C<biblioitems.marcxml>
328 are populated, but it will do so via a call to ModBibiloMarc.
330 The goal of this API is to have a similar effect to using AddBiblio
331 and AddItems in succession, but without inefficient repeated
332 parsing of the MARC XML bib record.
334 This function returns an arrayref of new itemsnumbers and an arrayref of item
335 errors encountered during the processing. Each entry in the errors
336 list is a hashref containing the following keys:
342 Sequence number of original item tag in the MARC record.
346 Item barcode, provide to assist in the construction of
347 useful error messages.
351 Code representing the error condition. Can be 'duplicate_barcode',
352 'invalid_homebranch', or 'invalid_holdingbranch'.
354 =item error_information
356 Additional information appropriate to the error condition.
362 sub AddItemBatchFromMarc {
363 my ($record, $biblionumber, $biblioitemnumber, $frameworkcode) = @_;
365 my @itemnumbers = ();
367 my $dbh = C4::Context->dbh;
369 # We modify the record, so lets work on a clone so we don't change the
371 $record = $record->clone();
372 # loop through the item tags and start creating items
373 my @bad_item_fields = ();
374 my ($itemtag, $itemsubfield) = &GetMarcFromKohaField("items.itemnumber",'');
375 my $item_sequence_num = 0;
376 ITEMFIELD: foreach my $item_field ($record->field($itemtag)) {
377 $item_sequence_num++;
378 # we take the item field and stick it into a new
379 # MARC record -- this is required so far because (FIXME)
380 # TransformMarcToKoha requires a MARC::Record, not a MARC::Field
381 # and there is no TransformMarcFieldToKoha
382 my $temp_item_marc = MARC::Record->new();
383 $temp_item_marc->append_fields($item_field);
385 # add biblionumber and biblioitemnumber
386 my $item = TransformMarcToKoha( $dbh, $temp_item_marc, $frameworkcode, 'items' );
387 my $unlinked_item_subfields = _get_unlinked_item_subfields($temp_item_marc, $frameworkcode);
388 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
389 $item->{'biblionumber'} = $biblionumber;
390 $item->{'biblioitemnumber'} = $biblioitemnumber;
392 # check for duplicate barcode
393 my %item_errors = CheckItemPreSave($item);
395 push @errors, _repack_item_errors($item_sequence_num, $item, \%item_errors);
396 push @bad_item_fields, $item_field;
400 _set_defaults_for_add($item);
401 _set_derived_columns_for_add($item);
402 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
403 warn $error if $error;
404 push @itemnumbers, $itemnumber; # FIXME not checking error
405 $item->{'itemnumber'} = $itemnumber;
407 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
409 my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
410 $item_field->replace_with($new_item_marc->field($itemtag));
413 # remove any MARC item fields for rejected items
414 foreach my $item_field (@bad_item_fields) {
415 $record->delete_field($item_field);
418 # update the MARC biblio
419 # $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode );
421 return (\@itemnumbers, \@errors);
424 =head2 ModItemFromMarc
426 ModItemFromMarc($item_marc, $biblionumber, $itemnumber);
428 This function updates an item record based on a supplied
429 C<MARC::Record> object containing an embedded item field.
430 This API is meant for the use of C<additem.pl>; for
431 other purposes, C<ModItem> should be used.
433 This function uses the hash %default_values_for_mod_from_marc,
434 which contains default values for item fields to
435 apply when modifying an item. This is needed beccause
436 if an item field's value is cleared, TransformMarcToKoha
437 does not include the column in the
438 hash that's passed to ModItem, which without
439 use of this hash makes it impossible to clear
440 an item field's value. See bug 2466.
442 Note that only columns that can be directly
443 changed from the cataloging and serials
444 item editors are included in this hash.
450 our %default_values_for_mod_from_marc;
452 sub _build_default_values_for_mod_marc {
453 my ($frameworkcode) = @_;
454 return $default_values_for_mod_from_marc{$frameworkcode}
455 if exists $default_values_for_mod_from_marc{$frameworkcode};
456 my $marc_structure = C4::Biblio::GetMarcStructure( 1, $frameworkcode );
457 my $default_values = {
459 booksellerid => undef,
461 'items.cn_source' => undef,
462 coded_location_qualifier => undef,
466 holdingbranch => undef,
468 itemcallnumber => undef,
471 itemnotes_nonpublic => undef,
474 permanent_location => undef,
477 # paidfor => undef, # commented, see bug 12817
479 replacementprice => undef,
480 replacementpricedate => undef,
483 stocknumber => undef,
487 while ( my ( $field, $default_value ) = each %$default_values ) {
488 my $kohafield = $field;
489 $kohafield =~ s|^([^\.]+)$|items.$1|;
490 $default_values_for_mod_from_marc{$frameworkcode}{$field} =
492 if C4::Koha::IsKohaFieldLinked(
493 { kohafield => $kohafield, frameworkcode => $frameworkcode } );
495 return $default_values_for_mod_from_marc{$frameworkcode};
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( $dbh, $localitemmarc, $frameworkcode, 'items' );
510 my $default_values = _build_default_values_for_mod_marc();
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 = C4::Dates->new();
652 ModItem({ itemlost => 0, datelastseen => $today->output("iso") }, 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 # get the MARC record
680 my $record = GetMarcBiblio($biblionumber);
681 ModZebra( $biblionumber, "specialUpdate", "biblioserver" );
683 #search item field code
684 logaction("CATALOGUING", "DELETE", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
688 =head2 CheckItemPreSave
690 my $item_ref = TransformMarcToKoha($marc, 'items');
692 my %errors = CheckItemPreSave($item_ref);
693 if (exists $errors{'duplicate_barcode'}) {
694 print "item has duplicate barcode: ", $errors{'duplicate_barcode'}, "\n";
695 } elsif (exists $errors{'invalid_homebranch'}) {
696 print "item has invalid home branch: ", $errors{'invalid_homebranch'}, "\n";
697 } elsif (exists $errors{'invalid_holdingbranch'}) {
698 print "item has invalid holding branch: ", $errors{'invalid_holdingbranch'}, "\n";
703 Given a hashref containing item fields, determine if it can be
704 inserted or updated in the database. Specifically, checks for
705 database integrity issues, and returns a hash containing any
706 of the following keys, if applicable.
710 =item duplicate_barcode
712 Barcode, if it duplicates one already found in the database.
714 =item invalid_homebranch
716 Home branch, if not defined in branches table.
718 =item invalid_holdingbranch
720 Holding branch, if not defined in branches table.
724 This function does NOT implement any policy-related checks,
725 e.g., whether current operator is allowed to save an
726 item that has a given branch code.
730 sub CheckItemPreSave {
731 my $item_ref = shift;
736 # check for duplicate barcode
737 if (exists $item_ref->{'barcode'} and defined $item_ref->{'barcode'}) {
738 my $existing_itemnumber = GetItemnumberFromBarcode($item_ref->{'barcode'});
739 if ($existing_itemnumber) {
740 if (!exists $item_ref->{'itemnumber'} # new item
741 or $item_ref->{'itemnumber'} != $existing_itemnumber) { # existing item
742 $errors{'duplicate_barcode'} = $item_ref->{'barcode'};
747 # check for valid home branch
748 if (exists $item_ref->{'homebranch'} and defined $item_ref->{'homebranch'}) {
749 my $branch_name = C4::Branch::GetBranchName($item_ref->{'homebranch'});
750 unless (defined $branch_name) {
751 # relies on fact that branches.branchname is a non-NULL column,
752 # so GetBranchName returns undef only if branch does not exist
753 $errors{'invalid_homebranch'} = $item_ref->{'homebranch'};
757 # check for valid holding branch
758 if (exists $item_ref->{'holdingbranch'} and defined $item_ref->{'holdingbranch'}) {
759 my $branch_name = C4::Branch::GetBranchName($item_ref->{'holdingbranch'});
760 unless (defined $branch_name) {
761 # relies on fact that branches.branchname is a non-NULL column,
762 # so GetBranchName returns undef only if branch does not exist
763 $errors{'invalid_holdingbranch'} = $item_ref->{'holdingbranch'};
771 =head1 EXPORTED SPECIAL ACCESSOR FUNCTIONS
773 The following functions provide various ways of
774 getting an item record, a set of item records, or
775 lists of authorized values for certain item fields.
777 Some of the functions in this group are candidates
778 for refactoring -- for example, some of the code
779 in C<GetItemsByBiblioitemnumber> and C<GetItemsInfo>
780 has copy-and-paste work.
786 $itemstatushash = GetItemStatus($fwkcode);
788 Returns a list of valid values for the
789 C<items.notforloan> field.
791 NOTE: does B<not> return an individual item's
794 Can be MARC dependant.
796 But basically could be can be loan or not
797 Create a status selector with the following code
799 =head3 in PERL SCRIPT
801 my $itemstatushash = getitemstatus;
803 foreach my $thisstatus (keys %$itemstatushash) {
804 my %row =(value => $thisstatus,
805 statusname => $itemstatushash->{$thisstatus}->{'statusname'},
807 push @itemstatusloop, \%row;
809 $template->param(statusloop=>\@itemstatusloop);
813 <select name="statusloop" id="statusloop">
814 <option value="">Default</option>
815 [% FOREACH statusloo IN statusloop %]
816 [% IF ( statusloo.selected ) %]
817 <option value="[% statusloo.value %]" selected="selected">[% statusloo.statusname %]</option>
819 <option value="[% statusloo.value %]">[% statusloo.statusname %]</option>
828 # returns a reference to a hash of references to status...
831 my $dbh = C4::Context->dbh;
833 $fwk = '' unless ($fwk);
834 my ( $tag, $subfield ) =
835 GetMarcFromKohaField( "items.notforloan", $fwk );
836 if ( $tag and $subfield ) {
839 "SELECT authorised_value
840 FROM marc_subfield_structure
846 $sth->execute( $tag, $subfield, $fwk );
847 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
850 "SELECT authorised_value,lib
851 FROM authorised_values
856 $authvalsth->execute($authorisedvaluecat);
857 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
858 $itemstatus{$authorisedvalue} = $lib;
872 $itemstatus{"1"} = "Not For Loan";
876 =head2 GetItemLocation
878 $itemlochash = GetItemLocation($fwk);
880 Returns a list of valid values for the
881 C<items.location> field.
883 NOTE: does B<not> return an individual item's
886 where fwk stands for an optional framework code.
887 Create a location selector with the following code
889 =head3 in PERL SCRIPT
891 my $itemlochash = getitemlocation;
893 foreach my $thisloc (keys %$itemlochash) {
894 my $selected = 1 if $thisbranch eq $branch;
895 my %row =(locval => $thisloc,
896 selected => $selected,
897 locname => $itemlochash->{$thisloc},
899 push @itemlocloop, \%row;
901 $template->param(itemlocationloop => \@itemlocloop);
905 <select name="location">
906 <option value="">Default</option>
907 <!-- TMPL_LOOP name="itemlocationloop" -->
908 <option value="<!-- TMPL_VAR name="locval" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="locname" --></option>
914 sub GetItemLocation {
916 # returns a reference to a hash of references to location...
919 my $dbh = C4::Context->dbh;
921 $fwk = '' unless ($fwk);
922 my ( $tag, $subfield ) =
923 GetMarcFromKohaField( "items.location", $fwk );
924 if ( $tag and $subfield ) {
927 "SELECT authorised_value
928 FROM marc_subfield_structure
933 $sth->execute( $tag, $subfield, $fwk );
934 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
937 "SELECT authorised_value,lib
938 FROM authorised_values
942 $authvalsth->execute($authorisedvaluecat);
943 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
944 $itemlocation{$authorisedvalue} = $lib;
946 return \%itemlocation;
958 $itemlocation{"1"} = "Not For Loan";
959 return \%itemlocation;
964 $items = GetLostItems( $where );
966 This function gets a list of lost items.
972 C<$where> is a hashref. it containts a field of the items table as key
973 and the value to match as value. For example:
975 { barcode => 'abc123',
976 homebranch => 'CPL', }
980 C<$items> is a reference to an array full of hashrefs with columns
981 from the "items" table as keys.
983 =item usage in the perl script:
985 my $where = { barcode => '0001548' };
986 my $items = GetLostItems( $where );
987 $template->param( itemsloop => $items );
994 # Getting input args.
996 my $dbh = C4::Context->dbh;
999 SELECT title, author, lib, itemlost, authorised_value, barcode, datelastseen, price, replacementprice, homebranch,
1000 itype, itemtype, holdingbranch, location, itemnotes, items.biblionumber as biblionumber, itemcallnumber
1002 LEFT JOIN biblio ON (items.biblionumber = biblio.biblionumber)
1003 LEFT JOIN biblioitems ON (items.biblionumber = biblioitems.biblionumber)
1004 LEFT JOIN authorised_values ON (items.itemlost = authorised_values.authorised_value)
1006 authorised_values.category = 'LOST'
1007 AND itemlost IS NOT NULL
1010 my @query_parameters;
1011 foreach my $key (keys %$where) {
1012 $query .= " AND $key LIKE ?";
1013 push @query_parameters, "%$where->{$key}%";
1016 my $sth = $dbh->prepare($query);
1017 $sth->execute( @query_parameters );
1019 while ( my $row = $sth->fetchrow_hashref ){
1025 =head2 GetItemsForInventory
1027 ($itemlist, $iTotalRecords) = GetItemsForInventory( {
1028 minlocation => $minlocation,
1029 maxlocation => $maxlocation,
1030 location => $location,
1031 itemtype => $itemtype,
1032 ignoreissued => $ignoreissued,
1033 datelastseen => $datelastseen,
1034 branchcode => $branchcode,
1038 stautshash => $statushash
1039 interface => $interface,
1042 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
1044 The sub returns a reference to a list of hashes, each containing
1045 itemnumber, author, title, barcode, item callnumber, and date last
1046 seen. It is ordered by callnumber then title.
1048 The required minlocation & maxlocation parameters are used to specify a range of item callnumbers
1049 the datelastseen can be used to specify that you want to see items not seen since a past date only.
1050 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
1051 $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.
1053 $iTotalRecords is the number of rows that would have been returned without the $offset, $size limit clause
1057 sub GetItemsForInventory {
1058 my ( $parameters ) = @_;
1059 my $minlocation = $parameters->{'minlocation'} // '';
1060 my $maxlocation = $parameters->{'maxlocation'} // '';
1061 my $location = $parameters->{'location'} // '';
1062 my $itemtype = $parameters->{'itemtype'} // '';
1063 my $ignoreissued = $parameters->{'ignoreissued'} // '';
1064 my $datelastseen = $parameters->{'datelastseen'} // '';
1065 my $branchcode = $parameters->{'branchcode'} // '';
1066 my $branch = $parameters->{'branch'} // '';
1067 my $offset = $parameters->{'offset'} // '';
1068 my $size = $parameters->{'size'} // '';
1069 my $statushash = $parameters->{'statushash'} // '';
1070 my $interface = $parameters->{'interface'} // '';
1072 my $dbh = C4::Context->dbh;
1073 my ( @bind_params, @where_strings );
1075 my $select_columns = q{
1076 SELECT items.itemnumber, barcode, itemcallnumber, title, author, biblio.biblionumber, biblio.frameworkcode, datelastseen, homebranch, location, notforloan, damaged, itemlost, withdrawn, stocknumber
1078 my $select_count = q{SELECT COUNT(*)};
1081 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
1082 LEFT JOIN biblioitems on items.biblionumber = biblioitems.biblionumber
1085 for my $authvfield (keys %$statushash){
1086 if ( scalar @{$statushash->{$authvfield}} > 0 ){
1087 my $joinedvals = join ',', @{$statushash->{$authvfield}};
1088 push @where_strings, "$authvfield in (" . $joinedvals . ")";
1094 push @where_strings, 'itemcallnumber >= ?';
1095 push @bind_params, $minlocation;
1099 push @where_strings, 'itemcallnumber <= ?';
1100 push @bind_params, $maxlocation;
1103 if ($datelastseen) {
1104 $datelastseen = format_date_in_iso($datelastseen);
1105 push @where_strings, '(datelastseen < ? OR datelastseen IS NULL)';
1106 push @bind_params, $datelastseen;
1110 push @where_strings, 'items.location = ?';
1111 push @bind_params, $location;
1114 if ( $branchcode ) {
1115 if($branch eq "homebranch"){
1116 push @where_strings, 'items.homebranch = ?';
1118 push @where_strings, 'items.holdingbranch = ?';
1120 push @bind_params, $branchcode;
1124 push @where_strings, 'biblioitems.itemtype = ?';
1125 push @bind_params, $itemtype;
1128 if ( $ignoreissued) {
1129 $query .= "LEFT JOIN issues ON items.itemnumber = issues.itemnumber ";
1130 push @where_strings, 'issues.date_due IS NULL';
1133 if ( @where_strings ) {
1135 $query .= join ' AND ', @where_strings;
1137 $query .= ' ORDER BY items.cn_sort, itemcallnumber, title';
1138 my $count_query = $select_count . $query;
1139 $query .= " LIMIT $offset, $size" if ($offset and $size);
1140 $query = $select_columns . $query;
1141 my $sth = $dbh->prepare($query);
1142 $sth->execute( @bind_params );
1145 my $tmpresults = $sth->fetchall_arrayref({});
1146 $sth = $dbh->prepare( $count_query );
1147 $sth->execute( @bind_params );
1148 my ($iTotalRecords) = $sth->fetchrow_array();
1150 my $avmapping = C4::Koha::GetKohaAuthorisedValuesMapping( {
1151 interface => $interface
1153 foreach my $row (@$tmpresults) {
1156 foreach (keys %$row) {
1157 if (defined($avmapping->{"items.$_,".$row->{'frameworkcode'}.",".$row->{$_}})) {
1158 $row->{$_} = $avmapping->{"items.$_,".$row->{'frameworkcode'}.",".$row->{$_}};
1161 push @results, $row;
1164 return (\@results, $iTotalRecords);
1167 =head2 GetItemsCount
1169 $count = &GetItemsCount( $biblionumber);
1171 This function return count of item with $biblionumber
1176 my ( $biblionumber ) = @_;
1177 my $dbh = C4::Context->dbh;
1178 my $query = "SELECT count(*)
1180 WHERE biblionumber=?";
1181 my $sth = $dbh->prepare($query);
1182 $sth->execute($biblionumber);
1183 my $count = $sth->fetchrow;
1187 =head2 GetItemInfosOf
1189 GetItemInfosOf(@itemnumbers);
1193 sub GetItemInfosOf {
1194 my @itemnumbers = @_;
1196 my $itemnumber_values = @itemnumbers ? join( ',', @itemnumbers ) : "''";
1201 WHERE itemnumber IN ($itemnumber_values)
1203 return get_infos_of( $query, 'itemnumber' );
1206 =head2 GetItemsByBiblioitemnumber
1208 GetItemsByBiblioitemnumber($biblioitemnumber);
1210 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1211 Called by C<C4::XISBN>
1215 sub GetItemsByBiblioitemnumber {
1216 my ( $bibitem ) = @_;
1217 my $dbh = C4::Context->dbh;
1218 my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1219 # Get all items attached to a biblioitem
1222 $sth->execute($bibitem) || die $sth->errstr;
1223 while ( my $data = $sth->fetchrow_hashref ) {
1224 # Foreach item, get circulation information
1225 my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1226 WHERE itemnumber = ?
1227 AND issues.borrowernumber = borrowers.borrowernumber"
1229 $sth2->execute( $data->{'itemnumber'} );
1230 if ( my $data2 = $sth2->fetchrow_hashref ) {
1231 # if item is out, set the due date and who it is out too
1232 $data->{'date_due'} = $data2->{'date_due'};
1233 $data->{'cardnumber'} = $data2->{'cardnumber'};
1234 $data->{'borrowernumber'} = $data2->{'borrowernumber'};
1237 # set date_due to blank, so in the template we check itemlost, and withdrawn
1238 $data->{'date_due'} = '';
1240 # Find the last 3 people who borrowed this item.
1241 my $query2 = "SELECT * FROM old_issues, borrowers WHERE itemnumber = ?
1242 AND old_issues.borrowernumber = borrowers.borrowernumber
1243 ORDER BY returndate desc,timestamp desc LIMIT 3";
1244 $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1245 $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1247 while ( my $data2 = $sth2->fetchrow_hashref ) {
1248 $data->{"timestamp$i2"} = $data2->{'timestamp'};
1249 $data->{"card$i2"} = $data2->{'cardnumber'};
1250 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
1253 push(@results,$data);
1260 @results = GetItemsInfo($biblionumber);
1262 Returns information about items with the given biblionumber.
1264 C<GetItemsInfo> returns a list of references-to-hash. Each element
1265 contains a number of keys. Most of them are attributes from the
1266 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
1267 Koha database. Other keys include:
1271 =item C<$data-E<gt>{branchname}>
1273 The name (not the code) of the branch to which the book belongs.
1275 =item C<$data-E<gt>{datelastseen}>
1277 This is simply C<items.datelastseen>, except that while the date is
1278 stored in YYYY-MM-DD format in the database, here it is converted to
1279 DD/MM/YYYY format. A NULL date is returned as C<//>.
1281 =item C<$data-E<gt>{datedue}>
1283 =item C<$data-E<gt>{class}>
1285 This is the concatenation of C<biblioitems.classification>, the book's
1286 Dewey code, and C<biblioitems.subclass>.
1288 =item C<$data-E<gt>{ocount}>
1290 I think this is the number of copies of the book available.
1292 =item C<$data-E<gt>{order}>
1294 If this is set, it is set to C<One Order>.
1301 my ( $biblionumber ) = @_;
1302 my $dbh = C4::Context->dbh;
1303 # note biblioitems.* must be avoided to prevent large marc and marcxml fields from killing performance.
1309 biblioitems.itemtype,
1312 biblioitems.publicationyear,
1313 biblioitems.publishercode,
1314 biblioitems.volumedate,
1315 biblioitems.volumedesc,
1318 items.notforloan as itemnotforloan,
1319 issues.borrowernumber,
1320 issues.date_due as datedue,
1321 issues.onsite_checkout,
1322 borrowers.cardnumber,
1324 borrowers.firstname,
1325 borrowers.branchcode as bcode,
1327 serial.publisheddate,
1328 itemtypes.description,
1329 itemtypes.notforloan as notforloan_per_itemtype,
1332 holding.opac_info as holding_branch_opac_info,
1333 home.opac_info as home_branch_opac_info
1337 LEFT JOIN branches AS holding ON items.holdingbranch = holding.branchcode
1338 LEFT JOIN branches AS home ON items.homebranch=home.branchcode
1339 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1340 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1341 LEFT JOIN issues USING (itemnumber)
1342 LEFT JOIN borrowers USING (borrowernumber)
1343 LEFT JOIN serialitems USING (itemnumber)
1344 LEFT JOIN serial USING (serialid)
1345 LEFT JOIN itemtypes ON itemtypes.itemtype = "
1346 . (C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype');
1347 $query .= " WHERE items.biblionumber = ? ORDER BY home.branchname, items.enumchron, LPAD( items.copynumber, 8, '0' ), items.dateaccessioned DESC" ;
1348 my $sth = $dbh->prepare($query);
1349 $sth->execute($biblionumber);
1354 my $userenv = C4::Context->userenv;
1355 my $want_not_same_branch = C4::Context->preference("IndependentBranches") && !C4::Context->IsSuperLibrarian();
1356 while ( my $data = $sth->fetchrow_hashref ) {
1357 if ( $data->{borrowernumber} && $want_not_same_branch) {
1358 $data->{'NOTSAMEBRANCH'} = $data->{'bcode'} ne $userenv->{branch};
1361 $serial ||= $data->{'serial'};
1363 # get notforloan complete status if applicable
1364 if ( my $code = C4::Koha::GetAuthValCode( 'items.notforloan', $data->{frameworkcode} ) ) {
1365 $data->{notforloanvalue} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{itemnotforloan} );
1366 $data->{notforloanvalueopac} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{itemnotforloan}, 1 );
1369 # get restricted status and description if applicable
1370 if ( my $code = C4::Koha::GetAuthValCode( 'items.restricted', $data->{frameworkcode} ) ) {
1371 $data->{restrictedopac} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{restricted}, 1 );
1372 $data->{restricted} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{restricted} );
1375 # my stack procedures
1376 if ( my $code = C4::Koha::GetAuthValCode( 'items.stack', $data->{frameworkcode} ) ) {
1377 $data->{stack} = C4::Koha::GetKohaAuthorisedValueLib( $code, $data->{stack} );
1380 # Find the last 3 people who borrowed this item.
1381 my $sth2 = $dbh->prepare("SELECT * FROM old_issues,borrowers
1382 WHERE itemnumber = ?
1383 AND old_issues.borrowernumber = borrowers.borrowernumber
1384 ORDER BY returndate DESC
1386 $sth2->execute($data->{'itemnumber'});
1388 while (my $data2 = $sth2->fetchrow_hashref()) {
1389 $data->{"timestamp$ii"} = $data2->{'timestamp'} if $data2->{'timestamp'};
1390 $data->{"card$ii"} = $data2->{'cardnumber'} if $data2->{'cardnumber'};
1391 $data->{"borrower$ii"} = $data2->{'borrowernumber'} if $data2->{'borrowernumber'};
1395 $results[$i] = $data;
1400 ? sort { ($b->{'publisheddate'} || $b->{'enumchron'}) cmp ($a->{'publisheddate'} || $a->{'enumchron'}) } @results
1404 =head2 GetItemsLocationInfo
1406 my @itemlocinfo = GetItemsLocationInfo($biblionumber);
1408 Returns the branch names, shelving location and itemcallnumber for each item attached to the biblio in question
1410 C<GetItemsInfo> returns a list of references-to-hash. Data returned:
1414 =item C<$data-E<gt>{homebranch}>
1416 Branch Name of the item's homebranch
1418 =item C<$data-E<gt>{holdingbranch}>
1420 Branch Name of the item's holdingbranch
1422 =item C<$data-E<gt>{location}>
1424 Item's shelving location code
1426 =item C<$data-E<gt>{location_intranet}>
1428 The intranet description for the Shelving Location as set in authorised_values 'LOC'
1430 =item C<$data-E<gt>{location_opac}>
1432 The OPAC description for the Shelving Location as set in authorised_values 'LOC'. Falls back to intranet description if no OPAC
1435 =item C<$data-E<gt>{itemcallnumber}>
1437 Item's itemcallnumber
1439 =item C<$data-E<gt>{cn_sort}>
1441 Item's call number normalized for sorting
1447 sub GetItemsLocationInfo {
1448 my $biblionumber = shift;
1451 my $dbh = C4::Context->dbh;
1452 my $query = "SELECT a.branchname as homebranch, b.branchname as holdingbranch,
1453 location, itemcallnumber, cn_sort
1454 FROM items, branches as a, branches as b
1455 WHERE homebranch = a.branchcode AND holdingbranch = b.branchcode
1456 AND biblionumber = ?
1457 ORDER BY cn_sort ASC";
1458 my $sth = $dbh->prepare($query);
1459 $sth->execute($biblionumber);
1461 while ( my $data = $sth->fetchrow_hashref ) {
1462 $data->{location_intranet} = GetKohaAuthorisedValueLib('LOC', $data->{location});
1463 $data->{location_opac}= GetKohaAuthorisedValueLib('LOC', $data->{location}, 1);
1464 push @results, $data;
1469 =head2 GetHostItemsInfo
1471 $hostiteminfo = GetHostItemsInfo($hostfield);
1472 Returns the iteminfo for items linked to records via a host field
1476 sub GetHostItemsInfo {
1478 my @returnitemsInfo;
1480 if (C4::Context->preference('marcflavour') eq 'MARC21' ||
1481 C4::Context->preference('marcflavour') eq 'NORMARC'){
1482 foreach my $hostfield ( $record->field('773') ) {
1483 my $hostbiblionumber = $hostfield->subfield("0");
1484 my $linkeditemnumber = $hostfield->subfield("9");
1485 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1486 foreach my $hostitemInfo (@hostitemInfos){
1487 if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1488 push (@returnitemsInfo,$hostitemInfo);
1493 } elsif ( C4::Context->preference('marcflavour') eq 'UNIMARC'){
1494 foreach my $hostfield ( $record->field('461') ) {
1495 my $hostbiblionumber = $hostfield->subfield("0");
1496 my $linkeditemnumber = $hostfield->subfield("9");
1497 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1498 foreach my $hostitemInfo (@hostitemInfos){
1499 if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1500 push (@returnitemsInfo,$hostitemInfo);
1506 return @returnitemsInfo;
1510 =head2 GetLastAcquisitions
1512 my $lastacq = GetLastAcquisitions({'branches' => ('branch1','branch2'),
1513 'itemtypes' => ('BK','BD')}, 10);
1517 sub GetLastAcquisitions {
1518 my ($data,$max) = @_;
1520 my $itemtype = C4::Context->preference('item-level_itypes') ? 'itype' : 'itemtype';
1522 my $number_of_branches = @{$data->{branches}};
1523 my $number_of_itemtypes = @{$data->{itemtypes}};
1526 my @where = ('WHERE 1 ');
1527 $number_of_branches and push @where
1528 , 'AND holdingbranch IN ('
1529 , join(',', ('?') x $number_of_branches )
1533 $number_of_itemtypes and push @where
1534 , "AND $itemtype IN ("
1535 , join(',', ('?') x $number_of_itemtypes )
1539 my $query = "SELECT biblio.biblionumber as biblionumber, title, dateaccessioned
1540 FROM items RIGHT JOIN biblio ON (items.biblionumber=biblio.biblionumber)
1541 RIGHT JOIN biblioitems ON (items.biblioitemnumber=biblioitems.biblioitemnumber)
1543 GROUP BY biblio.biblionumber
1544 ORDER BY dateaccessioned DESC LIMIT $max";
1546 my $dbh = C4::Context->dbh;
1547 my $sth = $dbh->prepare($query);
1549 $sth->execute((@{$data->{branches}}, @{$data->{itemtypes}}));
1552 while( my $row = $sth->fetchrow_hashref){
1553 push @results, {date => $row->{dateaccessioned}
1554 , biblionumber => $row->{biblionumber}
1555 , title => $row->{title}};
1561 =head2 GetItemnumbersForBiblio
1563 my $itemnumbers = GetItemnumbersForBiblio($biblionumber);
1565 Given a single biblionumber, return an arrayref of all the corresponding itemnumbers
1569 sub GetItemnumbersForBiblio {
1570 my $biblionumber = shift;
1572 my $dbh = C4::Context->dbh;
1573 my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber = ?");
1574 $sth->execute($biblionumber);
1575 while (my $result = $sth->fetchrow_hashref) {
1576 push @items, $result->{'itemnumber'};
1581 =head2 get_itemnumbers_of
1583 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1585 Given a list of biblionumbers, return the list of corresponding itemnumbers
1586 for each biblionumber.
1588 Return a reference on a hash where keys are biblionumbers and values are
1589 references on array of itemnumbers.
1593 sub get_itemnumbers_of {
1594 my @biblionumbers = @_;
1596 my $dbh = C4::Context->dbh;
1602 WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1604 my $sth = $dbh->prepare($query);
1605 $sth->execute(@biblionumbers);
1609 while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1610 push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1613 return \%itemnumbers_of;
1616 =head2 get_hostitemnumbers_of
1618 my @itemnumbers_of = get_hostitemnumbers_of($biblionumber);
1620 Given a biblionumber, return the list of corresponding itemnumbers that are linked to it via host fields
1622 Return a reference on a hash where key is a biblionumber and values are
1623 references on array of itemnumbers.
1628 sub get_hostitemnumbers_of {
1629 my ($biblionumber) = @_;
1630 my $marcrecord = GetMarcBiblio($biblionumber);
1631 my (@returnhostitemnumbers,$tag, $biblio_s, $item_s);
1633 my $marcflavor = C4::Context->preference('marcflavour');
1634 if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1638 } elsif ($marcflavor eq 'UNIMARC') {
1644 foreach my $hostfield ( $marcrecord->field($tag) ) {
1645 my $hostbiblionumber = $hostfield->subfield($biblio_s);
1646 my $linkeditemnumber = $hostfield->subfield($item_s);
1648 if (my $itemnumbers = get_itemnumbers_of($hostbiblionumber)->{$hostbiblionumber})
1650 @itemnumbers = @$itemnumbers;
1652 foreach my $itemnumber (@itemnumbers){
1653 if ($itemnumber eq $linkeditemnumber){
1654 push (@returnhostitemnumbers,$itemnumber);
1659 return @returnhostitemnumbers;
1663 =head2 GetItemnumberFromBarcode
1665 $result = GetItemnumberFromBarcode($barcode);
1669 sub GetItemnumberFromBarcode {
1671 my $dbh = C4::Context->dbh;
1674 $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1675 $rq->execute($barcode);
1676 my ($result) = $rq->fetchrow;
1680 =head2 GetBarcodeFromItemnumber
1682 $result = GetBarcodeFromItemnumber($itemnumber);
1686 sub GetBarcodeFromItemnumber {
1687 my ($itemnumber) = @_;
1688 my $dbh = C4::Context->dbh;
1691 $dbh->prepare("SELECT barcode FROM items WHERE items.itemnumber=?");
1692 $rq->execute($itemnumber);
1693 my ($result) = $rq->fetchrow;
1697 =head2 GetHiddenItemnumbers
1699 my @itemnumbers_to_hide = GetHiddenItemnumbers(@items);
1701 Given a list of items it checks which should be hidden from the OPAC given
1702 the current configuration. Returns a list of itemnumbers corresponding to
1703 those that should be hidden.
1707 sub GetHiddenItemnumbers {
1711 my $yaml = C4::Context->preference('OpacHiddenItems');
1712 return () if (! $yaml =~ /\S/ );
1713 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1716 $hidingrules = YAML::Load($yaml);
1719 warn "Unable to parse OpacHiddenItems syspref : $@";
1722 my $dbh = C4::Context->dbh;
1725 foreach my $item (@items) {
1727 # We check each rule
1728 foreach my $field (keys %$hidingrules) {
1730 if (exists $item->{$field}) {
1731 $val = $item->{$field};
1734 my $query = "SELECT $field from items where itemnumber = ?";
1735 $val = $dbh->selectrow_array($query, undef, $item->{'itemnumber'});
1737 $val = '' unless defined $val;
1739 # If the results matches the values in the yaml file
1740 if (any { $val eq $_ } @{$hidingrules->{$field}}) {
1742 # We add the itemnumber to the list
1743 push @resultitems, $item->{'itemnumber'};
1745 # If at least one rule matched for an item, no need to test the others
1750 return @resultitems;
1753 =head3 get_item_authorised_values
1755 find the types and values for all authorised values assigned to this item.
1757 parameters: itemnumber
1759 returns: a hashref malling the authorised value to the value set for this itemnumber
1761 $authorised_values = {
1767 'RESTRICTED' => undef,
1770 'branches' => 'CPL',
1771 'cn_source' => undef,
1772 'itemtypes' => 'SER',
1775 Notes: see C4::Biblio::get_biblio_authorised_values for a similar method at the biblio level.
1779 sub get_item_authorised_values {
1780 my $itemnumber = shift;
1782 # assume that these entries in the authorised_value table are item level.
1783 my $query = q(SELECT distinct authorised_value, kohafield
1784 FROM marc_subfield_structure
1785 WHERE kohafield like 'item%'
1786 AND authorised_value != '' );
1788 my $itemlevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
1789 my $iteminfo = GetItem( $itemnumber );
1790 # warn( Data::Dumper->Dump( [ $itemlevel_authorised_values ], [ 'itemlevel_authorised_values' ] ) );
1792 foreach my $this_authorised_value ( keys %$itemlevel_authorised_values ) {
1793 my $field = $itemlevel_authorised_values->{ $this_authorised_value }->{'kohafield'};
1794 $field =~ s/^items\.//;
1795 if ( exists $iteminfo->{ $field } ) {
1796 $return->{ $this_authorised_value } = $iteminfo->{ $field };
1799 # warn( Data::Dumper->Dump( [ $return ], [ 'return' ] ) );
1803 =head3 get_authorised_value_images
1805 find a list of icons that are appropriate for display based on the
1806 authorised values for a biblio.
1808 parameters: listref of authorised values, such as comes from
1809 get_item_authorised_values or
1810 from C4::Biblio::get_biblio_authorised_values
1812 returns: listref of hashrefs for each image. Each hashref looks like this:
1814 { imageurl => '/intranet-tmpl/prog/img/itemtypeimg/npl/WEB.gif',
1819 Notes: Currently, I put on the full path to the images on the staff
1820 side. This should either be configurable or not done at all. Since I
1821 have to deal with 'intranet' or 'opac' in
1822 get_biblio_authorised_values, perhaps I should be passing it in.
1826 sub get_authorised_value_images {
1827 my $authorised_values = shift;
1831 my $authorised_value_list = GetAuthorisedValues();
1832 # warn ( Data::Dumper->Dump( [ $authorised_value_list ], [ 'authorised_value_list' ] ) );
1833 foreach my $this_authorised_value ( @$authorised_value_list ) {
1834 if ( exists $authorised_values->{ $this_authorised_value->{'category'} }
1835 && $authorised_values->{ $this_authorised_value->{'category'} } eq $this_authorised_value->{'authorised_value'} ) {
1836 # warn ( Data::Dumper->Dump( [ $this_authorised_value ], [ 'this_authorised_value' ] ) );
1837 if ( defined $this_authorised_value->{'imageurl'} ) {
1838 push @imagelist, { imageurl => C4::Koha::getitemtypeimagelocation( 'intranet', $this_authorised_value->{'imageurl'} ),
1839 label => $this_authorised_value->{'lib'},
1840 category => $this_authorised_value->{'category'},
1841 value => $this_authorised_value->{'authorised_value'}, };
1846 # warn ( Data::Dumper->Dump( [ \@imagelist ], [ 'imagelist' ] ) );
1851 =head1 LIMITED USE FUNCTIONS
1853 The following functions, while part of the public API,
1854 are not exported. This is generally because they are
1855 meant to be used by only one script for a specific
1856 purpose, and should not be used in any other context
1857 without careful thought.
1863 my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1865 Returns MARC::Record of the item passed in parameter.
1866 This function is meant for use only in C<cataloguing/additem.pl>,
1867 where it is needed to support that script's MARC-like
1873 my ( $biblionumber, $itemnumber ) = @_;
1875 # GetMarcItem has been revised so that it does the following:
1876 # 1. Gets the item information from the items table.
1877 # 2. Converts it to a MARC field for storage in the bib record.
1879 # The previous behavior was:
1880 # 1. Get the bib record.
1881 # 2. Return the MARC tag corresponding to the item record.
1883 # The difference is that one treats the items row as authoritative,
1884 # while the other treats the MARC representation as authoritative
1885 # under certain circumstances.
1887 my $itemrecord = GetItem($itemnumber);
1889 # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1890 # Also, don't emit a subfield if the underlying field is blank.
1893 return Item2Marc($itemrecord,$biblionumber);
1897 my ($itemrecord,$biblionumber)=@_;
1900 defined($itemrecord->{$_}) && $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : ()
1901 } keys %{ $itemrecord }
1903 my $itemmarc = TransformKohaToMarc($mungeditem);
1904 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",GetFrameworkCode($biblionumber)||'');
1906 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1907 if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1908 foreach my $field ($itemmarc->field($itemtag)){
1909 $field->add_subfields(@$unlinked_item_subfields);
1915 =head1 PRIVATE FUNCTIONS AND VARIABLES
1917 The following functions are not meant to be called
1918 directly, but are documented in order to explain
1919 the inner workings of C<C4::Items>.
1923 =head2 %derived_columns
1925 This hash keeps track of item columns that
1926 are strictly derived from other columns in
1927 the item record and are not meant to be set
1930 Each key in the hash should be the name of a
1931 column (as named by TransformMarcToKoha). Each
1932 value should be hashref whose keys are the
1933 columns on which the derived column depends. The
1934 hashref should also contain a 'BUILDER' key
1935 that is a reference to a sub that calculates
1940 my %derived_columns = (
1941 'items.cn_sort' => {
1942 'itemcallnumber' => 1,
1943 'items.cn_source' => 1,
1944 'BUILDER' => \&_calc_items_cn_sort,
1948 =head2 _set_derived_columns_for_add
1950 _set_derived_column_for_add($item);
1952 Given an item hash representing a new item to be added,
1953 calculate any derived columns. Currently the only
1954 such column is C<items.cn_sort>.
1958 sub _set_derived_columns_for_add {
1961 foreach my $column (keys %derived_columns) {
1962 my $builder = $derived_columns{$column}->{'BUILDER'};
1963 my $source_values = {};
1964 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1965 next if $source_column eq 'BUILDER';
1966 $source_values->{$source_column} = $item->{$source_column};
1968 $builder->($item, $source_values);
1972 =head2 _set_derived_columns_for_mod
1974 _set_derived_column_for_mod($item);
1976 Given an item hash representing a new item to be modified.
1977 calculate any derived columns. Currently the only
1978 such column is C<items.cn_sort>.
1980 This routine differs from C<_set_derived_columns_for_add>
1981 in that it needs to handle partial item records. In other
1982 words, the caller of C<ModItem> may have supplied only one
1983 or two columns to be changed, so this function needs to
1984 determine whether any of the columns to be changed affect
1985 any of the derived columns. Also, if a derived column
1986 depends on more than one column, but the caller is not
1987 changing all of then, this routine retrieves the unchanged
1988 values from the database in order to ensure a correct
1993 sub _set_derived_columns_for_mod {
1996 foreach my $column (keys %derived_columns) {
1997 my $builder = $derived_columns{$column}->{'BUILDER'};
1998 my $source_values = {};
1999 my %missing_sources = ();
2000 my $must_recalc = 0;
2001 foreach my $source_column (keys %{ $derived_columns{$column} }) {
2002 next if $source_column eq 'BUILDER';
2003 if (exists $item->{$source_column}) {
2005 $source_values->{$source_column} = $item->{$source_column};
2007 $missing_sources{$source_column} = 1;
2011 foreach my $source_column (keys %missing_sources) {
2012 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
2014 $builder->($item, $source_values);
2019 =head2 _do_column_fixes_for_mod
2021 _do_column_fixes_for_mod($item);
2023 Given an item hashref containing one or more
2024 columns to modify, fix up certain values.
2025 Specifically, set to 0 any passed value
2026 of C<notforloan>, C<damaged>, C<itemlost>, or
2027 C<withdrawn> that is either undefined or
2028 contains the empty string.
2032 sub _do_column_fixes_for_mod {
2035 if (exists $item->{'notforloan'} and
2036 (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
2037 $item->{'notforloan'} = 0;
2039 if (exists $item->{'damaged'} and
2040 (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
2041 $item->{'damaged'} = 0;
2043 if (exists $item->{'itemlost'} and
2044 (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
2045 $item->{'itemlost'} = 0;
2047 if (exists $item->{'withdrawn'} and
2048 (not defined $item->{'withdrawn'} or $item->{'withdrawn'} eq '')) {
2049 $item->{'withdrawn'} = 0;
2051 if (exists $item->{'location'} && !$item->{'permanent_location'}) {
2052 $item->{'permanent_location'} = $item->{'location'};
2054 if (exists $item->{'timestamp'}) {
2055 delete $item->{'timestamp'};
2059 =head2 _get_single_item_column
2061 _get_single_item_column($column, $itemnumber);
2063 Retrieves the value of a single column from an C<items>
2064 row specified by C<$itemnumber>.
2068 sub _get_single_item_column {
2070 my $itemnumber = shift;
2072 my $dbh = C4::Context->dbh;
2073 my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
2074 $sth->execute($itemnumber);
2075 my ($value) = $sth->fetchrow();
2079 =head2 _calc_items_cn_sort
2081 _calc_items_cn_sort($item, $source_values);
2083 Helper routine to calculate C<items.cn_sort>.
2087 sub _calc_items_cn_sort {
2089 my $source_values = shift;
2091 $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
2094 =head2 _set_defaults_for_add
2096 _set_defaults_for_add($item_hash);
2098 Given an item hash representing an item to be added, set
2099 correct default values for columns whose default value
2100 is not handled by the DBMS. This includes the following
2107 C<items.dateaccessioned>
2129 sub _set_defaults_for_add {
2131 $item->{dateaccessioned} ||= C4::Dates->new->output('iso');
2132 $item->{$_} ||= 0 for (qw( notforloan damaged itemlost withdrawn));
2135 =head2 _koha_new_item
2137 my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
2139 Perform the actual insert into the C<items> table.
2143 sub _koha_new_item {
2144 my ( $item, $barcode ) = @_;
2145 my $dbh=C4::Context->dbh;
2148 "INSERT INTO items SET
2150 biblioitemnumber = ?,
2152 dateaccessioned = ?,
2156 replacementprice = ?,
2157 replacementpricedate = ?,
2158 datelastborrowed = ?,
2166 coded_location_qualifier = ?,
2169 itemnotes_nonpublic = ?,
2173 permanent_location = ?,
2185 more_subfields_xml = ?,
2189 my $sth = $dbh->prepare($query);
2190 my $today = C4::Dates->today('iso');
2192 $item->{'biblionumber'},
2193 $item->{'biblioitemnumber'},
2195 $item->{'dateaccessioned'},
2196 $item->{'booksellerid'},
2197 $item->{'homebranch'},
2199 $item->{'replacementprice'},
2200 $item->{'replacementpricedate'} || $today,
2201 $item->{datelastborrowed},
2202 $item->{datelastseen} || $today,
2204 $item->{'notforloan'},
2206 $item->{'itemlost'},
2207 $item->{'withdrawn'},
2208 $item->{'itemcallnumber'},
2209 $item->{'coded_location_qualifier'},
2210 $item->{'restricted'},
2211 $item->{'itemnotes'},
2212 $item->{'itemnotes_nonpublic'},
2213 $item->{'holdingbranch'},
2215 $item->{'location'},
2216 $item->{'permanent_location'},
2219 $item->{'renewals'},
2220 $item->{'reserves'},
2221 $item->{'items.cn_source'},
2222 $item->{'items.cn_sort'},
2225 $item->{'materials'},
2227 $item->{'enumchron'},
2228 $item->{'more_subfields_xml'},
2229 $item->{'copynumber'},
2230 $item->{'stocknumber'},
2234 if ( defined $sth->errstr ) {
2235 $error.="ERROR in _koha_new_item $query".$sth->errstr;
2238 $itemnumber = $dbh->{'mysql_insertid'};
2241 return ( $itemnumber, $error );
2244 =head2 MoveItemFromBiblio
2246 MoveItemFromBiblio($itenumber, $frombiblio, $tobiblio);
2248 Moves an item from a biblio to another
2250 Returns undef if the move failed or the biblionumber of the destination record otherwise
2254 sub MoveItemFromBiblio {
2255 my ($itemnumber, $frombiblio, $tobiblio) = @_;
2256 my $dbh = C4::Context->dbh;
2257 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber = ?");
2258 $sth->execute( $tobiblio );
2259 my ( $tobiblioitem ) = $sth->fetchrow();
2260 $sth = $dbh->prepare("UPDATE items SET biblioitemnumber = ?, biblionumber = ? WHERE itemnumber = ? AND biblionumber = ?");
2261 my $return = $sth->execute($tobiblioitem, $tobiblio, $itemnumber, $frombiblio);
2263 ModZebra( $tobiblio, "specialUpdate", "biblioserver" );
2264 ModZebra( $frombiblio, "specialUpdate", "biblioserver" );
2265 # Checking if the item we want to move is in an order
2266 require C4::Acquisition;
2267 my $order = C4::Acquisition::GetOrderFromItemnumber($itemnumber);
2269 # Replacing the biblionumber within the order if necessary
2270 $order->{'biblionumber'} = $tobiblio;
2271 C4::Acquisition::ModOrder($order);
2280 DelItemCheck($dbh, $biblionumber, $itemnumber);
2282 Exported function (core API) for deleting an item record in Koha if there no current issue.
2287 my ( $dbh, $biblionumber, $itemnumber ) = @_;
2290 my $countanalytics=GetAnalyticsCount($itemnumber);
2293 # check that there is no issue on this item before deletion.
2294 my $sth = $dbh->prepare(q{
2295 SELECT COUNT(*) FROM issues
2296 WHERE itemnumber = ?
2298 $sth->execute($itemnumber);
2299 my ($onloan) = $sth->fetchrow;
2301 my $item = GetItem($itemnumber);
2304 $error = "book_on_loan"
2306 elsif ( !C4::Context->IsSuperLibrarian()
2307 and C4::Context->preference("IndependentBranches")
2308 and ( C4::Context->userenv->{branch} ne $item->{'homebranch'} ) )
2310 $error = "not_same_branch";
2313 # check it doesnt have a waiting reserve
2314 $sth = $dbh->prepare(q{
2315 SELECT COUNT(*) FROM reserves
2316 WHERE (found = 'W' OR found = 'T')
2319 $sth->execute($itemnumber);
2320 my ($reserve) = $sth->fetchrow;
2322 $error = "book_reserved";
2323 } elsif ($countanalytics > 0){
2324 $error = "linked_analytics";
2328 biblionumber => $biblionumber,
2329 itemnumber => $itemnumber
2338 =head2 _koha_modify_item
2340 my ($itemnumber,$error) =_koha_modify_item( $item );
2342 Perform the actual update of the C<items> row. Note that this
2343 routine accepts a hashref specifying the columns to update.
2347 sub _koha_modify_item {
2349 my $dbh=C4::Context->dbh;
2352 my $query = "UPDATE items SET ";
2354 for my $key ( keys %$item ) {
2355 next if ( $key eq 'itemnumber' );
2357 push @bind, $item->{$key};
2360 $query .= " WHERE itemnumber=?";
2361 push @bind, $item->{'itemnumber'};
2362 my $sth = $dbh->prepare($query);
2363 $sth->execute(@bind);
2365 $error.="ERROR in _koha_modify_item $query: ".$sth->errstr;
2368 return ($item->{'itemnumber'},$error);
2371 =head2 _koha_delete_item
2373 _koha_delete_item( $itemnum );
2375 Internal function to delete an item record from the koha tables
2379 sub _koha_delete_item {
2380 my ( $itemnum ) = @_;
2382 my $dbh = C4::Context->dbh;
2383 # save the deleted item to deleteditems table
2384 my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
2385 $sth->execute($itemnum);
2386 my $data = $sth->fetchrow_hashref();
2388 # There is no item to delete
2389 return 0 unless $data;
2391 my $query = "INSERT INTO deleteditems SET ";
2393 foreach my $key ( keys %$data ) {
2394 next if ( $key eq 'timestamp' ); # timestamp will be set by db
2395 $query .= "$key = ?,";
2396 push( @bind, $data->{$key} );
2399 $sth = $dbh->prepare($query);
2400 $sth->execute(@bind);
2402 # delete from items table
2403 $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
2404 my $deleted = $sth->execute($itemnum);
2405 return ( $deleted == 1 ) ? 1 : 0;
2408 =head2 _marc_from_item_hash
2410 my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
2412 Given an item hash representing a complete item record,
2413 create a C<MARC::Record> object containing an embedded
2414 tag representing that item.
2416 The third, optional parameter C<$unlinked_item_subfields> is
2417 an arrayref of subfields (not mapped to C<items> fields per the
2418 framework) to be added to the MARC representation
2423 sub _marc_from_item_hash {
2425 my $frameworkcode = shift;
2426 my $unlinked_item_subfields;
2428 $unlinked_item_subfields = shift;
2431 # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
2432 # Also, don't emit a subfield if the underlying field is blank.
2433 my $mungeditem = { map { (defined($item->{$_}) and $item->{$_} ne '') ?
2434 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
2435 : () } keys %{ $item } };
2437 my $item_marc = MARC::Record->new();
2438 foreach my $item_field ( keys %{$mungeditem} ) {
2439 my ( $tag, $subfield ) = GetMarcFromKohaField( $item_field, $frameworkcode );
2440 next unless defined $tag and defined $subfield; # skip if not mapped to MARC field
2441 my @values = split(/\s?\|\s?/, $mungeditem->{$item_field}, -1);
2442 foreach my $value (@values){
2443 if ( my $field = $item_marc->field($tag) ) {
2444 $field->add_subfields( $subfield => $value );
2446 my $add_subfields = [];
2447 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2448 $add_subfields = $unlinked_item_subfields;
2450 $item_marc->add_fields( $tag, " ", " ", $subfield => $value, @$add_subfields );
2458 =head2 _repack_item_errors
2460 Add an error message hash generated by C<CheckItemPreSave>
2461 to a list of errors.
2465 sub _repack_item_errors {
2466 my $item_sequence_num = shift;
2467 my $item_ref = shift;
2468 my $error_ref = shift;
2470 my @repacked_errors = ();
2472 foreach my $error_code (sort keys %{ $error_ref }) {
2473 my $repacked_error = {};
2474 $repacked_error->{'item_sequence'} = $item_sequence_num;
2475 $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
2476 $repacked_error->{'error_code'} = $error_code;
2477 $repacked_error->{'error_information'} = $error_ref->{$error_code};
2478 push @repacked_errors, $repacked_error;
2481 return @repacked_errors;
2484 =head2 _get_unlinked_item_subfields
2486 my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
2490 sub _get_unlinked_item_subfields {
2491 my $original_item_marc = shift;
2492 my $frameworkcode = shift;
2494 my $marcstructure = GetMarcStructure(1, $frameworkcode);
2496 # assume that this record has only one field, and that that
2497 # field contains only the item information
2499 my @fields = $original_item_marc->fields();
2500 if ($#fields > -1) {
2501 my $field = $fields[0];
2502 my $tag = $field->tag();
2503 foreach my $subfield ($field->subfields()) {
2504 if (defined $subfield->[1] and
2505 $subfield->[1] ne '' and
2506 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
2507 push @$subfields, $subfield->[0] => $subfield->[1];
2514 =head2 _get_unlinked_subfields_xml
2516 my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
2520 sub _get_unlinked_subfields_xml {
2521 my $unlinked_item_subfields = shift;
2524 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2525 my $marc = MARC::Record->new();
2526 # use of tag 999 is arbitrary, and doesn't need to match the item tag
2527 # used in the framework
2528 $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
2529 $marc->encoding("UTF-8");
2530 $xml = $marc->as_xml("USMARC");
2536 =head2 _parse_unlinked_item_subfields_from_xml
2538 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2542 sub _parse_unlinked_item_subfields_from_xml {
2544 require C4::Charset;
2545 return unless defined $xml and $xml ne "";
2546 my $marc = MARC::Record->new_from_xml(C4::Charset::StripNonXmlChars($xml),'UTF-8');
2547 my $unlinked_subfields = [];
2548 my @fields = $marc->fields();
2549 if ($#fields > -1) {
2550 foreach my $subfield ($fields[0]->subfields()) {
2551 push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2554 return $unlinked_subfields;
2557 =head2 GetAnalyticsCount
2559 $count= &GetAnalyticsCount($itemnumber)
2561 counts Usage of itemnumber in Analytical bibliorecords.
2565 sub GetAnalyticsCount {
2566 my ($itemnumber) = @_;
2569 ### ZOOM search here
2571 $query= "hi=".$itemnumber;
2572 my ($err,$res,$result) = C4::Search::SimpleSearch($query,0,10);
2578 $holds = &GetItemHolds($biblionumber, $itemnumber);
2580 This function return the count of holds with $biblionumber and $itemnumber
2585 my ($biblionumber, $itemnumber) = @_;
2587 my $dbh = C4::Context->dbh;
2588 my $query = "SELECT count(*)
2590 WHERE biblionumber=? AND itemnumber=?";
2591 my $sth = $dbh->prepare($query);
2592 $sth->execute($biblionumber, $itemnumber);
2593 $holds = $sth->fetchrow;
2597 =head2 SearchItemsByField
2599 my $items = SearchItemsByField($field, $value);
2601 SearchItemsByField will search for items on a specific given field.
2602 For instance you can search all items with a specific stocknumber like this:
2604 my $items = SearchItemsByField('stocknumber', $stocknumber);
2608 sub SearchItemsByField {
2609 my ($field, $value) = @_;
2616 my ($results) = SearchItems($filters);
2620 sub _SearchItems_build_where_fragment {
2623 my $dbh = C4::Context->dbh;
2626 if (exists($filter->{conjunction})) {
2627 my (@where_strs, @where_args);
2628 foreach my $f (@{ $filter->{filters} }) {
2629 my $fragment = _SearchItems_build_where_fragment($f);
2631 push @where_strs, $fragment->{str};
2632 push @where_args, @{ $fragment->{args} };
2637 $where_str = '(' . join (' ' . $filter->{conjunction} . ' ', @where_strs) . ')';
2640 args => \@where_args,
2644 my @columns = Koha::Database->new()->schema()->resultset('Item')->result_source->columns;
2645 push @columns, Koha::Database->new()->schema()->resultset('Biblio')->result_source->columns;
2646 push @columns, Koha::Database->new()->schema()->resultset('Biblioitem')->result_source->columns;
2647 my @operators = qw(= != > < >= <= like);
2648 my $field = $filter->{field};
2649 if ( (0 < grep /^$field$/, @columns) or (substr($field, 0, 5) eq 'marc:') ) {
2650 my $op = $filter->{operator};
2651 my $query = $filter->{query};
2653 if (!$op or (0 == grep /^$op$/, @operators)) {
2654 $op = '='; # default operator
2658 if ($field =~ /^marc:(\d{3})(?:\$(\w))?$/) {
2660 my $marcsubfield = $2;
2661 my ($kohafield) = $dbh->selectrow_array(q|
2662 SELECT kohafield FROM marc_subfield_structure
2663 WHERE tagfield=? AND tagsubfield=? AND frameworkcode=''
2664 |, undef, $marcfield, $marcsubfield);
2667 $column = $kohafield;
2669 # MARC field is not linked to a DB field so we need to use
2670 # ExtractValue on biblioitems.marcxml or
2671 # items.more_subfields_xml, depending on the MARC field.
2674 my ($itemfield) = GetMarcFromKohaField('items.itemnumber');
2675 if ($marcfield eq $itemfield) {
2676 $sqlfield = 'more_subfields_xml';
2677 $xpath = '//record/datafield/subfield[@code="' . $marcsubfield . '"]';
2679 $sqlfield = 'marcxml';
2680 if ($marcfield < 10) {
2681 $xpath = "//record/controlfield[\@tag=\"$marcfield\"]";
2683 $xpath = "//record/datafield[\@tag=\"$marcfield\"]/subfield[\@code=\"$marcsubfield\"]";
2686 $column = "ExtractValue($sqlfield, '$xpath')";
2692 if (ref $query eq 'ARRAY') {
2695 } elsif ($op eq '!=') {
2699 str => "$column $op (" . join (',', ('?') x @$query) . ")",
2704 str => "$column $op ?",
2711 return $where_fragment;
2716 my ($items, $total) = SearchItems($filter, $params);
2718 Perform a search among items
2720 $filter is a reference to a hash which can be a filter, or a combination of filters.
2722 A filter has the following keys:
2726 =item * field: the name of a SQL column in table items
2728 =item * query: the value to search in this column
2730 =item * operator: comparison operator. Can be one of = != > < >= <= like
2734 A combination of filters hash the following keys:
2738 =item * conjunction: 'AND' or 'OR'
2740 =item * filters: array ref of filters
2744 $params is a reference to a hash that can contain the following parameters:
2748 =item * rows: Number of items to return. 0 returns everything (default: 0)
2750 =item * page: Page to return (return items from (page-1)*rows to (page*rows)-1)
2753 =item * sortby: A SQL column name in items table to sort on
2755 =item * sortorder: 'ASC' or 'DESC'
2762 my ($filter, $params) = @_;
2766 return unless ref $filter eq 'HASH';
2767 return unless ref $params eq 'HASH';
2769 # Default parameters
2770 $params->{rows} ||= 0;
2771 $params->{page} ||= 1;
2772 $params->{sortby} ||= 'itemnumber';
2773 $params->{sortorder} ||= 'ASC';
2775 my ($where_str, @where_args);
2776 my $where_fragment = _SearchItems_build_where_fragment($filter);
2777 if ($where_fragment) {
2778 $where_str = $where_fragment->{str};
2779 @where_args = @{ $where_fragment->{args} };
2782 my $dbh = C4::Context->dbh;
2784 SELECT SQL_CALC_FOUND_ROWS items.*
2786 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2787 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
2789 if (defined $where_str and $where_str ne '') {
2790 $query .= qq{ WHERE $where_str };
2793 my @columns = Koha::Database->new()->schema()->resultset('Item')->result_source->columns;
2794 push @columns, Koha::Database->new()->schema()->resultset('Biblio')->result_source->columns;
2795 push @columns, Koha::Database->new()->schema()->resultset('Biblioitem')->result_source->columns;
2796 my $sortby = (0 < grep {$params->{sortby} eq $_} @columns)
2797 ? $params->{sortby} : 'itemnumber';
2798 my $sortorder = (uc($params->{sortorder}) eq 'ASC') ? 'ASC' : 'DESC';
2799 $query .= qq{ ORDER BY $sortby $sortorder };
2801 my $rows = $params->{rows};
2804 my $offset = $rows * ($params->{page}-1);
2805 $query .= qq { LIMIT ?, ? };
2806 push @limit_args, $offset, $rows;
2809 my $sth = $dbh->prepare($query);
2810 my $rv = $sth->execute(@where_args, @limit_args);
2812 return unless ($rv);
2813 my ($total_rows) = $dbh->selectrow_array(q{ SELECT FOUND_ROWS() });
2815 return ($sth->fetchall_arrayref({}), $total_rows);
2819 =head1 OTHER FUNCTIONS
2823 ($indicators, $value) = _find_value($tag, $subfield, $record,$encoding);
2825 Find the given $subfield in the given $tag in the given
2826 MARC::Record $record. If the subfield is found, returns
2827 the (indicators, value) pair; otherwise, (undef, undef) is
2831 Such a function is used in addbiblio AND additem and serial-edit and maybe could be used in Authorities.
2832 I suggest we export it from this module.
2837 my ( $tagfield, $insubfield, $record, $encoding ) = @_;
2840 if ( $tagfield < 10 ) {
2841 if ( $record->field($tagfield) ) {
2842 push @result, $record->field($tagfield)->data();
2847 foreach my $field ( $record->field($tagfield) ) {
2848 my @subfields = $field->subfields();
2849 foreach my $subfield (@subfields) {
2850 if ( @$subfield[0] eq $insubfield ) {
2851 push @result, @$subfield[1];
2852 $indicator = $field->indicator(1) . $field->indicator(2);
2857 return ( $indicator, @result );
2861 =head2 PrepareItemrecordDisplay
2863 PrepareItemrecordDisplay($itemrecord,$bibnum,$itemumber,$frameworkcode);
2865 Returns a hash with all the fields for Display a given item data in a template
2867 The $frameworkcode returns the item for the given frameworkcode, ONLY if bibnum is not provided
2871 sub PrepareItemrecordDisplay {
2873 my ( $bibnum, $itemnum, $defaultvalues, $frameworkcode ) = @_;
2875 my $dbh = C4::Context->dbh;
2876 $frameworkcode = &GetFrameworkCode($bibnum) if $bibnum;
2877 my ( $itemtagfield, $itemtagsubfield ) = &GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
2878 my $tagslib = &GetMarcStructure( 1, $frameworkcode );
2880 # return nothing if we don't have found an existing framework.
2881 return q{} unless $tagslib;
2884 $itemrecord = C4::Items::GetMarcItem( $bibnum, $itemnum );
2888 my $branch_limit = C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
2890 SELECT authorised_value,lib FROM authorised_values
2893 LEFT JOIN authorised_values_branches ON ( id = av_id )
2898 $query .= qq{ AND ( branchcode = ? OR branchcode IS NULL )} if $branch_limit;
2899 $query .= qq{ ORDER BY lib};
2900 my $authorised_values_sth = $dbh->prepare( $query );
2901 foreach my $tag ( sort keys %{$tagslib} ) {
2902 my $previous_tag = '';
2905 # loop through each subfield
2907 foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
2908 next if ( subfield_is_koha_internal_p($subfield) );
2909 next if ( $tagslib->{$tag}->{$subfield}->{'tab'} ne "10" );
2911 $subfield_data{tag} = $tag;
2912 $subfield_data{subfield} = $subfield;
2913 $subfield_data{countsubfield} = $cntsubf++;
2914 $subfield_data{kohafield} = $tagslib->{$tag}->{$subfield}->{'kohafield'};
2915 $subfield_data{id} = "tag_".$tag."_subfield_".$subfield."_".int(rand(1000000));
2917 # $subfield_data{marc_lib}=$tagslib->{$tag}->{$subfield}->{lib};
2918 $subfield_data{marc_lib} = $tagslib->{$tag}->{$subfield}->{lib};
2919 $subfield_data{mandatory} = $tagslib->{$tag}->{$subfield}->{mandatory};
2920 $subfield_data{repeatable} = $tagslib->{$tag}->{$subfield}->{repeatable};
2921 $subfield_data{hidden} = "display:none"
2922 if ( ( $tagslib->{$tag}->{$subfield}->{hidden} > 4 )
2923 || ( $tagslib->{$tag}->{$subfield}->{hidden} < -4 ) );
2924 my ( $x, $defaultvalue );
2926 ( $x, $defaultvalue ) = _find_value( $tag, $subfield, $itemrecord );
2928 $defaultvalue = $tagslib->{$tag}->{$subfield}->{defaultvalue} unless $defaultvalue;
2929 if ( !defined $defaultvalue ) {
2930 $defaultvalue = q||;
2932 $defaultvalue =~ s/"/"/g;
2935 # search for itemcallnumber if applicable
2936 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.itemcallnumber'
2937 && C4::Context->preference('itemcallnumber') ) {
2938 my $CNtag = substr( C4::Context->preference('itemcallnumber'), 0, 3 );
2939 my $CNsubfield = substr( C4::Context->preference('itemcallnumber'), 3, 1 );
2940 if ( $itemrecord and my $field = $itemrecord->field($CNtag) ) {
2941 $defaultvalue = $field->subfield($CNsubfield);
2944 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.itemcallnumber'
2946 && $defaultvalues->{'callnumber'} ) {
2947 if( $itemrecord and $defaultvalues and not $itemrecord->field($subfield) ){
2948 # if the item record exists, only use default value if the item has no callnumber
2949 $defaultvalue = $defaultvalues->{callnumber};
2950 } elsif ( !$itemrecord and $defaultvalues ) {
2951 # if the item record *doesn't* exists, always use the default value
2952 $defaultvalue = $defaultvalues->{callnumber};
2955 if ( ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.holdingbranch' || $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.homebranch' )
2957 && $defaultvalues->{'branchcode'} ) {
2958 if ( $itemrecord and $defaultvalues and not $itemrecord->field($subfield) ) {
2959 $defaultvalue = $defaultvalues->{branchcode};
2962 if ( ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.location' )
2964 && $defaultvalues->{'location'} ) {
2966 if ( $itemrecord and $defaultvalues and not $itemrecord->field($subfield) ) {
2967 # if the item record exists, only use default value if the item has no locationr
2968 $defaultvalue = $defaultvalues->{location};
2969 } elsif ( !$itemrecord and $defaultvalues ) {
2970 # if the item record *doesn't* exists, always use the default value
2971 $defaultvalue = $defaultvalues->{location};
2974 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
2975 my @authorised_values;
2978 # builds list, depending on authorised value...
2980 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
2981 if ( ( C4::Context->preference("IndependentBranches") )
2982 && !C4::Context->IsSuperLibrarian() ) {
2983 my $sth = $dbh->prepare( "SELECT branchcode,branchname FROM branches WHERE branchcode = ? ORDER BY branchname" );
2984 $sth->execute( C4::Context->userenv->{branch} );
2985 push @authorised_values, ""
2986 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2987 while ( my ( $branchcode, $branchname ) = $sth->fetchrow_array ) {
2988 push @authorised_values, $branchcode;
2989 $authorised_lib{$branchcode} = $branchname;
2992 my $sth = $dbh->prepare( "SELECT branchcode,branchname FROM branches ORDER BY branchname" );
2994 push @authorised_values, ""
2995 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2996 while ( my ( $branchcode, $branchname ) = $sth->fetchrow_array ) {
2997 push @authorised_values, $branchcode;
2998 $authorised_lib{$branchcode} = $branchname;
3002 $defaultvalue = C4::Context->userenv ? C4::Context->userenv->{branch} : undef;
3003 if ( $defaultvalues and $defaultvalues->{branchcode} ) {
3004 $defaultvalue = $defaultvalues->{branchcode};
3008 } elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "itemtypes" ) {
3009 my $sth = $dbh->prepare( "SELECT itemtype,description FROM itemtypes ORDER BY description" );
3011 push @authorised_values, ""
3012 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
3013 while ( my ( $itemtype, $description ) = $sth->fetchrow_array ) {
3014 push @authorised_values, $itemtype;
3015 $authorised_lib{$itemtype} = $description;
3018 } elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "cn_source" ) {
3019 push @authorised_values, "" unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
3021 my $class_sources = GetClassSources();
3022 my $default_source = C4::Context->preference("DefaultClassificationSource");
3024 foreach my $class_source (sort keys %$class_sources) {
3025 next unless $class_sources->{$class_source}->{'used'} or
3026 ($class_source eq $default_source);
3027 push @authorised_values, $class_source;
3028 $authorised_lib{$class_source} = $class_sources->{$class_source}->{'description'};
3031 $defaultvalue = $default_source;
3033 #---- "true" authorised value
3035 $authorised_values_sth->execute(
3036 $tagslib->{$tag}->{$subfield}->{authorised_value},
3037 $branch_limit ? $branch_limit : ()
3039 push @authorised_values, ""
3040 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
3041 while ( my ( $value, $lib ) = $authorised_values_sth->fetchrow_array ) {
3042 push @authorised_values, $value;
3043 $authorised_lib{$value} = $lib;
3046 $subfield_data{marc_value} = {
3048 values => \@authorised_values,
3049 default => "$defaultvalue",
3050 labels => \%authorised_lib,
3052 } elsif ( $tagslib->{$tag}->{$subfield}->{value_builder} ) {
3054 require Koha::FrameworkPlugin;
3055 my $plugin = Koha::FrameworkPlugin->new({
3056 name => $tagslib->{$tag}->{$subfield}->{value_builder},
3059 my $pars = { dbh => $dbh, record => undef, tagslib =>$tagslib, id => $subfield_data{id}, tabloop => undef };
3060 $plugin->build( $pars );
3061 if( !$plugin->errstr ) {
3062 #TODO Move html to template; see report 12176/13397
3063 my $tab= $plugin->noclick? '-1': '';
3064 my $class= $plugin->noclick? ' disabled': '';
3065 my $title= $plugin->noclick? 'No popup': 'Tag editor';
3066 $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;
3068 warn $plugin->errstr;
3069 $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
3072 elsif ( $tag eq '' ) { # it's an hidden field
3073 $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" />);
3075 elsif ( $tagslib->{$tag}->{$subfield}->{'hidden'} ) { # FIXME: shouldn't input type be "hidden" ?
3076 $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" />);
3078 elsif ( length($defaultvalue) > 100
3079 or (C4::Context->preference("marcflavour") eq "UNIMARC" and
3080 300 <= $tag && $tag < 400 && $subfield eq 'a' )
3081 or (C4::Context->preference("marcflavour") eq "MARC21" and
3082 500 <= $tag && $tag < 600 )
3084 # oversize field (textarea)
3085 $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");
3087 $subfield_data{marc_value} = "<input type=\"text\" name=\"field_value\" value=\"$defaultvalue\" size=\"50\" maxlength=\"255\" />";
3089 push( @loop_data, \%subfield_data );
3094 if ( $itemrecord && $itemrecord->field($itemtagfield) ) {
3095 $itemnumber = $itemrecord->subfield( $itemtagfield, $itemtagsubfield );
3098 'itemtagfield' => $itemtagfield,
3099 'itemtagsubfield' => $itemtagsubfield,
3100 'itemnumber' => $itemnumber,
3101 'iteminformation' => \@loop_data