3 # Copyright 2007 LibLime, Inc.
4 # Parts Copyright Biblibre 2010
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it under the
9 # terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 2 of the License, or (at your option) any later
13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License along
18 # with Koha; if not, write to the Free Software Foundation, Inc.,
19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #use warnings; FIXME - Bug 2505
28 use C4::Dates qw/format_date format_date_in_iso/;
36 use List::MoreUtils qw/any/;
37 use Data::Dumper; # used as part of logging item record changes, not just for
38 # debugging; so please don't remove this
40 use vars qw($VERSION @ISA @EXPORT);
46 @ISA = qw( Exporter );
69 GetItemsByBiblioitemnumber
74 get_hostitemnumbers_of
75 GetItemnumberFromBarcode
76 GetBarcodeFromItemnumber
90 C4::Items - item management functions
94 This module contains an API for manipulating item
95 records in Koha, and is used by cataloguing, circulation,
96 acquisitions, and serials management.
98 A Koha item record is stored in two places: the
99 items table and embedded in a MARC tag in the XML
100 version of the associated bib record in C<biblioitems.marcxml>.
101 This is done to allow the item information to be readily
102 indexed (e.g., by Zebra), but means that each item
103 modification transaction must keep the items table
104 and the MARC XML in sync at all times.
106 Consequently, all code that creates, modifies, or deletes
107 item records B<must> use an appropriate function from
108 C<C4::Items>. If no existing function is suitable, it is
109 better to add one to C<C4::Items> than to use add
110 one-off SQL statements to add or modify items.
112 The items table will be considered authoritative. In other
113 words, if there is ever a discrepancy between the items
114 table and the MARC XML, the items table should be considered
117 =head1 HISTORICAL NOTE
119 Most of the functions in C<C4::Items> were originally in
120 the C<C4::Biblio> module.
122 =head1 CORE EXPORTED FUNCTIONS
124 The following functions are meant for use by users
131 $item = GetItem($itemnumber,$barcode,$serial);
133 Return item information, for a given itemnumber or barcode.
134 The return value is a hashref mapping item column
135 names to values. If C<$serial> is true, include serial publication data.
140 my ($itemnumber,$barcode, $serial) = @_;
141 my $dbh = C4::Context->dbh;
144 my $sth = $dbh->prepare("
146 WHERE itemnumber = ?");
147 $sth->execute($itemnumber);
148 $data = $sth->fetchrow_hashref;
150 my $sth = $dbh->prepare("
154 $sth->execute($barcode);
155 $data = $sth->fetchrow_hashref;
158 my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=?");
159 $ssth->execute($data->{'itemnumber'}) ;
160 ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
162 #if we don't have an items.itype, use biblioitems.itemtype.
163 if( ! $data->{'itype'} ) {
164 my $sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
165 $sth->execute($data->{'biblionumber'});
166 ($data->{'itype'}) = $sth->fetchrow_array;
173 CartToShelf($itemnumber);
175 Set the current shelving location of the item record
176 to its stored permanent shelving location. This is
177 primarily used to indicate when an item whose current
178 location is a special processing ('PROC') or shelving cart
179 ('CART') location is back in the stacks.
184 my ( $itemnumber ) = @_;
186 unless ( $itemnumber ) {
187 croak "FAILED CartToShelf() - no itemnumber supplied";
190 my $item = GetItem($itemnumber);
191 $item->{location} = $item->{permanent_location};
192 ModItem($item, undef, $itemnumber);
195 =head2 AddItemFromMarc
197 my ($biblionumber, $biblioitemnumber, $itemnumber)
198 = AddItemFromMarc($source_item_marc, $biblionumber);
200 Given a MARC::Record object containing an embedded item
201 record and a biblionumber, create a new item record.
205 sub AddItemFromMarc {
206 my ( $source_item_marc, $biblionumber ) = @_;
207 my $dbh = C4::Context->dbh;
209 # parse item hash from MARC
210 my $frameworkcode = GetFrameworkCode( $biblionumber );
211 my ($itemtag,$itemsubfield)=GetMarcFromKohaField("items.itemnumber",$frameworkcode);
213 my $localitemmarc=MARC::Record->new;
214 $localitemmarc->append_fields($source_item_marc->field($itemtag));
215 my $item = &TransformMarcToKoha( $dbh, $localitemmarc, $frameworkcode ,'items');
216 my $unlinked_item_subfields = _get_unlinked_item_subfields($localitemmarc, $frameworkcode);
217 return AddItem($item, $biblionumber, $dbh, $frameworkcode, $unlinked_item_subfields);
222 my ($biblionumber, $biblioitemnumber, $itemnumber)
223 = AddItem($item, $biblionumber[, $dbh, $frameworkcode, $unlinked_item_subfields]);
225 Given a hash containing item column names as keys,
226 create a new Koha item record.
228 The first two optional parameters (C<$dbh> and C<$frameworkcode>)
229 do not need to be supplied for general use; they exist
230 simply to allow them to be picked up from AddItemFromMarc.
232 The final optional parameter, C<$unlinked_item_subfields>, contains
233 an arrayref containing subfields present in the original MARC
234 representation of the item (e.g., from the item editor) that are
235 not mapped to C<items> columns directly but should instead
236 be stored in C<items.more_subfields_xml> and included in
237 the biblio items tag for display and indexing.
243 my $biblionumber = shift;
245 my $dbh = @_ ? shift : C4::Context->dbh;
246 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
247 my $unlinked_item_subfields;
249 $unlinked_item_subfields = shift
252 # needs old biblionumber and biblioitemnumber
253 $item->{'biblionumber'} = $biblionumber;
254 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
255 $sth->execute( $item->{'biblionumber'} );
256 ($item->{'biblioitemnumber'}) = $sth->fetchrow;
258 _set_defaults_for_add($item);
259 _set_derived_columns_for_add($item);
260 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
261 # FIXME - checks here
262 unless ( $item->{itype} ) { # default to biblioitem.itemtype if no itype
263 my $itype_sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
264 $itype_sth->execute( $item->{'biblionumber'} );
265 ( $item->{'itype'} ) = $itype_sth->fetchrow_array;
268 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
269 $item->{'itemnumber'} = $itemnumber;
271 ModZebra( $item->{biblionumber}, "specialUpdate", "biblioserver", undef, undef );
273 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
275 return ($item->{biblionumber}, $item->{biblioitemnumber}, $itemnumber);
278 =head2 AddItemBatchFromMarc
280 ($itemnumber_ref, $error_ref) = AddItemBatchFromMarc($record,
281 $biblionumber, $biblioitemnumber, $frameworkcode);
283 Efficiently create item records from a MARC biblio record with
284 embedded item fields. This routine is suitable for batch jobs.
286 This API assumes that the bib record has already been
287 saved to the C<biblio> and C<biblioitems> tables. It does
288 not expect that C<biblioitems.marc> and C<biblioitems.marcxml>
289 are populated, but it will do so via a call to ModBibiloMarc.
291 The goal of this API is to have a similar effect to using AddBiblio
292 and AddItems in succession, but without inefficient repeated
293 parsing of the MARC XML bib record.
295 This function returns an arrayref of new itemsnumbers and an arrayref of item
296 errors encountered during the processing. Each entry in the errors
297 list is a hashref containing the following keys:
303 Sequence number of original item tag in the MARC record.
307 Item barcode, provide to assist in the construction of
308 useful error messages.
310 =item error_condition
312 Code representing the error condition. Can be 'duplicate_barcode',
313 'invalid_homebranch', or 'invalid_holdingbranch'.
315 =item error_information
317 Additional information appropriate to the error condition.
323 sub AddItemBatchFromMarc {
324 my ($record, $biblionumber, $biblioitemnumber, $frameworkcode) = @_;
326 my @itemnumbers = ();
328 my $dbh = C4::Context->dbh;
330 # loop through the item tags and start creating items
331 my @bad_item_fields = ();
332 my ($itemtag, $itemsubfield) = &GetMarcFromKohaField("items.itemnumber",'');
333 my $item_sequence_num = 0;
334 ITEMFIELD: foreach my $item_field ($record->field($itemtag)) {
335 $item_sequence_num++;
336 # we take the item field and stick it into a new
337 # MARC record -- this is required so far because (FIXME)
338 # TransformMarcToKoha requires a MARC::Record, not a MARC::Field
339 # and there is no TransformMarcFieldToKoha
340 my $temp_item_marc = MARC::Record->new();
341 $temp_item_marc->append_fields($item_field);
343 # add biblionumber and biblioitemnumber
344 my $item = TransformMarcToKoha( $dbh, $temp_item_marc, $frameworkcode, 'items' );
345 my $unlinked_item_subfields = _get_unlinked_item_subfields($temp_item_marc, $frameworkcode);
346 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
347 $item->{'biblionumber'} = $biblionumber;
348 $item->{'biblioitemnumber'} = $biblioitemnumber;
350 # check for duplicate barcode
351 my %item_errors = CheckItemPreSave($item);
353 push @errors, _repack_item_errors($item_sequence_num, $item, \%item_errors);
354 push @bad_item_fields, $item_field;
358 _set_defaults_for_add($item);
359 _set_derived_columns_for_add($item);
360 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
361 warn $error if $error;
362 push @itemnumbers, $itemnumber; # FIXME not checking error
363 $item->{'itemnumber'} = $itemnumber;
365 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
367 my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
368 $item_field->replace_with($new_item_marc->field($itemtag));
371 # remove any MARC item fields for rejected items
372 foreach my $item_field (@bad_item_fields) {
373 $record->delete_field($item_field);
376 # update the MARC biblio
377 # $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode );
379 return (\@itemnumbers, \@errors);
382 =head2 ModItemFromMarc
384 ModItemFromMarc($item_marc, $biblionumber, $itemnumber);
386 This function updates an item record based on a supplied
387 C<MARC::Record> object containing an embedded item field.
388 This API is meant for the use of C<additem.pl>; for
389 other purposes, C<ModItem> should be used.
391 This function uses the hash %default_values_for_mod_from_marc,
392 which contains default values for item fields to
393 apply when modifying an item. This is needed beccause
394 if an item field's value is cleared, TransformMarcToKoha
395 does not include the column in the
396 hash that's passed to ModItem, which without
397 use of this hash makes it impossible to clear
398 an item field's value. See bug 2466.
400 Note that only columns that can be directly
401 changed from the cataloging and serials
402 item editors are included in this hash.
406 my %default_values_for_mod_from_marc = (
408 booksellerid => undef,
410 'items.cn_source' => undef,
413 # dateaccessioned => undef,
415 holdingbranch => undef,
417 itemcallnumber => undef,
422 permanent_location => undef,
427 replacementprice => undef,
428 replacementpricedate => undef,
431 stocknumber => undef,
436 sub ModItemFromMarc {
437 my $item_marc = shift;
438 my $biblionumber = shift;
439 my $itemnumber = shift;
441 my $dbh = C4::Context->dbh;
442 my $frameworkcode = GetFrameworkCode($biblionumber);
443 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
445 my $localitemmarc = MARC::Record->new;
446 $localitemmarc->append_fields( $item_marc->field($itemtag) );
447 my $item = &TransformMarcToKoha( $dbh, $localitemmarc, $frameworkcode, 'items' );
448 foreach my $item_field ( keys %default_values_for_mod_from_marc ) {
449 $item->{$item_field} = $default_values_for_mod_from_marc{$item_field} unless (exists $item->{$item_field});
451 my $unlinked_item_subfields = _get_unlinked_item_subfields( $localitemmarc, $frameworkcode );
453 return ModItem($item, $biblionumber, $itemnumber, $dbh, $frameworkcode, $unlinked_item_subfields);
458 ModItem({ column => $newvalue }, $biblionumber,
459 $itemnumber[, $original_item_marc]);
461 Change one or more columns in an item record and update
462 the MARC representation of the item.
464 The first argument is a hashref mapping from item column
465 names to the new values. The second and third arguments
466 are the biblionumber and itemnumber, respectively.
468 The fourth, optional parameter, C<$unlinked_item_subfields>, contains
469 an arrayref containing subfields present in the original MARC
470 representation of the item (e.g., from the item editor) that are
471 not mapped to C<items> columns directly but should instead
472 be stored in C<items.more_subfields_xml> and included in
473 the biblio items tag for display and indexing.
475 If one of the changed columns is used to calculate
476 the derived value of a column such as C<items.cn_sort>,
477 this routine will perform the necessary calculation
484 my $biblionumber = shift;
485 my $itemnumber = shift;
487 # if $biblionumber is undefined, get it from the current item
488 unless (defined $biblionumber) {
489 $biblionumber = _get_single_item_column('biblionumber', $itemnumber);
492 my $dbh = @_ ? shift : C4::Context->dbh;
493 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
495 my $unlinked_item_subfields;
497 $unlinked_item_subfields = shift;
498 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
501 $item->{'itemnumber'} = $itemnumber or return undef;
502 _set_derived_columns_for_mod($item);
503 _do_column_fixes_for_mod($item);
506 # attempt to change itemnumber
507 # attempt to change biblionumber (if we want
508 # an API to relink an item to a different bib,
509 # it should be a separate function)
512 _koha_modify_item($item);
514 # request that bib be reindexed so that searching on current
515 # item status is possible
516 ModZebra( $biblionumber, "specialUpdate", "biblioserver", undef, undef );
518 logaction("CATALOGUING", "MODIFY", $itemnumber, Dumper($item)) if C4::Context->preference("CataloguingLog");
521 =head2 ModItemTransfer
523 ModItemTransfer($itenumber, $frombranch, $tobranch);
525 Marks an item as being transferred from one branch
530 sub ModItemTransfer {
531 my ( $itemnumber, $frombranch, $tobranch ) = @_;
533 my $dbh = C4::Context->dbh;
535 #new entry in branchtransfers....
536 my $sth = $dbh->prepare(
537 "INSERT INTO branchtransfers (itemnumber, frombranch, datesent, tobranch)
538 VALUES (?, ?, NOW(), ?)");
539 $sth->execute($itemnumber, $frombranch, $tobranch);
541 ModItem({ holdingbranch => $tobranch }, undef, $itemnumber);
542 ModDateLastSeen($itemnumber);
546 =head2 ModDateLastSeen
548 ModDateLastSeen($itemnum);
550 Mark item as seen. Is called when an item is issued, returned or manually marked during inventory/stocktaking.
551 C<$itemnum> is the item number
555 sub ModDateLastSeen {
556 my ($itemnumber) = @_;
558 my $today = C4::Dates->new();
559 ModItem({ itemlost => 0, datelastseen => $today->output("iso") }, undef, $itemnumber);
564 DelItem($dbh, $biblionumber, $itemnumber);
566 Exported function (core API) for deleting an item record in Koha.
571 my ( $dbh, $biblionumber, $itemnumber ) = @_;
573 # FIXME check the item has no current issues
575 _koha_delete_item( $dbh, $itemnumber );
577 # get the MARC record
578 my $record = GetMarcBiblio($biblionumber);
579 ModZebra( $biblionumber, "specialUpdate", "biblioserver", undef, undef );
582 my $copy2deleted = $dbh->prepare("UPDATE deleteditems SET marc=? WHERE itemnumber=?");
583 $copy2deleted->execute( $record->as_usmarc(), $itemnumber );
585 #search item field code
586 logaction("CATALOGUING", "DELETE", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
589 =head2 CheckItemPreSave
591 my $item_ref = TransformMarcToKoha($marc, 'items');
593 my %errors = CheckItemPreSave($item_ref);
594 if (exists $errors{'duplicate_barcode'}) {
595 print "item has duplicate barcode: ", $errors{'duplicate_barcode'}, "\n";
596 } elsif (exists $errors{'invalid_homebranch'}) {
597 print "item has invalid home branch: ", $errors{'invalid_homebranch'}, "\n";
598 } elsif (exists $errors{'invalid_holdingbranch'}) {
599 print "item has invalid holding branch: ", $errors{'invalid_holdingbranch'}, "\n";
604 Given a hashref containing item fields, determine if it can be
605 inserted or updated in the database. Specifically, checks for
606 database integrity issues, and returns a hash containing any
607 of the following keys, if applicable.
611 =item duplicate_barcode
613 Barcode, if it duplicates one already found in the database.
615 =item invalid_homebranch
617 Home branch, if not defined in branches table.
619 =item invalid_holdingbranch
621 Holding branch, if not defined in branches table.
625 This function does NOT implement any policy-related checks,
626 e.g., whether current operator is allowed to save an
627 item that has a given branch code.
631 sub CheckItemPreSave {
632 my $item_ref = shift;
636 # check for duplicate barcode
637 if (exists $item_ref->{'barcode'} and defined $item_ref->{'barcode'}) {
638 my $existing_itemnumber = GetItemnumberFromBarcode($item_ref->{'barcode'});
639 if ($existing_itemnumber) {
640 if (!exists $item_ref->{'itemnumber'} # new item
641 or $item_ref->{'itemnumber'} != $existing_itemnumber) { # existing item
642 $errors{'duplicate_barcode'} = $item_ref->{'barcode'};
647 # check for valid home branch
648 if (exists $item_ref->{'homebranch'} and defined $item_ref->{'homebranch'}) {
649 my $branch_name = GetBranchName($item_ref->{'homebranch'});
650 unless (defined $branch_name) {
651 # relies on fact that branches.branchname is a non-NULL column,
652 # so GetBranchName returns undef only if branch does not exist
653 $errors{'invalid_homebranch'} = $item_ref->{'homebranch'};
657 # check for valid holding branch
658 if (exists $item_ref->{'holdingbranch'} and defined $item_ref->{'holdingbranch'}) {
659 my $branch_name = GetBranchName($item_ref->{'holdingbranch'});
660 unless (defined $branch_name) {
661 # relies on fact that branches.branchname is a non-NULL column,
662 # so GetBranchName returns undef only if branch does not exist
663 $errors{'invalid_holdingbranch'} = $item_ref->{'holdingbranch'};
671 =head1 EXPORTED SPECIAL ACCESSOR FUNCTIONS
673 The following functions provide various ways of
674 getting an item record, a set of item records, or
675 lists of authorized values for certain item fields.
677 Some of the functions in this group are candidates
678 for refactoring -- for example, some of the code
679 in C<GetItemsByBiblioitemnumber> and C<GetItemsInfo>
680 has copy-and-paste work.
686 $itemstatushash = GetItemStatus($fwkcode);
688 Returns a list of valid values for the
689 C<items.notforloan> field.
691 NOTE: does B<not> return an individual item's
694 Can be MARC dependant.
696 But basically could be can be loan or not
697 Create a status selector with the following code
699 =head3 in PERL SCRIPT
701 my $itemstatushash = getitemstatus;
703 foreach my $thisstatus (keys %$itemstatushash) {
704 my %row =(value => $thisstatus,
705 statusname => $itemstatushash->{$thisstatus}->{'statusname'},
707 push @itemstatusloop, \%row;
709 $template->param(statusloop=>\@itemstatusloop);
713 <select name="statusloop">
714 <option value="">Default</option>
715 <!-- TMPL_LOOP name="statusloop" -->
716 <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="statusname" --></option>
724 # returns a reference to a hash of references to status...
727 my $dbh = C4::Context->dbh;
729 $fwk = '' unless ($fwk);
730 my ( $tag, $subfield ) =
731 GetMarcFromKohaField( "items.notforloan", $fwk );
732 if ( $tag and $subfield ) {
735 "SELECT authorised_value
736 FROM marc_subfield_structure
742 $sth->execute( $tag, $subfield, $fwk );
743 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
746 "SELECT authorised_value,lib
747 FROM authorised_values
752 $authvalsth->execute($authorisedvaluecat);
753 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
754 $itemstatus{$authorisedvalue} = $lib;
768 $itemstatus{"1"} = "Not For Loan";
772 =head2 GetItemLocation
774 $itemlochash = GetItemLocation($fwk);
776 Returns a list of valid values for the
777 C<items.location> field.
779 NOTE: does B<not> return an individual item's
782 where fwk stands for an optional framework code.
783 Create a location selector with the following code
785 =head3 in PERL SCRIPT
787 my $itemlochash = getitemlocation;
789 foreach my $thisloc (keys %$itemlochash) {
790 my $selected = 1 if $thisbranch eq $branch;
791 my %row =(locval => $thisloc,
792 selected => $selected,
793 locname => $itemlochash->{$thisloc},
795 push @itemlocloop, \%row;
797 $template->param(itemlocationloop => \@itemlocloop);
801 <select name="location">
802 <option value="">Default</option>
803 <!-- TMPL_LOOP name="itemlocationloop" -->
804 <option value="<!-- TMPL_VAR name="locval" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="locname" --></option>
810 sub GetItemLocation {
812 # returns a reference to a hash of references to location...
815 my $dbh = C4::Context->dbh;
817 $fwk = '' unless ($fwk);
818 my ( $tag, $subfield ) =
819 GetMarcFromKohaField( "items.location", $fwk );
820 if ( $tag and $subfield ) {
823 "SELECT authorised_value
824 FROM marc_subfield_structure
829 $sth->execute( $tag, $subfield, $fwk );
830 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
833 "SELECT authorised_value,lib
834 FROM authorised_values
838 $authvalsth->execute($authorisedvaluecat);
839 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
840 $itemlocation{$authorisedvalue} = $lib;
842 return \%itemlocation;
854 $itemlocation{"1"} = "Not For Loan";
855 return \%itemlocation;
860 $items = GetLostItems( $where, $orderby );
862 This function gets a list of lost items.
868 C<$where> is a hashref. it containts a field of the items table as key
869 and the value to match as value. For example:
871 { barcode => 'abc123',
872 homebranch => 'CPL', }
874 C<$orderby> is a field of the items table by which the resultset
879 C<$items> is a reference to an array full of hashrefs with columns
880 from the "items" table as keys.
882 =item usage in the perl script:
884 my $where = { barcode => '0001548' };
885 my $items = GetLostItems( $where, "homebranch" );
886 $template->param( itemsloop => $items );
893 # Getting input args.
896 my $dbh = C4::Context->dbh;
901 LEFT JOIN biblio ON (items.biblionumber = biblio.biblionumber)
902 LEFT JOIN biblioitems ON (items.biblionumber = biblioitems.biblionumber)
903 LEFT JOIN authorised_values ON (items.itemlost = authorised_values.authorised_value)
905 authorised_values.category = 'LOST'
906 AND itemlost IS NOT NULL
909 my @query_parameters;
910 foreach my $key (keys %$where) {
911 $query .= " AND $key LIKE ?";
912 push @query_parameters, "%$where->{$key}%";
914 my @ordervalues = qw/title author homebranch itype barcode price replacementprice lib datelastseen location/;
916 if ( defined $orderby && grep($orderby, @ordervalues)) {
917 $query .= ' ORDER BY '.$orderby;
920 my $sth = $dbh->prepare($query);
921 $sth->execute( @query_parameters );
923 while ( my $row = $sth->fetchrow_hashref ){
929 =head2 GetItemsForInventory
931 $itemlist = GetItemsForInventory($minlocation, $maxlocation,
932 $location, $itemtype $datelastseen, $branch,
933 $offset, $size, $statushash);
935 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
937 The sub returns a reference to a list of hashes, each containing
938 itemnumber, author, title, barcode, item callnumber, and date last
939 seen. It is ordered by callnumber then title.
941 The required minlocation & maxlocation parameters are used to specify a range of item callnumbers
942 the datelastseen can be used to specify that you want to see items not seen since a past date only.
943 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
944 $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.
948 sub GetItemsForInventory {
949 my ( $minlocation, $maxlocation,$location, $itemtype, $ignoreissued, $datelastseen, $branchcode, $branch, $offset, $size, $statushash ) = @_;
950 my $dbh = C4::Context->dbh;
951 my ( @bind_params, @where_strings );
953 my $query = <<'END_SQL';
954 SELECT items.itemnumber, barcode, itemcallnumber, title, author, biblio.biblionumber, datelastseen
956 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
957 LEFT JOIN biblioitems on items.biblionumber = biblioitems.biblionumber
960 for my $authvfield (keys %$statushash){
961 if ( scalar @{$statushash->{$authvfield}} > 0 ){
962 my $joinedvals = join ',', @{$statushash->{$authvfield}};
963 push @where_strings, "$authvfield in (" . $joinedvals . ")";
969 push @where_strings, 'itemcallnumber >= ?';
970 push @bind_params, $minlocation;
974 push @where_strings, 'itemcallnumber <= ?';
975 push @bind_params, $maxlocation;
979 $datelastseen = format_date_in_iso($datelastseen);
980 push @where_strings, '(datelastseen < ? OR datelastseen IS NULL)';
981 push @bind_params, $datelastseen;
985 push @where_strings, 'items.location = ?';
986 push @bind_params, $location;
990 if($branch eq "homebranch"){
991 push @where_strings, 'items.homebranch = ?';
993 push @where_strings, 'items.holdingbranch = ?';
995 push @bind_params, $branchcode;
999 push @where_strings, 'biblioitems.itemtype = ?';
1000 push @bind_params, $itemtype;
1003 if ( $ignoreissued) {
1004 $query .= "LEFT JOIN issues ON items.itemnumber = issues.itemnumber ";
1005 push @where_strings, 'issues.date_due IS NULL';
1008 if ( @where_strings ) {
1010 $query .= join ' AND ', @where_strings;
1012 $query .= ' ORDER BY items.cn_sort, itemcallnumber, title';
1013 my $sth = $dbh->prepare($query);
1014 $sth->execute( @bind_params );
1018 while ( my $row = $sth->fetchrow_hashref ) {
1019 $offset-- if ($offset);
1020 $row->{datelastseen}=format_date($row->{datelastseen});
1021 if ( ( !$offset ) && $size ) {
1022 push @results, $row;
1029 =head2 GetItemsCount
1031 $count = &GetItemsCount( $biblionumber);
1033 This function return count of item with $biblionumber
1038 my ( $biblionumber ) = @_;
1039 my $dbh = C4::Context->dbh;
1040 my $query = "SELECT count(*)
1042 WHERE biblionumber=?";
1043 my $sth = $dbh->prepare($query);
1044 $sth->execute($biblionumber);
1045 my $count = $sth->fetchrow;
1049 =head2 GetItemInfosOf
1051 GetItemInfosOf(@itemnumbers);
1055 sub GetItemInfosOf {
1056 my @itemnumbers = @_;
1061 WHERE itemnumber IN (' . join( ',', @itemnumbers ) . ')
1063 return get_infos_of( $query, 'itemnumber' );
1066 =head2 GetItemsByBiblioitemnumber
1068 GetItemsByBiblioitemnumber($biblioitemnumber);
1070 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1071 Called by C<C4::XISBN>
1075 sub GetItemsByBiblioitemnumber {
1076 my ( $bibitem ) = @_;
1077 my $dbh = C4::Context->dbh;
1078 my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1079 # Get all items attached to a biblioitem
1082 $sth->execute($bibitem) || die $sth->errstr;
1083 while ( my $data = $sth->fetchrow_hashref ) {
1084 # Foreach item, get circulation information
1085 my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1086 WHERE itemnumber = ?
1087 AND issues.borrowernumber = borrowers.borrowernumber"
1089 $sth2->execute( $data->{'itemnumber'} );
1090 if ( my $data2 = $sth2->fetchrow_hashref ) {
1091 # if item is out, set the due date and who it is out too
1092 $data->{'date_due'} = $data2->{'date_due'};
1093 $data->{'cardnumber'} = $data2->{'cardnumber'};
1094 $data->{'borrowernumber'} = $data2->{'borrowernumber'};
1097 # set date_due to blank, so in the template we check itemlost, and wthdrawn
1098 $data->{'date_due'} = '';
1100 # Find the last 3 people who borrowed this item.
1101 my $query2 = "SELECT * FROM old_issues, borrowers WHERE itemnumber = ?
1102 AND old_issues.borrowernumber = borrowers.borrowernumber
1103 ORDER BY returndate desc,timestamp desc LIMIT 3";
1104 $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1105 $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1107 while ( my $data2 = $sth2->fetchrow_hashref ) {
1108 $data->{"timestamp$i2"} = $data2->{'timestamp'};
1109 $data->{"card$i2"} = $data2->{'cardnumber'};
1110 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
1113 push(@results,$data);
1120 @results = GetItemsInfo($biblionumber);
1122 Returns information about items with the given biblionumber.
1124 C<GetItemsInfo> returns a list of references-to-hash. Each element
1125 contains a number of keys. Most of them are attributes from the
1126 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
1127 Koha database. Other keys include:
1131 =item C<$data-E<gt>{branchname}>
1133 The name (not the code) of the branch to which the book belongs.
1135 =item C<$data-E<gt>{datelastseen}>
1137 This is simply C<items.datelastseen>, except that while the date is
1138 stored in YYYY-MM-DD format in the database, here it is converted to
1139 DD/MM/YYYY format. A NULL date is returned as C<//>.
1141 =item C<$data-E<gt>{datedue}>
1143 =item C<$data-E<gt>{class}>
1145 This is the concatenation of C<biblioitems.classification>, the book's
1146 Dewey code, and C<biblioitems.subclass>.
1148 =item C<$data-E<gt>{ocount}>
1150 I think this is the number of copies of the book available.
1152 =item C<$data-E<gt>{order}>
1154 If this is set, it is set to C<One Order>.
1161 my ( $biblionumber ) = @_;
1162 my $dbh = C4::Context->dbh;
1163 # note biblioitems.* must be avoided to prevent large marc and marcxml fields from killing performance.
1169 biblioitems.itemtype,
1172 biblioitems.publicationyear,
1173 biblioitems.publishercode,
1174 biblioitems.volumedate,
1175 biblioitems.volumedesc,
1178 items.notforloan as itemnotforloan,
1179 itemtypes.description,
1180 itemtypes.notforloan as notforloan_per_itemtype,
1183 LEFT JOIN branches ON items.holdingbranch = branches.branchcode
1184 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1185 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1186 LEFT JOIN itemtypes ON itemtypes.itemtype = "
1187 . (C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype');
1188 $query .= " WHERE items.biblionumber = ? ORDER BY branches.branchname,items.dateaccessioned desc" ;
1189 my $sth = $dbh->prepare($query);
1190 $sth->execute($biblionumber);
1195 my $isth = $dbh->prepare(
1196 "SELECT issues.*,borrowers.cardnumber,borrowers.surname,borrowers.firstname,borrowers.branchcode as bcode
1197 FROM issues LEFT JOIN borrowers ON issues.borrowernumber=borrowers.borrowernumber
1198 WHERE itemnumber = ?"
1200 my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=? ");
1201 while ( my $data = $sth->fetchrow_hashref ) {
1204 $isth->execute( $data->{'itemnumber'} );
1205 if ( my $idata = $isth->fetchrow_hashref ) {
1206 $data->{borrowernumber} = $idata->{borrowernumber};
1207 $data->{cardnumber} = $idata->{cardnumber};
1208 $data->{surname} = $idata->{surname};
1209 $data->{firstname} = $idata->{firstname};
1210 $datedue = $idata->{'date_due'};
1211 if (C4::Context->preference("IndependantBranches")){
1212 my $userenv = C4::Context->userenv;
1213 if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
1214 $data->{'NOTSAMEBRANCH'} = 1 if ($idata->{'bcode'} ne $userenv->{branch});
1218 if ( $data->{'serial'}) {
1219 $ssth->execute($data->{'itemnumber'}) ;
1220 ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
1223 if ( $datedue eq '' ) {
1224 my ( $restype, $reserves ) =
1225 C4::Reserves::CheckReserves( $data->{'itemnumber'} );
1226 # Previous conditional check with if ($restype) is not needed because a true
1227 # result for one item will result in subsequent items defaulting to this true
1229 $count_reserves = $restype;
1231 #get branch information.....
1232 my $bsth = $dbh->prepare(
1233 "SELECT * FROM branches WHERE branchcode = ?
1236 $bsth->execute( $data->{'holdingbranch'} );
1237 if ( my $bdata = $bsth->fetchrow_hashref ) {
1238 $data->{'branchname'} = $bdata->{'branchname'};
1240 $data->{'datedue'} = $datedue;
1241 $data->{'count_reserves'} = $count_reserves;
1243 # get notforloan complete status if applicable
1244 my $sthnflstatus = $dbh->prepare(
1245 'SELECT authorised_value
1246 FROM marc_subfield_structure
1247 WHERE kohafield="items.notforloan"
1251 $sthnflstatus->execute;
1252 my ($authorised_valuecode) = $sthnflstatus->fetchrow;
1253 if ($authorised_valuecode) {
1254 $sthnflstatus = $dbh->prepare(
1255 "SELECT lib FROM authorised_values
1257 AND authorised_value=?"
1259 $sthnflstatus->execute( $authorised_valuecode,
1260 $data->{itemnotforloan} );
1261 my ($lib) = $sthnflstatus->fetchrow;
1262 $data->{notforloanvalue} = $lib;
1265 # get restricted status and description if applicable
1266 my $restrictedstatus = $dbh->prepare(
1267 'SELECT authorised_value
1268 FROM marc_subfield_structure
1269 WHERE kohafield="items.restricted"
1273 $restrictedstatus->execute;
1274 ($authorised_valuecode) = $restrictedstatus->fetchrow;
1275 if ($authorised_valuecode) {
1276 $restrictedstatus = $dbh->prepare(
1277 "SELECT lib,lib_opac FROM authorised_values
1279 AND authorised_value=?"
1281 $restrictedstatus->execute( $authorised_valuecode,
1282 $data->{restricted} );
1284 if ( my $rstdata = $restrictedstatus->fetchrow_hashref ) {
1285 $data->{restricted} = $rstdata->{'lib'};
1286 $data->{restrictedopac} = $rstdata->{'lib_opac'};
1290 # my stack procedures
1291 my $stackstatus = $dbh->prepare(
1292 'SELECT authorised_value
1293 FROM marc_subfield_structure
1294 WHERE kohafield="items.stack"
1297 $stackstatus->execute;
1299 ($authorised_valuecode) = $stackstatus->fetchrow;
1300 if ($authorised_valuecode) {
1301 $stackstatus = $dbh->prepare(
1303 FROM authorised_values
1305 AND authorised_value=?
1308 $stackstatus->execute( $authorised_valuecode, $data->{stack} );
1309 my ($lib) = $stackstatus->fetchrow;
1310 $data->{stack} = $lib;
1312 # Find the last 3 people who borrowed this item.
1313 my $sth2 = $dbh->prepare("SELECT * FROM old_issues,borrowers
1314 WHERE itemnumber = ?
1315 AND old_issues.borrowernumber = borrowers.borrowernumber
1316 ORDER BY returndate DESC
1318 $sth2->execute($data->{'itemnumber'});
1320 while (my $data2 = $sth2->fetchrow_hashref()) {
1321 $data->{"timestamp$ii"} = $data2->{'timestamp'} if $data2->{'timestamp'};
1322 $data->{"card$ii"} = $data2->{'cardnumber'} if $data2->{'cardnumber'};
1323 $data->{"borrower$ii"} = $data2->{'borrowernumber'} if $data2->{'borrowernumber'};
1327 $results[$i] = $data;
1331 return( sort { ($b->{'publisheddate'} || $b->{'enumchron'}) cmp ($a->{'publisheddate'} || $a->{'enumchron'}) } @results );
1337 =head2 GetItemsLocationInfo
1339 my @itemlocinfo = GetItemsLocationInfo($biblionumber);
1341 Returns the branch names, shelving location and itemcallnumber for each item attached to the biblio in question
1343 C<GetItemsInfo> returns a list of references-to-hash. Data returned:
1347 =item C<$data-E<gt>{homebranch}>
1349 Branch Name of the item's homebranch
1351 =item C<$data-E<gt>{holdingbranch}>
1353 Branch Name of the item's holdingbranch
1355 =item C<$data-E<gt>{location}>
1357 Item's shelving location code
1359 =item C<$data-E<gt>{location_intranet}>
1361 The intranet description for the Shelving Location as set in authorised_values 'LOC'
1363 =item C<$data-E<gt>{location_opac}>
1365 The OPAC description for the Shelving Location as set in authorised_values 'LOC'. Falls back to intranet description if no OPAC
1368 =item C<$data-E<gt>{itemcallnumber}>
1370 Item's itemcallnumber
1372 =item C<$data-E<gt>{cn_sort}>
1374 Item's call number normalized for sorting
1380 sub GetItemsLocationInfo {
1381 my $biblionumber = shift;
1384 my $dbh = C4::Context->dbh;
1385 my $query = "SELECT a.branchname as homebranch, b.branchname as holdingbranch,
1386 location, itemcallnumber, cn_sort
1387 FROM items, branches as a, branches as b
1388 WHERE homebranch = a.branchcode AND holdingbranch = b.branchcode
1389 AND biblionumber = ?
1390 ORDER BY cn_sort ASC";
1391 my $sth = $dbh->prepare($query);
1392 $sth->execute($biblionumber);
1394 while ( my $data = $sth->fetchrow_hashref ) {
1395 $data->{location_intranet} = GetKohaAuthorisedValueLib('LOC', $data->{location});
1396 $data->{location_opac}= GetKohaAuthorisedValueLib('LOC', $data->{location}, 1);
1397 push @results, $data;
1402 =head2 GetHostItemsInfo
1404 $hostiteminfo = GetHostItemsInfo($hostfield);
1405 Returns the iteminfo for items linked to records via a host field
1409 sub GetHostItemsInfo {
1411 my @returnitemsInfo;
1413 if (C4::Context->preference('marcflavour') eq 'MARC21' ||
1414 C4::Context->preference('marcflavour') eq 'NORMARC'){
1415 foreach my $hostfield ( $record->field('773') ) {
1416 my $hostbiblionumber = $hostfield->subfield("0");
1417 my $linkeditemnumber = $hostfield->subfield("9");
1418 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1419 foreach my $hostitemInfo (@hostitemInfos){
1420 if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1421 push (@returnitemsInfo,$hostitemInfo);
1426 } elsif ( C4::Context->preference('marcflavour') eq 'UNIMARC'){
1427 foreach my $hostfield ( $record->field('461') ) {
1428 my $hostbiblionumber = $hostfield->subfield("0");
1429 my $linkeditemnumber = $hostfield->subfield("9");
1430 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1431 foreach my $hostitemInfo (@hostitemInfos){
1432 if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1433 push (@returnitemsInfo,$hostitemInfo);
1439 return @returnitemsInfo;
1443 =head2 GetLastAcquisitions
1445 my $lastacq = GetLastAcquisitions({'branches' => ('branch1','branch2'),
1446 'itemtypes' => ('BK','BD')}, 10);
1450 sub GetLastAcquisitions {
1451 my ($data,$max) = @_;
1453 my $itemtype = C4::Context->preference('item-level_itypes') ? 'itype' : 'itemtype';
1455 my $number_of_branches = @{$data->{branches}};
1456 my $number_of_itemtypes = @{$data->{itemtypes}};
1459 my @where = ('WHERE 1 ');
1460 $number_of_branches and push @where
1461 , 'AND holdingbranch IN ('
1462 , join(',', ('?') x $number_of_branches )
1466 $number_of_itemtypes and push @where
1467 , "AND $itemtype IN ("
1468 , join(',', ('?') x $number_of_itemtypes )
1472 my $query = "SELECT biblio.biblionumber as biblionumber, title, dateaccessioned
1473 FROM items RIGHT JOIN biblio ON (items.biblionumber=biblio.biblionumber)
1474 RIGHT JOIN biblioitems ON (items.biblioitemnumber=biblioitems.biblioitemnumber)
1476 GROUP BY biblio.biblionumber
1477 ORDER BY dateaccessioned DESC LIMIT $max";
1479 my $dbh = C4::Context->dbh;
1480 my $sth = $dbh->prepare($query);
1482 $sth->execute((@{$data->{branches}}, @{$data->{itemtypes}}));
1485 while( my $row = $sth->fetchrow_hashref){
1486 push @results, {date => $row->{dateaccessioned}
1487 , biblionumber => $row->{biblionumber}
1488 , title => $row->{title}};
1494 =head2 get_itemnumbers_of
1496 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1498 Given a list of biblionumbers, return the list of corresponding itemnumbers
1499 for each biblionumber.
1501 Return a reference on a hash where keys are biblionumbers and values are
1502 references on array of itemnumbers.
1506 sub get_itemnumbers_of {
1507 my @biblionumbers = @_;
1509 my $dbh = C4::Context->dbh;
1515 WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1517 my $sth = $dbh->prepare($query);
1518 $sth->execute(@biblionumbers);
1522 while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1523 push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1526 return \%itemnumbers_of;
1529 =head2 get_hostitemnumbers_of
1531 my @itemnumbers_of = get_hostitemnumbers_of($biblionumber);
1533 Given a biblionumber, return the list of corresponding itemnumbers that are linked to it via host fields
1535 Return a reference on a hash where key is a biblionumber and values are
1536 references on array of itemnumbers.
1541 sub get_hostitemnumbers_of {
1542 my ($biblionumber) = @_;
1543 my $marcrecord = GetMarcBiblio($biblionumber);
1544 my (@returnhostitemnumbers,$tag, $biblio_s, $item_s);
1546 my $marcflavor = C4::Context->preference('marcflavour');
1547 if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1551 } elsif ($marcflavor eq 'UNIMARC') {
1557 foreach my $hostfield ( $marcrecord->field($tag) ) {
1558 my $hostbiblionumber = $hostfield->subfield($biblio_s);
1559 my $linkeditemnumber = $hostfield->subfield($item_s);
1561 if (my $itemnumbers = get_itemnumbers_of($hostbiblionumber)->{$hostbiblionumber})
1563 @itemnumbers = @$itemnumbers;
1565 foreach my $itemnumber (@itemnumbers){
1566 if ($itemnumber eq $linkeditemnumber){
1567 push (@returnhostitemnumbers,$itemnumber);
1572 return @returnhostitemnumbers;
1576 =head2 GetItemnumberFromBarcode
1578 $result = GetItemnumberFromBarcode($barcode);
1582 sub GetItemnumberFromBarcode {
1584 my $dbh = C4::Context->dbh;
1587 $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1588 $rq->execute($barcode);
1589 my ($result) = $rq->fetchrow;
1593 =head2 GetBarcodeFromItemnumber
1595 $result = GetBarcodeFromItemnumber($itemnumber);
1599 sub GetBarcodeFromItemnumber {
1600 my ($itemnumber) = @_;
1601 my $dbh = C4::Context->dbh;
1604 $dbh->prepare("SELECT barcode FROM items WHERE items.itemnumber=?");
1605 $rq->execute($itemnumber);
1606 my ($result) = $rq->fetchrow;
1610 =head2 GetHiddenItemnumbers
1614 $result = GetHiddenItemnumbers(@items);
1620 sub GetHiddenItemnumbers {
1624 my $yaml = C4::Context->preference('OpacHiddenItems');
1627 $hidingrules = YAML::Load($yaml);
1630 warn "Unable to parse OpacHiddenItems syspref : $@";
1633 my $dbh = C4::Context->dbh;
1636 foreach my $item (@items) {
1638 # We check each rule
1639 foreach my $field (keys %$hidingrules) {
1640 my $query = "SELECT $field from items where itemnumber = ?";
1641 my $sth = $dbh->prepare($query);
1642 $sth->execute($item->{'itemnumber'});
1643 my ($result) = $sth->fetchrow;
1645 # If the results matches the values in the yaml file
1646 if (any { $result eq $_ } @{$hidingrules->{$field}}) {
1648 # We add the itemnumber to the list
1649 push @resultitems, $item->{'itemnumber'};
1651 # If at least one rule matched for an item, no need to test the others
1656 return @resultitems;
1661 =head3 get_item_authorised_values
1663 find the types and values for all authorised values assigned to this item.
1665 parameters: itemnumber
1667 returns: a hashref malling the authorised value to the value set for this itemnumber
1669 $authorised_values = {
1675 'RESTRICTED' => undef,
1678 'branches' => 'CPL',
1679 'cn_source' => undef,
1680 'itemtypes' => 'SER',
1683 Notes: see C4::Biblio::get_biblio_authorised_values for a similar method at the biblio level.
1687 sub get_item_authorised_values {
1688 my $itemnumber = shift;
1690 # assume that these entries in the authorised_value table are item level.
1691 my $query = q(SELECT distinct authorised_value, kohafield
1692 FROM marc_subfield_structure
1693 WHERE kohafield like 'item%'
1694 AND authorised_value != '' );
1696 my $itemlevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
1697 my $iteminfo = GetItem( $itemnumber );
1698 # warn( Data::Dumper->Dump( [ $itemlevel_authorised_values ], [ 'itemlevel_authorised_values' ] ) );
1700 foreach my $this_authorised_value ( keys %$itemlevel_authorised_values ) {
1701 my $field = $itemlevel_authorised_values->{ $this_authorised_value }->{'kohafield'};
1702 $field =~ s/^items\.//;
1703 if ( exists $iteminfo->{ $field } ) {
1704 $return->{ $this_authorised_value } = $iteminfo->{ $field };
1707 # warn( Data::Dumper->Dump( [ $return ], [ 'return' ] ) );
1711 =head3 get_authorised_value_images
1713 find a list of icons that are appropriate for display based on the
1714 authorised values for a biblio.
1716 parameters: listref of authorised values, such as comes from
1717 get_item_authorised_values or
1718 from C4::Biblio::get_biblio_authorised_values
1720 returns: listref of hashrefs for each image. Each hashref looks like this:
1722 { imageurl => '/intranet-tmpl/prog/img/itemtypeimg/npl/WEB.gif',
1727 Notes: Currently, I put on the full path to the images on the staff
1728 side. This should either be configurable or not done at all. Since I
1729 have to deal with 'intranet' or 'opac' in
1730 get_biblio_authorised_values, perhaps I should be passing it in.
1734 sub get_authorised_value_images {
1735 my $authorised_values = shift;
1739 my $authorised_value_list = GetAuthorisedValues();
1740 # warn ( Data::Dumper->Dump( [ $authorised_value_list ], [ 'authorised_value_list' ] ) );
1741 foreach my $this_authorised_value ( @$authorised_value_list ) {
1742 if ( exists $authorised_values->{ $this_authorised_value->{'category'} }
1743 && $authorised_values->{ $this_authorised_value->{'category'} } eq $this_authorised_value->{'authorised_value'} ) {
1744 # warn ( Data::Dumper->Dump( [ $this_authorised_value ], [ 'this_authorised_value' ] ) );
1745 if ( defined $this_authorised_value->{'imageurl'} ) {
1746 push @imagelist, { imageurl => C4::Koha::getitemtypeimagelocation( 'intranet', $this_authorised_value->{'imageurl'} ),
1747 label => $this_authorised_value->{'lib'},
1748 category => $this_authorised_value->{'category'},
1749 value => $this_authorised_value->{'authorised_value'}, };
1754 # warn ( Data::Dumper->Dump( [ \@imagelist ], [ 'imagelist' ] ) );
1759 =head1 LIMITED USE FUNCTIONS
1761 The following functions, while part of the public API,
1762 are not exported. This is generally because they are
1763 meant to be used by only one script for a specific
1764 purpose, and should not be used in any other context
1765 without careful thought.
1771 my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1773 Returns MARC::Record of the item passed in parameter.
1774 This function is meant for use only in C<cataloguing/additem.pl>,
1775 where it is needed to support that script's MARC-like
1781 my ( $biblionumber, $itemnumber ) = @_;
1783 # GetMarcItem has been revised so that it does the following:
1784 # 1. Gets the item information from the items table.
1785 # 2. Converts it to a MARC field for storage in the bib record.
1787 # The previous behavior was:
1788 # 1. Get the bib record.
1789 # 2. Return the MARC tag corresponding to the item record.
1791 # The difference is that one treats the items row as authoritative,
1792 # while the other treats the MARC representation as authoritative
1793 # under certain circumstances.
1795 my $itemrecord = GetItem($itemnumber);
1797 # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1798 # Also, don't emit a subfield if the underlying field is blank.
1801 return Item2Marc($itemrecord,$biblionumber);
1805 my ($itemrecord,$biblionumber)=@_;
1808 defined($itemrecord->{$_}) && $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : ()
1809 } keys %{ $itemrecord }
1811 my $itemmarc = TransformKohaToMarc($mungeditem);
1812 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",GetFrameworkCode($biblionumber)||'');
1814 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1815 if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1816 foreach my $field ($itemmarc->field($itemtag)){
1817 $field->add_subfields(@$unlinked_item_subfields);
1823 =head1 PRIVATE FUNCTIONS AND VARIABLES
1825 The following functions are not meant to be called
1826 directly, but are documented in order to explain
1827 the inner workings of C<C4::Items>.
1831 =head2 %derived_columns
1833 This hash keeps track of item columns that
1834 are strictly derived from other columns in
1835 the item record and are not meant to be set
1838 Each key in the hash should be the name of a
1839 column (as named by TransformMarcToKoha). Each
1840 value should be hashref whose keys are the
1841 columns on which the derived column depends. The
1842 hashref should also contain a 'BUILDER' key
1843 that is a reference to a sub that calculates
1848 my %derived_columns = (
1849 'items.cn_sort' => {
1850 'itemcallnumber' => 1,
1851 'items.cn_source' => 1,
1852 'BUILDER' => \&_calc_items_cn_sort,
1856 =head2 _set_derived_columns_for_add
1858 _set_derived_column_for_add($item);
1860 Given an item hash representing a new item to be added,
1861 calculate any derived columns. Currently the only
1862 such column is C<items.cn_sort>.
1866 sub _set_derived_columns_for_add {
1869 foreach my $column (keys %derived_columns) {
1870 my $builder = $derived_columns{$column}->{'BUILDER'};
1871 my $source_values = {};
1872 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1873 next if $source_column eq 'BUILDER';
1874 $source_values->{$source_column} = $item->{$source_column};
1876 $builder->($item, $source_values);
1880 =head2 _set_derived_columns_for_mod
1882 _set_derived_column_for_mod($item);
1884 Given an item hash representing a new item to be modified.
1885 calculate any derived columns. Currently the only
1886 such column is C<items.cn_sort>.
1888 This routine differs from C<_set_derived_columns_for_add>
1889 in that it needs to handle partial item records. In other
1890 words, the caller of C<ModItem> may have supplied only one
1891 or two columns to be changed, so this function needs to
1892 determine whether any of the columns to be changed affect
1893 any of the derived columns. Also, if a derived column
1894 depends on more than one column, but the caller is not
1895 changing all of then, this routine retrieves the unchanged
1896 values from the database in order to ensure a correct
1901 sub _set_derived_columns_for_mod {
1904 foreach my $column (keys %derived_columns) {
1905 my $builder = $derived_columns{$column}->{'BUILDER'};
1906 my $source_values = {};
1907 my %missing_sources = ();
1908 my $must_recalc = 0;
1909 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1910 next if $source_column eq 'BUILDER';
1911 if (exists $item->{$source_column}) {
1913 $source_values->{$source_column} = $item->{$source_column};
1915 $missing_sources{$source_column} = 1;
1919 foreach my $source_column (keys %missing_sources) {
1920 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
1922 $builder->($item, $source_values);
1927 =head2 _do_column_fixes_for_mod
1929 _do_column_fixes_for_mod($item);
1931 Given an item hashref containing one or more
1932 columns to modify, fix up certain values.
1933 Specifically, set to 0 any passed value
1934 of C<notforloan>, C<damaged>, C<itemlost>, or
1935 C<wthdrawn> that is either undefined or
1936 contains the empty string.
1940 sub _do_column_fixes_for_mod {
1943 if (exists $item->{'notforloan'} and
1944 (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
1945 $item->{'notforloan'} = 0;
1947 if (exists $item->{'damaged'} and
1948 (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
1949 $item->{'damaged'} = 0;
1951 if (exists $item->{'itemlost'} and
1952 (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
1953 $item->{'itemlost'} = 0;
1955 if (exists $item->{'wthdrawn'} and
1956 (not defined $item->{'wthdrawn'} or $item->{'wthdrawn'} eq '')) {
1957 $item->{'wthdrawn'} = 0;
1959 if (exists $item->{'location'} && !exists $item->{'permanent_location'}) {
1960 $item->{'permanent_location'} = $item->{'location'};
1962 if (exists $item->{'timestamp'}) {
1963 delete $item->{'timestamp'};
1967 =head2 _get_single_item_column
1969 _get_single_item_column($column, $itemnumber);
1971 Retrieves the value of a single column from an C<items>
1972 row specified by C<$itemnumber>.
1976 sub _get_single_item_column {
1978 my $itemnumber = shift;
1980 my $dbh = C4::Context->dbh;
1981 my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
1982 $sth->execute($itemnumber);
1983 my ($value) = $sth->fetchrow();
1987 =head2 _calc_items_cn_sort
1989 _calc_items_cn_sort($item, $source_values);
1991 Helper routine to calculate C<items.cn_sort>.
1995 sub _calc_items_cn_sort {
1997 my $source_values = shift;
1999 $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
2002 =head2 _set_defaults_for_add
2004 _set_defaults_for_add($item_hash);
2006 Given an item hash representing an item to be added, set
2007 correct default values for columns whose default value
2008 is not handled by the DBMS. This includes the following
2015 C<items.dateaccessioned>
2037 sub _set_defaults_for_add {
2039 $item->{dateaccessioned} ||= C4::Dates->new->output('iso');
2040 $item->{$_} ||= 0 for (qw( notforloan damaged itemlost wthdrawn));
2043 =head2 _koha_new_item
2045 my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
2047 Perform the actual insert into the C<items> table.
2051 sub _koha_new_item {
2052 my ( $item, $barcode ) = @_;
2053 my $dbh=C4::Context->dbh;
2056 "INSERT INTO items SET
2058 biblioitemnumber = ?,
2060 dateaccessioned = ?,
2064 replacementprice = ?,
2065 replacementpricedate = ?,
2066 datelastborrowed = ?,
2079 permanent_location = ?,
2091 more_subfields_xml = ?,
2095 my $sth = $dbh->prepare($query);
2096 my $today = C4::Dates->today('iso');
2098 $item->{'biblionumber'},
2099 $item->{'biblioitemnumber'},
2101 $item->{'dateaccessioned'},
2102 $item->{'booksellerid'},
2103 $item->{'homebranch'},
2105 $item->{'replacementprice'},
2106 $item->{'replacementpricedate'} || $today,
2107 $item->{datelastborrowed},
2108 $item->{datelastseen} || $today,
2110 $item->{'notforloan'},
2112 $item->{'itemlost'},
2113 $item->{'wthdrawn'},
2114 $item->{'itemcallnumber'},
2115 $item->{'restricted'},
2116 $item->{'itemnotes'},
2117 $item->{'holdingbranch'},
2119 $item->{'location'},
2120 $item->{'permanent_location'},
2123 $item->{'renewals'},
2124 $item->{'reserves'},
2125 $item->{'items.cn_source'},
2126 $item->{'items.cn_sort'},
2129 $item->{'materials'},
2131 $item->{'enumchron'},
2132 $item->{'more_subfields_xml'},
2133 $item->{'copynumber'},
2134 $item->{'stocknumber'},
2136 my $itemnumber = $dbh->{'mysql_insertid'};
2137 if ( defined $sth->errstr ) {
2138 $error.="ERROR in _koha_new_item $query".$sth->errstr;
2140 return ( $itemnumber, $error );
2143 =head2 MoveItemFromBiblio
2145 MoveItemFromBiblio($itenumber, $frombiblio, $tobiblio);
2147 Moves an item from a biblio to another
2149 Returns undef if the move failed or the biblionumber of the destination record otherwise
2153 sub MoveItemFromBiblio {
2154 my ($itemnumber, $frombiblio, $tobiblio) = @_;
2155 my $dbh = C4::Context->dbh;
2156 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber = ?");
2157 $sth->execute( $tobiblio );
2158 my ( $tobiblioitem ) = $sth->fetchrow();
2159 $sth = $dbh->prepare("UPDATE items SET biblioitemnumber = ?, biblionumber = ? WHERE itemnumber = ? AND biblionumber = ?");
2160 my $return = $sth->execute($tobiblioitem, $tobiblio, $itemnumber, $frombiblio);
2162 ModZebra( $tobiblio, "specialUpdate", "biblioserver", undef, undef );
2163 ModZebra( $frombiblio, "specialUpdate", "biblioserver", undef, undef );
2164 # Checking if the item we want to move is in an order
2165 my $order = GetOrderFromItemnumber($itemnumber);
2167 # Replacing the biblionumber within the order if necessary
2168 $order->{'biblionumber'} = $tobiblio;
2178 DelItemCheck($dbh, $biblionumber, $itemnumber);
2180 Exported function (core API) for deleting an item record in Koha if there no current issue.
2185 my ( $dbh, $biblionumber, $itemnumber ) = @_;
2188 my $countanalytics=GetAnalyticsCount($itemnumber);
2191 # check that there is no issue on this item before deletion.
2192 my $sth=$dbh->prepare("select * from issues i where i.itemnumber=?");
2193 $sth->execute($itemnumber);
2195 my $item = GetItem($itemnumber);
2196 my $onloan=$sth->fetchrow;
2199 $error = "book_on_loan"
2201 elsif ( C4::Context->userenv->{flags} & 1 and
2202 C4::Context->preference("IndependantBranches") and
2203 (C4::Context->userenv->{branch} ne
2204 $item->{C4::Context->preference("HomeOrHoldingBranch")||'homebranch'}) )
2206 $error = "not_same_branch";
2209 # check it doesnt have a waiting reserve
2210 $sth=$dbh->prepare("SELECT * FROM reserves WHERE (found = 'W' or found = 'T') AND itemnumber = ?");
2211 $sth->execute($itemnumber);
2212 my $reserve=$sth->fetchrow;
2214 $error = "book_reserved";
2215 } elsif ($countanalytics > 0){
2216 $error = "linked_analytics";
2218 DelItem($dbh, $biblionumber, $itemnumber);
2225 =head2 _koha_modify_item
2227 my ($itemnumber,$error) =_koha_modify_item( $item );
2229 Perform the actual update of the C<items> row. Note that this
2230 routine accepts a hashref specifying the columns to update.
2234 sub _koha_modify_item {
2236 my $dbh=C4::Context->dbh;
2239 my $query = "UPDATE items SET ";
2241 for my $key ( keys %$item ) {
2243 push @bind, $item->{$key};
2246 $query .= " WHERE itemnumber=?";
2247 push @bind, $item->{'itemnumber'};
2248 my $sth = C4::Context->dbh->prepare($query);
2249 $sth->execute(@bind);
2250 if ( C4::Context->dbh->errstr ) {
2251 $error.="ERROR in _koha_modify_item $query".$dbh->errstr;
2254 return ($item->{'itemnumber'},$error);
2257 =head2 _koha_delete_item
2259 _koha_delete_item( $dbh, $itemnum );
2261 Internal function to delete an item record from the koha tables
2265 sub _koha_delete_item {
2266 my ( $dbh, $itemnum ) = @_;
2268 # save the deleted item to deleteditems table
2269 my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
2270 $sth->execute($itemnum);
2271 my $data = $sth->fetchrow_hashref();
2272 my $query = "INSERT INTO deleteditems SET ";
2274 foreach my $key ( keys %$data ) {
2275 $query .= "$key = ?,";
2276 push( @bind, $data->{$key} );
2279 $sth = $dbh->prepare($query);
2280 $sth->execute(@bind);
2282 # delete from items table
2283 $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
2284 $sth->execute($itemnum);
2288 =head2 _marc_from_item_hash
2290 my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
2292 Given an item hash representing a complete item record,
2293 create a C<MARC::Record> object containing an embedded
2294 tag representing that item.
2296 The third, optional parameter C<$unlinked_item_subfields> is
2297 an arrayref of subfields (not mapped to C<items> fields per the
2298 framework) to be added to the MARC representation
2303 sub _marc_from_item_hash {
2305 my $frameworkcode = shift;
2306 my $unlinked_item_subfields;
2308 $unlinked_item_subfields = shift;
2311 # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
2312 # Also, don't emit a subfield if the underlying field is blank.
2313 my $mungeditem = { map { (defined($item->{$_}) and $item->{$_} ne '') ?
2314 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
2315 : () } keys %{ $item } };
2317 my $item_marc = MARC::Record->new();
2318 foreach my $item_field ( keys %{$mungeditem} ) {
2319 my ( $tag, $subfield ) = GetMarcFromKohaField( $item_field, $frameworkcode );
2320 next unless defined $tag and defined $subfield; # skip if not mapped to MARC field
2321 my @values = split(/\s?\|\s?/, $mungeditem->{$item_field}, -1);
2322 foreach my $value (@values){
2323 if ( my $field = $item_marc->field($tag) ) {
2324 $field->add_subfields( $subfield => $value );
2326 my $add_subfields = [];
2327 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2328 $add_subfields = $unlinked_item_subfields;
2330 $item_marc->add_fields( $tag, " ", " ", $subfield => $value, @$add_subfields );
2338 =head2 _repack_item_errors
2340 Add an error message hash generated by C<CheckItemPreSave>
2341 to a list of errors.
2345 sub _repack_item_errors {
2346 my $item_sequence_num = shift;
2347 my $item_ref = shift;
2348 my $error_ref = shift;
2350 my @repacked_errors = ();
2352 foreach my $error_code (sort keys %{ $error_ref }) {
2353 my $repacked_error = {};
2354 $repacked_error->{'item_sequence'} = $item_sequence_num;
2355 $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
2356 $repacked_error->{'error_code'} = $error_code;
2357 $repacked_error->{'error_information'} = $error_ref->{$error_code};
2358 push @repacked_errors, $repacked_error;
2361 return @repacked_errors;
2364 =head2 _get_unlinked_item_subfields
2366 my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
2370 sub _get_unlinked_item_subfields {
2371 my $original_item_marc = shift;
2372 my $frameworkcode = shift;
2374 my $marcstructure = GetMarcStructure(1, $frameworkcode);
2376 # assume that this record has only one field, and that that
2377 # field contains only the item information
2379 my @fields = $original_item_marc->fields();
2380 if ($#fields > -1) {
2381 my $field = $fields[0];
2382 my $tag = $field->tag();
2383 foreach my $subfield ($field->subfields()) {
2384 if (defined $subfield->[1] and
2385 $subfield->[1] ne '' and
2386 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
2387 push @$subfields, $subfield->[0] => $subfield->[1];
2394 =head2 _get_unlinked_subfields_xml
2396 my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
2400 sub _get_unlinked_subfields_xml {
2401 my $unlinked_item_subfields = shift;
2404 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2405 my $marc = MARC::Record->new();
2406 # use of tag 999 is arbitrary, and doesn't need to match the item tag
2407 # used in the framework
2408 $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
2409 $marc->encoding("UTF-8");
2410 $xml = $marc->as_xml("USMARC");
2416 =head2 _parse_unlinked_item_subfields_from_xml
2418 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2422 sub _parse_unlinked_item_subfields_from_xml {
2425 return unless defined $xml and $xml ne "";
2426 my $marc = MARC::Record->new_from_xml(StripNonXmlChars($xml),'UTF-8');
2427 my $unlinked_subfields = [];
2428 my @fields = $marc->fields();
2429 if ($#fields > -1) {
2430 foreach my $subfield ($fields[0]->subfields()) {
2431 push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2434 return $unlinked_subfields;
2437 =head2 GetAnalyticsCount
2439 $count= &GetAnalyticsCount($itemnumber)
2441 counts Usage of itemnumber in Analytical bibliorecords.
2445 sub GetAnalyticsCount {
2446 my ($itemnumber) = @_;
2447 if (C4::Context->preference('NoZebra')) {
2448 # Read the index Koha-Auth-Number for this authid and count the lines
2449 my $result = C4::Search::NZanalyse("hi=$itemnumber");
2450 my @tab = split /;/,$result;
2453 ### ZOOM search here
2455 $query= "hi=".$itemnumber;
2456 my ($err,$res,$result) = C4::Search::SimpleSearch($query,0,10);