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.
408 my %default_values_for_mod_from_marc = (
410 booksellerid => undef,
412 'items.cn_source' => undef,
415 # dateaccessioned => undef,
417 holdingbranch => undef,
419 itemcallnumber => undef,
424 permanent_location => undef,
429 replacementprice => undef,
430 replacementpricedate => undef,
433 stocknumber => undef,
438 sub ModItemFromMarc {
439 my $item_marc = shift;
440 my $biblionumber = shift;
441 my $itemnumber = shift;
443 my $dbh = C4::Context->dbh;
444 my $frameworkcode = GetFrameworkCode($biblionumber);
445 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
447 my $localitemmarc = MARC::Record->new;
448 $localitemmarc->append_fields( $item_marc->field($itemtag) );
449 my $item = &TransformMarcToKoha( $dbh, $localitemmarc, $frameworkcode, 'items' );
450 foreach my $item_field ( keys %default_values_for_mod_from_marc ) {
451 $item->{$item_field} = $default_values_for_mod_from_marc{$item_field} unless (exists $item->{$item_field});
453 my $unlinked_item_subfields = _get_unlinked_item_subfields( $localitemmarc, $frameworkcode );
455 ModItem($item, $biblionumber, $itemnumber, $dbh, $frameworkcode, $unlinked_item_subfields);
461 ModItem({ column => $newvalue }, $biblionumber,
462 $itemnumber[, $original_item_marc]);
464 Change one or more columns in an item record and update
465 the MARC representation of the item.
467 The first argument is a hashref mapping from item column
468 names to the new values. The second and third arguments
469 are the biblionumber and itemnumber, respectively.
471 The fourth, optional parameter, C<$unlinked_item_subfields>, contains
472 an arrayref containing subfields present in the original MARC
473 representation of the item (e.g., from the item editor) that are
474 not mapped to C<items> columns directly but should instead
475 be stored in C<items.more_subfields_xml> and included in
476 the biblio items tag for display and indexing.
478 If one of the changed columns is used to calculate
479 the derived value of a column such as C<items.cn_sort>,
480 this routine will perform the necessary calculation
487 my $biblionumber = shift;
488 my $itemnumber = shift;
490 # if $biblionumber is undefined, get it from the current item
491 unless (defined $biblionumber) {
492 $biblionumber = _get_single_item_column('biblionumber', $itemnumber);
495 my $dbh = @_ ? shift : C4::Context->dbh;
496 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
498 my $unlinked_item_subfields;
500 $unlinked_item_subfields = shift;
501 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
504 $item->{'itemnumber'} = $itemnumber or return undef;
506 $item->{onloan} = undef if $item->{itemlost};
508 _set_derived_columns_for_mod($item);
509 _do_column_fixes_for_mod($item);
512 # attempt to change itemnumber
513 # attempt to change biblionumber (if we want
514 # an API to relink an item to a different bib,
515 # it should be a separate function)
518 _koha_modify_item($item);
520 # request that bib be reindexed so that searching on current
521 # item status is possible
522 ModZebra( $biblionumber, "specialUpdate", "biblioserver", undef, undef );
524 logaction("CATALOGUING", "MODIFY", $itemnumber, Dumper($item)) if C4::Context->preference("CataloguingLog");
527 =head2 ModItemTransfer
529 ModItemTransfer($itenumber, $frombranch, $tobranch);
531 Marks an item as being transferred from one branch
536 sub ModItemTransfer {
537 my ( $itemnumber, $frombranch, $tobranch ) = @_;
539 my $dbh = C4::Context->dbh;
541 #new entry in branchtransfers....
542 my $sth = $dbh->prepare(
543 "INSERT INTO branchtransfers (itemnumber, frombranch, datesent, tobranch)
544 VALUES (?, ?, NOW(), ?)");
545 $sth->execute($itemnumber, $frombranch, $tobranch);
547 ModItem({ holdingbranch => $tobranch }, undef, $itemnumber);
548 ModDateLastSeen($itemnumber);
552 =head2 ModDateLastSeen
554 ModDateLastSeen($itemnum);
556 Mark item as seen. Is called when an item is issued, returned or manually marked during inventory/stocktaking.
557 C<$itemnum> is the item number
561 sub ModDateLastSeen {
562 my ($itemnumber) = @_;
564 my $today = C4::Dates->new();
565 ModItem({ itemlost => 0, datelastseen => $today->output("iso") }, undef, $itemnumber);
570 DelItem($dbh, $biblionumber, $itemnumber);
572 Exported function (core API) for deleting an item record in Koha.
577 my ( $dbh, $biblionumber, $itemnumber ) = @_;
579 # FIXME check the item has no current issues
581 _koha_delete_item( $dbh, $itemnumber );
583 # get the MARC record
584 my $record = GetMarcBiblio($biblionumber);
585 ModZebra( $biblionumber, "specialUpdate", "biblioserver", undef, undef );
588 my $copy2deleted = $dbh->prepare("UPDATE deleteditems SET marc=? WHERE itemnumber=?");
589 $copy2deleted->execute( $record->as_usmarc(), $itemnumber );
590 # This last update statement makes that the timestamp column in deleteditems is updated too. If you remove these lines, please add a line to update the timestamp separately. See Bugzilla report 7146 and Biblio.pm (DelBiblio).
592 #search item field code
593 logaction("CATALOGUING", "DELETE", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
596 =head2 CheckItemPreSave
598 my $item_ref = TransformMarcToKoha($marc, 'items');
600 my %errors = CheckItemPreSave($item_ref);
601 if (exists $errors{'duplicate_barcode'}) {
602 print "item has duplicate barcode: ", $errors{'duplicate_barcode'}, "\n";
603 } elsif (exists $errors{'invalid_homebranch'}) {
604 print "item has invalid home branch: ", $errors{'invalid_homebranch'}, "\n";
605 } elsif (exists $errors{'invalid_holdingbranch'}) {
606 print "item has invalid holding branch: ", $errors{'invalid_holdingbranch'}, "\n";
611 Given a hashref containing item fields, determine if it can be
612 inserted or updated in the database. Specifically, checks for
613 database integrity issues, and returns a hash containing any
614 of the following keys, if applicable.
618 =item duplicate_barcode
620 Barcode, if it duplicates one already found in the database.
622 =item invalid_homebranch
624 Home branch, if not defined in branches table.
626 =item invalid_holdingbranch
628 Holding branch, if not defined in branches table.
632 This function does NOT implement any policy-related checks,
633 e.g., whether current operator is allowed to save an
634 item that has a given branch code.
638 sub CheckItemPreSave {
639 my $item_ref = shift;
643 # check for duplicate barcode
644 if (exists $item_ref->{'barcode'} and defined $item_ref->{'barcode'}) {
645 my $existing_itemnumber = GetItemnumberFromBarcode($item_ref->{'barcode'});
646 if ($existing_itemnumber) {
647 if (!exists $item_ref->{'itemnumber'} # new item
648 or $item_ref->{'itemnumber'} != $existing_itemnumber) { # existing item
649 $errors{'duplicate_barcode'} = $item_ref->{'barcode'};
654 # check for valid home branch
655 if (exists $item_ref->{'homebranch'} and defined $item_ref->{'homebranch'}) {
656 my $branch_name = GetBranchName($item_ref->{'homebranch'});
657 unless (defined $branch_name) {
658 # relies on fact that branches.branchname is a non-NULL column,
659 # so GetBranchName returns undef only if branch does not exist
660 $errors{'invalid_homebranch'} = $item_ref->{'homebranch'};
664 # check for valid holding branch
665 if (exists $item_ref->{'holdingbranch'} and defined $item_ref->{'holdingbranch'}) {
666 my $branch_name = GetBranchName($item_ref->{'holdingbranch'});
667 unless (defined $branch_name) {
668 # relies on fact that branches.branchname is a non-NULL column,
669 # so GetBranchName returns undef only if branch does not exist
670 $errors{'invalid_holdingbranch'} = $item_ref->{'holdingbranch'};
678 =head1 EXPORTED SPECIAL ACCESSOR FUNCTIONS
680 The following functions provide various ways of
681 getting an item record, a set of item records, or
682 lists of authorized values for certain item fields.
684 Some of the functions in this group are candidates
685 for refactoring -- for example, some of the code
686 in C<GetItemsByBiblioitemnumber> and C<GetItemsInfo>
687 has copy-and-paste work.
693 $itemstatushash = GetItemStatus($fwkcode);
695 Returns a list of valid values for the
696 C<items.notforloan> field.
698 NOTE: does B<not> return an individual item's
701 Can be MARC dependant.
703 But basically could be can be loan or not
704 Create a status selector with the following code
706 =head3 in PERL SCRIPT
708 my $itemstatushash = getitemstatus;
710 foreach my $thisstatus (keys %$itemstatushash) {
711 my %row =(value => $thisstatus,
712 statusname => $itemstatushash->{$thisstatus}->{'statusname'},
714 push @itemstatusloop, \%row;
716 $template->param(statusloop=>\@itemstatusloop);
720 <select name="statusloop">
721 <option value="">Default</option>
722 <!-- TMPL_LOOP name="statusloop" -->
723 <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="statusname" --></option>
731 # returns a reference to a hash of references to status...
734 my $dbh = C4::Context->dbh;
736 $fwk = '' unless ($fwk);
737 my ( $tag, $subfield ) =
738 GetMarcFromKohaField( "items.notforloan", $fwk );
739 if ( $tag and $subfield ) {
742 "SELECT authorised_value
743 FROM marc_subfield_structure
749 $sth->execute( $tag, $subfield, $fwk );
750 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
753 "SELECT authorised_value,lib
754 FROM authorised_values
759 $authvalsth->execute($authorisedvaluecat);
760 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
761 $itemstatus{$authorisedvalue} = $lib;
775 $itemstatus{"1"} = "Not For Loan";
779 =head2 GetItemLocation
781 $itemlochash = GetItemLocation($fwk);
783 Returns a list of valid values for the
784 C<items.location> field.
786 NOTE: does B<not> return an individual item's
789 where fwk stands for an optional framework code.
790 Create a location selector with the following code
792 =head3 in PERL SCRIPT
794 my $itemlochash = getitemlocation;
796 foreach my $thisloc (keys %$itemlochash) {
797 my $selected = 1 if $thisbranch eq $branch;
798 my %row =(locval => $thisloc,
799 selected => $selected,
800 locname => $itemlochash->{$thisloc},
802 push @itemlocloop, \%row;
804 $template->param(itemlocationloop => \@itemlocloop);
808 <select name="location">
809 <option value="">Default</option>
810 <!-- TMPL_LOOP name="itemlocationloop" -->
811 <option value="<!-- TMPL_VAR name="locval" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="locname" --></option>
817 sub GetItemLocation {
819 # returns a reference to a hash of references to location...
822 my $dbh = C4::Context->dbh;
824 $fwk = '' unless ($fwk);
825 my ( $tag, $subfield ) =
826 GetMarcFromKohaField( "items.location", $fwk );
827 if ( $tag and $subfield ) {
830 "SELECT authorised_value
831 FROM marc_subfield_structure
836 $sth->execute( $tag, $subfield, $fwk );
837 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
840 "SELECT authorised_value,lib
841 FROM authorised_values
845 $authvalsth->execute($authorisedvaluecat);
846 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
847 $itemlocation{$authorisedvalue} = $lib;
849 return \%itemlocation;
861 $itemlocation{"1"} = "Not For Loan";
862 return \%itemlocation;
867 $items = GetLostItems( $where, $orderby );
869 This function gets a list of lost items.
875 C<$where> is a hashref. it containts a field of the items table as key
876 and the value to match as value. For example:
878 { barcode => 'abc123',
879 homebranch => 'CPL', }
881 C<$orderby> is a field of the items table by which the resultset
886 C<$items> is a reference to an array full of hashrefs with columns
887 from the "items" table as keys.
889 =item usage in the perl script:
891 my $where = { barcode => '0001548' };
892 my $items = GetLostItems( $where, "homebranch" );
893 $template->param( itemsloop => $items );
900 # Getting input args.
903 my $dbh = C4::Context->dbh;
908 LEFT JOIN biblio ON (items.biblionumber = biblio.biblionumber)
909 LEFT JOIN biblioitems ON (items.biblionumber = biblioitems.biblionumber)
910 LEFT JOIN authorised_values ON (items.itemlost = authorised_values.authorised_value)
912 authorised_values.category = 'LOST'
913 AND itemlost IS NOT NULL
916 my @query_parameters;
917 foreach my $key (keys %$where) {
918 $query .= " AND $key LIKE ?";
919 push @query_parameters, "%$where->{$key}%";
921 my @ordervalues = qw/title author homebranch itype barcode price replacementprice lib datelastseen location/;
923 if ( defined $orderby && grep($orderby, @ordervalues)) {
924 $query .= ' ORDER BY '.$orderby;
927 my $sth = $dbh->prepare($query);
928 $sth->execute( @query_parameters );
930 while ( my $row = $sth->fetchrow_hashref ){
936 =head2 GetItemsForInventory
938 $itemlist = GetItemsForInventory($minlocation, $maxlocation,
939 $location, $itemtype $datelastseen, $branch,
940 $offset, $size, $statushash);
942 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
944 The sub returns a reference to a list of hashes, each containing
945 itemnumber, author, title, barcode, item callnumber, and date last
946 seen. It is ordered by callnumber then title.
948 The required minlocation & maxlocation parameters are used to specify a range of item callnumbers
949 the datelastseen can be used to specify that you want to see items not seen since a past date only.
950 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
951 $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.
955 sub GetItemsForInventory {
956 my ( $minlocation, $maxlocation,$location, $itemtype, $ignoreissued, $datelastseen, $branchcode, $branch, $offset, $size, $statushash ) = @_;
957 my $dbh = C4::Context->dbh;
958 my ( @bind_params, @where_strings );
960 my $query = <<'END_SQL';
961 SELECT items.itemnumber, barcode, itemcallnumber, title, author, biblio.biblionumber, datelastseen
963 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
964 LEFT JOIN biblioitems on items.biblionumber = biblioitems.biblionumber
967 for my $authvfield (keys %$statushash){
968 if ( scalar @{$statushash->{$authvfield}} > 0 ){
969 my $joinedvals = join ',', @{$statushash->{$authvfield}};
970 push @where_strings, "$authvfield in (" . $joinedvals . ")";
976 push @where_strings, 'itemcallnumber >= ?';
977 push @bind_params, $minlocation;
981 push @where_strings, 'itemcallnumber <= ?';
982 push @bind_params, $maxlocation;
986 $datelastseen = format_date_in_iso($datelastseen);
987 push @where_strings, '(datelastseen < ? OR datelastseen IS NULL)';
988 push @bind_params, $datelastseen;
992 push @where_strings, 'items.location = ?';
993 push @bind_params, $location;
997 if($branch eq "homebranch"){
998 push @where_strings, 'items.homebranch = ?';
1000 push @where_strings, 'items.holdingbranch = ?';
1002 push @bind_params, $branchcode;
1006 push @where_strings, 'biblioitems.itemtype = ?';
1007 push @bind_params, $itemtype;
1010 if ( $ignoreissued) {
1011 $query .= "LEFT JOIN issues ON items.itemnumber = issues.itemnumber ";
1012 push @where_strings, 'issues.date_due IS NULL';
1015 if ( @where_strings ) {
1017 $query .= join ' AND ', @where_strings;
1019 $query .= ' ORDER BY items.cn_sort, itemcallnumber, title';
1020 my $sth = $dbh->prepare($query);
1021 $sth->execute( @bind_params );
1025 while ( my $row = $sth->fetchrow_hashref ) {
1026 $offset-- if ($offset);
1027 $row->{datelastseen}=format_date($row->{datelastseen});
1028 if ( ( !$offset ) && $size ) {
1029 push @results, $row;
1036 =head2 GetItemsCount
1038 $count = &GetItemsCount( $biblionumber);
1040 This function return count of item with $biblionumber
1045 my ( $biblionumber ) = @_;
1046 my $dbh = C4::Context->dbh;
1047 my $query = "SELECT count(*)
1049 WHERE biblionumber=?";
1050 my $sth = $dbh->prepare($query);
1051 $sth->execute($biblionumber);
1052 my $count = $sth->fetchrow;
1056 =head2 GetItemInfosOf
1058 GetItemInfosOf(@itemnumbers);
1062 sub GetItemInfosOf {
1063 my @itemnumbers = @_;
1068 WHERE itemnumber IN (' . join( ',', @itemnumbers ) . ')
1070 return get_infos_of( $query, 'itemnumber' );
1073 =head2 GetItemsByBiblioitemnumber
1075 GetItemsByBiblioitemnumber($biblioitemnumber);
1077 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1078 Called by C<C4::XISBN>
1082 sub GetItemsByBiblioitemnumber {
1083 my ( $bibitem ) = @_;
1084 my $dbh = C4::Context->dbh;
1085 my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1086 # Get all items attached to a biblioitem
1089 $sth->execute($bibitem) || die $sth->errstr;
1090 while ( my $data = $sth->fetchrow_hashref ) {
1091 # Foreach item, get circulation information
1092 my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1093 WHERE itemnumber = ?
1094 AND issues.borrowernumber = borrowers.borrowernumber"
1096 $sth2->execute( $data->{'itemnumber'} );
1097 if ( my $data2 = $sth2->fetchrow_hashref ) {
1098 # if item is out, set the due date and who it is out too
1099 $data->{'date_due'} = $data2->{'date_due'};
1100 $data->{'cardnumber'} = $data2->{'cardnumber'};
1101 $data->{'borrowernumber'} = $data2->{'borrowernumber'};
1104 # set date_due to blank, so in the template we check itemlost, and wthdrawn
1105 $data->{'date_due'} = '';
1107 # Find the last 3 people who borrowed this item.
1108 my $query2 = "SELECT * FROM old_issues, borrowers WHERE itemnumber = ?
1109 AND old_issues.borrowernumber = borrowers.borrowernumber
1110 ORDER BY returndate desc,timestamp desc LIMIT 3";
1111 $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1112 $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1114 while ( my $data2 = $sth2->fetchrow_hashref ) {
1115 $data->{"timestamp$i2"} = $data2->{'timestamp'};
1116 $data->{"card$i2"} = $data2->{'cardnumber'};
1117 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
1120 push(@results,$data);
1127 @results = GetItemsInfo($biblionumber);
1129 Returns information about items with the given biblionumber.
1131 C<GetItemsInfo> returns a list of references-to-hash. Each element
1132 contains a number of keys. Most of them are attributes from the
1133 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
1134 Koha database. Other keys include:
1138 =item C<$data-E<gt>{branchname}>
1140 The name (not the code) of the branch to which the book belongs.
1142 =item C<$data-E<gt>{datelastseen}>
1144 This is simply C<items.datelastseen>, except that while the date is
1145 stored in YYYY-MM-DD format in the database, here it is converted to
1146 DD/MM/YYYY format. A NULL date is returned as C<//>.
1148 =item C<$data-E<gt>{datedue}>
1150 =item C<$data-E<gt>{class}>
1152 This is the concatenation of C<biblioitems.classification>, the book's
1153 Dewey code, and C<biblioitems.subclass>.
1155 =item C<$data-E<gt>{ocount}>
1157 I think this is the number of copies of the book available.
1159 =item C<$data-E<gt>{order}>
1161 If this is set, it is set to C<One Order>.
1168 my ( $biblionumber ) = @_;
1169 my $dbh = C4::Context->dbh;
1170 # note biblioitems.* must be avoided to prevent large marc and marcxml fields from killing performance.
1176 biblioitems.itemtype,
1179 biblioitems.publicationyear,
1180 biblioitems.publishercode,
1181 biblioitems.volumedate,
1182 biblioitems.volumedesc,
1185 items.notforloan as itemnotforloan,
1186 itemtypes.description,
1187 itemtypes.notforloan as notforloan_per_itemtype,
1190 LEFT JOIN branches ON items.holdingbranch = branches.branchcode
1191 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1192 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1193 LEFT JOIN itemtypes ON itemtypes.itemtype = "
1194 . (C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype');
1195 $query .= " WHERE items.biblionumber = ? ORDER BY branches.branchname,items.dateaccessioned desc" ;
1196 my $sth = $dbh->prepare($query);
1197 $sth->execute($biblionumber);
1202 my $isth = $dbh->prepare(
1203 "SELECT issues.*,borrowers.cardnumber,borrowers.surname,borrowers.firstname,borrowers.branchcode as bcode
1204 FROM issues LEFT JOIN borrowers ON issues.borrowernumber=borrowers.borrowernumber
1205 WHERE itemnumber = ?"
1207 my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=? ");
1208 while ( my $data = $sth->fetchrow_hashref ) {
1211 $isth->execute( $data->{'itemnumber'} );
1212 if ( my $idata = $isth->fetchrow_hashref ) {
1213 $data->{borrowernumber} = $idata->{borrowernumber};
1214 $data->{cardnumber} = $idata->{cardnumber};
1215 $data->{surname} = $idata->{surname};
1216 $data->{firstname} = $idata->{firstname};
1217 $datedue = $idata->{'date_due'};
1218 if (C4::Context->preference("IndependantBranches")){
1219 my $userenv = C4::Context->userenv;
1220 if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
1221 $data->{'NOTSAMEBRANCH'} = 1 if ($idata->{'bcode'} ne $userenv->{branch});
1225 if ( $data->{'serial'}) {
1226 $ssth->execute($data->{'itemnumber'}) ;
1227 ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
1230 if ( $datedue eq '' ) {
1231 my ( $restype, $reserves ) =
1232 C4::Reserves::CheckReserves( $data->{'itemnumber'} );
1233 # Previous conditional check with if ($restype) is not needed because a true
1234 # result for one item will result in subsequent items defaulting to this true
1236 $count_reserves = $restype;
1238 #get branch information.....
1239 my $bsth = $dbh->prepare(
1240 "SELECT * FROM branches WHERE branchcode = ?
1243 $bsth->execute( $data->{'holdingbranch'} );
1244 if ( my $bdata = $bsth->fetchrow_hashref ) {
1245 $data->{'branchname'} = $bdata->{'branchname'};
1247 $data->{'datedue'} = $datedue;
1248 $data->{'count_reserves'} = $count_reserves;
1250 # get notforloan complete status if applicable
1251 my $sthnflstatus = $dbh->prepare(
1252 'SELECT authorised_value
1253 FROM marc_subfield_structure
1254 WHERE kohafield="items.notforloan"
1258 $sthnflstatus->execute;
1259 my ($authorised_valuecode) = $sthnflstatus->fetchrow;
1260 if ($authorised_valuecode) {
1261 $sthnflstatus = $dbh->prepare(
1262 "SELECT lib FROM authorised_values
1264 AND authorised_value=?"
1266 $sthnflstatus->execute( $authorised_valuecode,
1267 $data->{itemnotforloan} );
1268 my ($lib) = $sthnflstatus->fetchrow;
1269 $data->{notforloanvalue} = $lib;
1272 # get restricted status and description if applicable
1273 my $restrictedstatus = $dbh->prepare(
1274 'SELECT authorised_value
1275 FROM marc_subfield_structure
1276 WHERE kohafield="items.restricted"
1280 $restrictedstatus->execute;
1281 ($authorised_valuecode) = $restrictedstatus->fetchrow;
1282 if ($authorised_valuecode) {
1283 $restrictedstatus = $dbh->prepare(
1284 "SELECT lib,lib_opac FROM authorised_values
1286 AND authorised_value=?"
1288 $restrictedstatus->execute( $authorised_valuecode,
1289 $data->{restricted} );
1291 if ( my $rstdata = $restrictedstatus->fetchrow_hashref ) {
1292 $data->{restricted} = $rstdata->{'lib'};
1293 $data->{restrictedopac} = $rstdata->{'lib_opac'};
1297 # my stack procedures
1298 my $stackstatus = $dbh->prepare(
1299 'SELECT authorised_value
1300 FROM marc_subfield_structure
1301 WHERE kohafield="items.stack"
1304 $stackstatus->execute;
1306 ($authorised_valuecode) = $stackstatus->fetchrow;
1307 if ($authorised_valuecode) {
1308 $stackstatus = $dbh->prepare(
1310 FROM authorised_values
1312 AND authorised_value=?
1315 $stackstatus->execute( $authorised_valuecode, $data->{stack} );
1316 my ($lib) = $stackstatus->fetchrow;
1317 $data->{stack} = $lib;
1319 # Find the last 3 people who borrowed this item.
1320 my $sth2 = $dbh->prepare("SELECT * FROM old_issues,borrowers
1321 WHERE itemnumber = ?
1322 AND old_issues.borrowernumber = borrowers.borrowernumber
1323 ORDER BY returndate DESC
1325 $sth2->execute($data->{'itemnumber'});
1327 while (my $data2 = $sth2->fetchrow_hashref()) {
1328 $data->{"timestamp$ii"} = $data2->{'timestamp'} if $data2->{'timestamp'};
1329 $data->{"card$ii"} = $data2->{'cardnumber'} if $data2->{'cardnumber'};
1330 $data->{"borrower$ii"} = $data2->{'borrowernumber'} if $data2->{'borrowernumber'};
1334 $results[$i] = $data;
1338 return( sort { ($b->{'publisheddate'} || $b->{'enumchron'}) cmp ($a->{'publisheddate'} || $a->{'enumchron'}) } @results );
1344 =head2 GetItemsLocationInfo
1346 my @itemlocinfo = GetItemsLocationInfo($biblionumber);
1348 Returns the branch names, shelving location and itemcallnumber for each item attached to the biblio in question
1350 C<GetItemsInfo> returns a list of references-to-hash. Data returned:
1354 =item C<$data-E<gt>{homebranch}>
1356 Branch Name of the item's homebranch
1358 =item C<$data-E<gt>{holdingbranch}>
1360 Branch Name of the item's holdingbranch
1362 =item C<$data-E<gt>{location}>
1364 Item's shelving location code
1366 =item C<$data-E<gt>{location_intranet}>
1368 The intranet description for the Shelving Location as set in authorised_values 'LOC'
1370 =item C<$data-E<gt>{location_opac}>
1372 The OPAC description for the Shelving Location as set in authorised_values 'LOC'. Falls back to intranet description if no OPAC
1375 =item C<$data-E<gt>{itemcallnumber}>
1377 Item's itemcallnumber
1379 =item C<$data-E<gt>{cn_sort}>
1381 Item's call number normalized for sorting
1387 sub GetItemsLocationInfo {
1388 my $biblionumber = shift;
1391 my $dbh = C4::Context->dbh;
1392 my $query = "SELECT a.branchname as homebranch, b.branchname as holdingbranch,
1393 location, itemcallnumber, cn_sort
1394 FROM items, branches as a, branches as b
1395 WHERE homebranch = a.branchcode AND holdingbranch = b.branchcode
1396 AND biblionumber = ?
1397 ORDER BY cn_sort ASC";
1398 my $sth = $dbh->prepare($query);
1399 $sth->execute($biblionumber);
1401 while ( my $data = $sth->fetchrow_hashref ) {
1402 $data->{location_intranet} = GetKohaAuthorisedValueLib('LOC', $data->{location});
1403 $data->{location_opac}= GetKohaAuthorisedValueLib('LOC', $data->{location}, 1);
1404 push @results, $data;
1409 =head2 GetHostItemsInfo
1411 $hostiteminfo = GetHostItemsInfo($hostfield);
1412 Returns the iteminfo for items linked to records via a host field
1416 sub GetHostItemsInfo {
1418 my @returnitemsInfo;
1420 if (C4::Context->preference('marcflavour') eq 'MARC21' ||
1421 C4::Context->preference('marcflavour') eq 'NORMARC'){
1422 foreach my $hostfield ( $record->field('773') ) {
1423 my $hostbiblionumber = $hostfield->subfield("0");
1424 my $linkeditemnumber = $hostfield->subfield("9");
1425 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1426 foreach my $hostitemInfo (@hostitemInfos){
1427 if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1428 push (@returnitemsInfo,$hostitemInfo);
1433 } elsif ( C4::Context->preference('marcflavour') eq 'UNIMARC'){
1434 foreach my $hostfield ( $record->field('461') ) {
1435 my $hostbiblionumber = $hostfield->subfield("0");
1436 my $linkeditemnumber = $hostfield->subfield("9");
1437 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1438 foreach my $hostitemInfo (@hostitemInfos){
1439 if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1440 push (@returnitemsInfo,$hostitemInfo);
1446 return @returnitemsInfo;
1450 =head2 GetLastAcquisitions
1452 my $lastacq = GetLastAcquisitions({'branches' => ('branch1','branch2'),
1453 'itemtypes' => ('BK','BD')}, 10);
1457 sub GetLastAcquisitions {
1458 my ($data,$max) = @_;
1460 my $itemtype = C4::Context->preference('item-level_itypes') ? 'itype' : 'itemtype';
1462 my $number_of_branches = @{$data->{branches}};
1463 my $number_of_itemtypes = @{$data->{itemtypes}};
1466 my @where = ('WHERE 1 ');
1467 $number_of_branches and push @where
1468 , 'AND holdingbranch IN ('
1469 , join(',', ('?') x $number_of_branches )
1473 $number_of_itemtypes and push @where
1474 , "AND $itemtype IN ("
1475 , join(',', ('?') x $number_of_itemtypes )
1479 my $query = "SELECT biblio.biblionumber as biblionumber, title, dateaccessioned
1480 FROM items RIGHT JOIN biblio ON (items.biblionumber=biblio.biblionumber)
1481 RIGHT JOIN biblioitems ON (items.biblioitemnumber=biblioitems.biblioitemnumber)
1483 GROUP BY biblio.biblionumber
1484 ORDER BY dateaccessioned DESC LIMIT $max";
1486 my $dbh = C4::Context->dbh;
1487 my $sth = $dbh->prepare($query);
1489 $sth->execute((@{$data->{branches}}, @{$data->{itemtypes}}));
1492 while( my $row = $sth->fetchrow_hashref){
1493 push @results, {date => $row->{dateaccessioned}
1494 , biblionumber => $row->{biblionumber}
1495 , title => $row->{title}};
1501 =head2 get_itemnumbers_of
1503 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1505 Given a list of biblionumbers, return the list of corresponding itemnumbers
1506 for each biblionumber.
1508 Return a reference on a hash where keys are biblionumbers and values are
1509 references on array of itemnumbers.
1513 sub get_itemnumbers_of {
1514 my @biblionumbers = @_;
1516 my $dbh = C4::Context->dbh;
1522 WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1524 my $sth = $dbh->prepare($query);
1525 $sth->execute(@biblionumbers);
1529 while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1530 push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1533 return \%itemnumbers_of;
1536 =head2 get_hostitemnumbers_of
1538 my @itemnumbers_of = get_hostitemnumbers_of($biblionumber);
1540 Given a biblionumber, return the list of corresponding itemnumbers that are linked to it via host fields
1542 Return a reference on a hash where key is a biblionumber and values are
1543 references on array of itemnumbers.
1548 sub get_hostitemnumbers_of {
1549 my ($biblionumber) = @_;
1550 my $marcrecord = GetMarcBiblio($biblionumber);
1551 my (@returnhostitemnumbers,$tag, $biblio_s, $item_s);
1553 my $marcflavor = C4::Context->preference('marcflavour');
1554 if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1558 } elsif ($marcflavor eq 'UNIMARC') {
1564 foreach my $hostfield ( $marcrecord->field($tag) ) {
1565 my $hostbiblionumber = $hostfield->subfield($biblio_s);
1566 my $linkeditemnumber = $hostfield->subfield($item_s);
1568 if (my $itemnumbers = get_itemnumbers_of($hostbiblionumber)->{$hostbiblionumber})
1570 @itemnumbers = @$itemnumbers;
1572 foreach my $itemnumber (@itemnumbers){
1573 if ($itemnumber eq $linkeditemnumber){
1574 push (@returnhostitemnumbers,$itemnumber);
1579 return @returnhostitemnumbers;
1583 =head2 GetItemnumberFromBarcode
1585 $result = GetItemnumberFromBarcode($barcode);
1589 sub GetItemnumberFromBarcode {
1591 my $dbh = C4::Context->dbh;
1594 $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1595 $rq->execute($barcode);
1596 my ($result) = $rq->fetchrow;
1600 =head2 GetBarcodeFromItemnumber
1602 $result = GetBarcodeFromItemnumber($itemnumber);
1606 sub GetBarcodeFromItemnumber {
1607 my ($itemnumber) = @_;
1608 my $dbh = C4::Context->dbh;
1611 $dbh->prepare("SELECT barcode FROM items WHERE items.itemnumber=?");
1612 $rq->execute($itemnumber);
1613 my ($result) = $rq->fetchrow;
1617 =head2 GetHiddenItemnumbers
1621 $result = GetHiddenItemnumbers(@items);
1627 sub GetHiddenItemnumbers {
1631 my $yaml = C4::Context->preference('OpacHiddenItems');
1634 $hidingrules = YAML::Load($yaml);
1637 warn "Unable to parse OpacHiddenItems syspref : $@";
1640 my $dbh = C4::Context->dbh;
1643 foreach my $item (@items) {
1645 # We check each rule
1646 foreach my $field (keys %$hidingrules) {
1647 my $query = "SELECT $field from items where itemnumber = ?";
1648 my $sth = $dbh->prepare($query);
1649 $sth->execute($item->{'itemnumber'});
1650 my ($result) = $sth->fetchrow;
1652 # If the results matches the values in the yaml file
1653 if (any { $result eq $_ } @{$hidingrules->{$field}}) {
1655 # We add the itemnumber to the list
1656 push @resultitems, $item->{'itemnumber'};
1658 # If at least one rule matched for an item, no need to test the others
1663 return @resultitems;
1668 =head3 get_item_authorised_values
1670 find the types and values for all authorised values assigned to this item.
1672 parameters: itemnumber
1674 returns: a hashref malling the authorised value to the value set for this itemnumber
1676 $authorised_values = {
1682 'RESTRICTED' => undef,
1685 'branches' => 'CPL',
1686 'cn_source' => undef,
1687 'itemtypes' => 'SER',
1690 Notes: see C4::Biblio::get_biblio_authorised_values for a similar method at the biblio level.
1694 sub get_item_authorised_values {
1695 my $itemnumber = shift;
1697 # assume that these entries in the authorised_value table are item level.
1698 my $query = q(SELECT distinct authorised_value, kohafield
1699 FROM marc_subfield_structure
1700 WHERE kohafield like 'item%'
1701 AND authorised_value != '' );
1703 my $itemlevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
1704 my $iteminfo = GetItem( $itemnumber );
1705 # warn( Data::Dumper->Dump( [ $itemlevel_authorised_values ], [ 'itemlevel_authorised_values' ] ) );
1707 foreach my $this_authorised_value ( keys %$itemlevel_authorised_values ) {
1708 my $field = $itemlevel_authorised_values->{ $this_authorised_value }->{'kohafield'};
1709 $field =~ s/^items\.//;
1710 if ( exists $iteminfo->{ $field } ) {
1711 $return->{ $this_authorised_value } = $iteminfo->{ $field };
1714 # warn( Data::Dumper->Dump( [ $return ], [ 'return' ] ) );
1718 =head3 get_authorised_value_images
1720 find a list of icons that are appropriate for display based on the
1721 authorised values for a biblio.
1723 parameters: listref of authorised values, such as comes from
1724 get_item_authorised_values or
1725 from C4::Biblio::get_biblio_authorised_values
1727 returns: listref of hashrefs for each image. Each hashref looks like this:
1729 { imageurl => '/intranet-tmpl/prog/img/itemtypeimg/npl/WEB.gif',
1734 Notes: Currently, I put on the full path to the images on the staff
1735 side. This should either be configurable or not done at all. Since I
1736 have to deal with 'intranet' or 'opac' in
1737 get_biblio_authorised_values, perhaps I should be passing it in.
1741 sub get_authorised_value_images {
1742 my $authorised_values = shift;
1746 my $authorised_value_list = GetAuthorisedValues();
1747 # warn ( Data::Dumper->Dump( [ $authorised_value_list ], [ 'authorised_value_list' ] ) );
1748 foreach my $this_authorised_value ( @$authorised_value_list ) {
1749 if ( exists $authorised_values->{ $this_authorised_value->{'category'} }
1750 && $authorised_values->{ $this_authorised_value->{'category'} } eq $this_authorised_value->{'authorised_value'} ) {
1751 # warn ( Data::Dumper->Dump( [ $this_authorised_value ], [ 'this_authorised_value' ] ) );
1752 if ( defined $this_authorised_value->{'imageurl'} ) {
1753 push @imagelist, { imageurl => C4::Koha::getitemtypeimagelocation( 'intranet', $this_authorised_value->{'imageurl'} ),
1754 label => $this_authorised_value->{'lib'},
1755 category => $this_authorised_value->{'category'},
1756 value => $this_authorised_value->{'authorised_value'}, };
1761 # warn ( Data::Dumper->Dump( [ \@imagelist ], [ 'imagelist' ] ) );
1766 =head1 LIMITED USE FUNCTIONS
1768 The following functions, while part of the public API,
1769 are not exported. This is generally because they are
1770 meant to be used by only one script for a specific
1771 purpose, and should not be used in any other context
1772 without careful thought.
1778 my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1780 Returns MARC::Record of the item passed in parameter.
1781 This function is meant for use only in C<cataloguing/additem.pl>,
1782 where it is needed to support that script's MARC-like
1788 my ( $biblionumber, $itemnumber ) = @_;
1790 # GetMarcItem has been revised so that it does the following:
1791 # 1. Gets the item information from the items table.
1792 # 2. Converts it to a MARC field for storage in the bib record.
1794 # The previous behavior was:
1795 # 1. Get the bib record.
1796 # 2. Return the MARC tag corresponding to the item record.
1798 # The difference is that one treats the items row as authoritative,
1799 # while the other treats the MARC representation as authoritative
1800 # under certain circumstances.
1802 my $itemrecord = GetItem($itemnumber);
1804 # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1805 # Also, don't emit a subfield if the underlying field is blank.
1808 return Item2Marc($itemrecord,$biblionumber);
1812 my ($itemrecord,$biblionumber)=@_;
1815 defined($itemrecord->{$_}) && $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : ()
1816 } keys %{ $itemrecord }
1818 my $itemmarc = TransformKohaToMarc($mungeditem);
1819 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",GetFrameworkCode($biblionumber)||'');
1821 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1822 if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1823 foreach my $field ($itemmarc->field($itemtag)){
1824 $field->add_subfields(@$unlinked_item_subfields);
1830 =head1 PRIVATE FUNCTIONS AND VARIABLES
1832 The following functions are not meant to be called
1833 directly, but are documented in order to explain
1834 the inner workings of C<C4::Items>.
1838 =head2 %derived_columns
1840 This hash keeps track of item columns that
1841 are strictly derived from other columns in
1842 the item record and are not meant to be set
1845 Each key in the hash should be the name of a
1846 column (as named by TransformMarcToKoha). Each
1847 value should be hashref whose keys are the
1848 columns on which the derived column depends. The
1849 hashref should also contain a 'BUILDER' key
1850 that is a reference to a sub that calculates
1855 my %derived_columns = (
1856 'items.cn_sort' => {
1857 'itemcallnumber' => 1,
1858 'items.cn_source' => 1,
1859 'BUILDER' => \&_calc_items_cn_sort,
1863 =head2 _set_derived_columns_for_add
1865 _set_derived_column_for_add($item);
1867 Given an item hash representing a new item to be added,
1868 calculate any derived columns. Currently the only
1869 such column is C<items.cn_sort>.
1873 sub _set_derived_columns_for_add {
1876 foreach my $column (keys %derived_columns) {
1877 my $builder = $derived_columns{$column}->{'BUILDER'};
1878 my $source_values = {};
1879 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1880 next if $source_column eq 'BUILDER';
1881 $source_values->{$source_column} = $item->{$source_column};
1883 $builder->($item, $source_values);
1887 =head2 _set_derived_columns_for_mod
1889 _set_derived_column_for_mod($item);
1891 Given an item hash representing a new item to be modified.
1892 calculate any derived columns. Currently the only
1893 such column is C<items.cn_sort>.
1895 This routine differs from C<_set_derived_columns_for_add>
1896 in that it needs to handle partial item records. In other
1897 words, the caller of C<ModItem> may have supplied only one
1898 or two columns to be changed, so this function needs to
1899 determine whether any of the columns to be changed affect
1900 any of the derived columns. Also, if a derived column
1901 depends on more than one column, but the caller is not
1902 changing all of then, this routine retrieves the unchanged
1903 values from the database in order to ensure a correct
1908 sub _set_derived_columns_for_mod {
1911 foreach my $column (keys %derived_columns) {
1912 my $builder = $derived_columns{$column}->{'BUILDER'};
1913 my $source_values = {};
1914 my %missing_sources = ();
1915 my $must_recalc = 0;
1916 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1917 next if $source_column eq 'BUILDER';
1918 if (exists $item->{$source_column}) {
1920 $source_values->{$source_column} = $item->{$source_column};
1922 $missing_sources{$source_column} = 1;
1926 foreach my $source_column (keys %missing_sources) {
1927 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
1929 $builder->($item, $source_values);
1934 =head2 _do_column_fixes_for_mod
1936 _do_column_fixes_for_mod($item);
1938 Given an item hashref containing one or more
1939 columns to modify, fix up certain values.
1940 Specifically, set to 0 any passed value
1941 of C<notforloan>, C<damaged>, C<itemlost>, or
1942 C<wthdrawn> that is either undefined or
1943 contains the empty string.
1947 sub _do_column_fixes_for_mod {
1950 if (exists $item->{'notforloan'} and
1951 (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
1952 $item->{'notforloan'} = 0;
1954 if (exists $item->{'damaged'} and
1955 (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
1956 $item->{'damaged'} = 0;
1958 if (exists $item->{'itemlost'} and
1959 (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
1960 $item->{'itemlost'} = 0;
1962 if (exists $item->{'wthdrawn'} and
1963 (not defined $item->{'wthdrawn'} or $item->{'wthdrawn'} eq '')) {
1964 $item->{'wthdrawn'} = 0;
1966 if (exists $item->{'location'} && !exists $item->{'permanent_location'}) {
1967 $item->{'permanent_location'} = $item->{'location'};
1969 if (exists $item->{'timestamp'}) {
1970 delete $item->{'timestamp'};
1974 =head2 _get_single_item_column
1976 _get_single_item_column($column, $itemnumber);
1978 Retrieves the value of a single column from an C<items>
1979 row specified by C<$itemnumber>.
1983 sub _get_single_item_column {
1985 my $itemnumber = shift;
1987 my $dbh = C4::Context->dbh;
1988 my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
1989 $sth->execute($itemnumber);
1990 my ($value) = $sth->fetchrow();
1994 =head2 _calc_items_cn_sort
1996 _calc_items_cn_sort($item, $source_values);
1998 Helper routine to calculate C<items.cn_sort>.
2002 sub _calc_items_cn_sort {
2004 my $source_values = shift;
2006 $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
2009 =head2 _set_defaults_for_add
2011 _set_defaults_for_add($item_hash);
2013 Given an item hash representing an item to be added, set
2014 correct default values for columns whose default value
2015 is not handled by the DBMS. This includes the following
2022 C<items.dateaccessioned>
2044 sub _set_defaults_for_add {
2046 $item->{dateaccessioned} ||= C4::Dates->new->output('iso');
2047 $item->{$_} ||= 0 for (qw( notforloan damaged itemlost wthdrawn));
2050 =head2 _koha_new_item
2052 my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
2054 Perform the actual insert into the C<items> table.
2058 sub _koha_new_item {
2059 my ( $item, $barcode ) = @_;
2060 my $dbh=C4::Context->dbh;
2063 "INSERT INTO items SET
2065 biblioitemnumber = ?,
2067 dateaccessioned = ?,
2071 replacementprice = ?,
2072 replacementpricedate = ?,
2073 datelastborrowed = ?,
2086 permanent_location = ?,
2098 more_subfields_xml = ?,
2102 my $sth = $dbh->prepare($query);
2103 my $today = C4::Dates->today('iso');
2105 $item->{'biblionumber'},
2106 $item->{'biblioitemnumber'},
2108 $item->{'dateaccessioned'},
2109 $item->{'booksellerid'},
2110 $item->{'homebranch'},
2112 $item->{'replacementprice'},
2113 $item->{'replacementpricedate'} || $today,
2114 $item->{datelastborrowed},
2115 $item->{datelastseen} || $today,
2117 $item->{'notforloan'},
2119 $item->{'itemlost'},
2120 $item->{'wthdrawn'},
2121 $item->{'itemcallnumber'},
2122 $item->{'restricted'},
2123 $item->{'itemnotes'},
2124 $item->{'holdingbranch'},
2126 $item->{'location'},
2127 $item->{'permanent_location'},
2130 $item->{'renewals'},
2131 $item->{'reserves'},
2132 $item->{'items.cn_source'},
2133 $item->{'items.cn_sort'},
2136 $item->{'materials'},
2138 $item->{'enumchron'},
2139 $item->{'more_subfields_xml'},
2140 $item->{'copynumber'},
2141 $item->{'stocknumber'},
2145 if ( defined $sth->errstr ) {
2146 $error.="ERROR in _koha_new_item $query".$sth->errstr;
2149 $itemnumber = $dbh->{'mysql_insertid'};
2152 return ( $itemnumber, $error );
2155 =head2 MoveItemFromBiblio
2157 MoveItemFromBiblio($itenumber, $frombiblio, $tobiblio);
2159 Moves an item from a biblio to another
2161 Returns undef if the move failed or the biblionumber of the destination record otherwise
2165 sub MoveItemFromBiblio {
2166 my ($itemnumber, $frombiblio, $tobiblio) = @_;
2167 my $dbh = C4::Context->dbh;
2168 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber = ?");
2169 $sth->execute( $tobiblio );
2170 my ( $tobiblioitem ) = $sth->fetchrow();
2171 $sth = $dbh->prepare("UPDATE items SET biblioitemnumber = ?, biblionumber = ? WHERE itemnumber = ? AND biblionumber = ?");
2172 my $return = $sth->execute($tobiblioitem, $tobiblio, $itemnumber, $frombiblio);
2174 ModZebra( $tobiblio, "specialUpdate", "biblioserver", undef, undef );
2175 ModZebra( $frombiblio, "specialUpdate", "biblioserver", undef, undef );
2176 # Checking if the item we want to move is in an order
2177 my $order = GetOrderFromItemnumber($itemnumber);
2179 # Replacing the biblionumber within the order if necessary
2180 $order->{'biblionumber'} = $tobiblio;
2190 DelItemCheck($dbh, $biblionumber, $itemnumber);
2192 Exported function (core API) for deleting an item record in Koha if there no current issue.
2197 my ( $dbh, $biblionumber, $itemnumber ) = @_;
2200 my $countanalytics=GetAnalyticsCount($itemnumber);
2203 # check that there is no issue on this item before deletion.
2204 my $sth=$dbh->prepare("select * from issues i where i.itemnumber=?");
2205 $sth->execute($itemnumber);
2207 my $item = GetItem($itemnumber);
2208 my $onloan=$sth->fetchrow;
2211 $error = "book_on_loan"
2213 elsif ( C4::Context->userenv->{flags} & 1 and
2214 C4::Context->preference("IndependantBranches") and
2215 (C4::Context->userenv->{branch} ne
2216 $item->{C4::Context->preference("HomeOrHoldingBranch")||'homebranch'}) )
2218 $error = "not_same_branch";
2221 # check it doesnt have a waiting reserve
2222 $sth=$dbh->prepare("SELECT * FROM reserves WHERE (found = 'W' or found = 'T') AND itemnumber = ?");
2223 $sth->execute($itemnumber);
2224 my $reserve=$sth->fetchrow;
2226 $error = "book_reserved";
2227 } elsif ($countanalytics > 0){
2228 $error = "linked_analytics";
2230 DelItem($dbh, $biblionumber, $itemnumber);
2237 =head2 _koha_modify_item
2239 my ($itemnumber,$error) =_koha_modify_item( $item );
2241 Perform the actual update of the C<items> row. Note that this
2242 routine accepts a hashref specifying the columns to update.
2246 sub _koha_modify_item {
2248 my $dbh=C4::Context->dbh;
2251 my $query = "UPDATE items SET ";
2253 for my $key ( keys %$item ) {
2255 push @bind, $item->{$key};
2258 $query .= " WHERE itemnumber=?";
2259 push @bind, $item->{'itemnumber'};
2260 my $sth = C4::Context->dbh->prepare($query);
2261 $sth->execute(@bind);
2262 if ( C4::Context->dbh->errstr ) {
2263 $error.="ERROR in _koha_modify_item $query".$dbh->errstr;
2266 return ($item->{'itemnumber'},$error);
2269 =head2 _koha_delete_item
2271 _koha_delete_item( $dbh, $itemnum );
2273 Internal function to delete an item record from the koha tables
2277 sub _koha_delete_item {
2278 my ( $dbh, $itemnum ) = @_;
2280 # save the deleted item to deleteditems table
2281 my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
2282 $sth->execute($itemnum);
2283 my $data = $sth->fetchrow_hashref();
2284 my $query = "INSERT INTO deleteditems SET ";
2286 foreach my $key ( keys %$data ) {
2287 $query .= "$key = ?,";
2288 push( @bind, $data->{$key} );
2291 $sth = $dbh->prepare($query);
2292 $sth->execute(@bind);
2294 # delete from items table
2295 $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
2296 $sth->execute($itemnum);
2300 =head2 _marc_from_item_hash
2302 my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
2304 Given an item hash representing a complete item record,
2305 create a C<MARC::Record> object containing an embedded
2306 tag representing that item.
2308 The third, optional parameter C<$unlinked_item_subfields> is
2309 an arrayref of subfields (not mapped to C<items> fields per the
2310 framework) to be added to the MARC representation
2315 sub _marc_from_item_hash {
2317 my $frameworkcode = shift;
2318 my $unlinked_item_subfields;
2320 $unlinked_item_subfields = shift;
2323 # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
2324 # Also, don't emit a subfield if the underlying field is blank.
2325 my $mungeditem = { map { (defined($item->{$_}) and $item->{$_} ne '') ?
2326 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
2327 : () } keys %{ $item } };
2329 my $item_marc = MARC::Record->new();
2330 foreach my $item_field ( keys %{$mungeditem} ) {
2331 my ( $tag, $subfield ) = GetMarcFromKohaField( $item_field, $frameworkcode );
2332 next unless defined $tag and defined $subfield; # skip if not mapped to MARC field
2333 my @values = split(/\s?\|\s?/, $mungeditem->{$item_field}, -1);
2334 foreach my $value (@values){
2335 if ( my $field = $item_marc->field($tag) ) {
2336 $field->add_subfields( $subfield => $value );
2338 my $add_subfields = [];
2339 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2340 $add_subfields = $unlinked_item_subfields;
2342 $item_marc->add_fields( $tag, " ", " ", $subfield => $value, @$add_subfields );
2350 =head2 _repack_item_errors
2352 Add an error message hash generated by C<CheckItemPreSave>
2353 to a list of errors.
2357 sub _repack_item_errors {
2358 my $item_sequence_num = shift;
2359 my $item_ref = shift;
2360 my $error_ref = shift;
2362 my @repacked_errors = ();
2364 foreach my $error_code (sort keys %{ $error_ref }) {
2365 my $repacked_error = {};
2366 $repacked_error->{'item_sequence'} = $item_sequence_num;
2367 $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
2368 $repacked_error->{'error_code'} = $error_code;
2369 $repacked_error->{'error_information'} = $error_ref->{$error_code};
2370 push @repacked_errors, $repacked_error;
2373 return @repacked_errors;
2376 =head2 _get_unlinked_item_subfields
2378 my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
2382 sub _get_unlinked_item_subfields {
2383 my $original_item_marc = shift;
2384 my $frameworkcode = shift;
2386 my $marcstructure = GetMarcStructure(1, $frameworkcode);
2388 # assume that this record has only one field, and that that
2389 # field contains only the item information
2391 my @fields = $original_item_marc->fields();
2392 if ($#fields > -1) {
2393 my $field = $fields[0];
2394 my $tag = $field->tag();
2395 foreach my $subfield ($field->subfields()) {
2396 if (defined $subfield->[1] and
2397 $subfield->[1] ne '' and
2398 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
2399 push @$subfields, $subfield->[0] => $subfield->[1];
2406 =head2 _get_unlinked_subfields_xml
2408 my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
2412 sub _get_unlinked_subfields_xml {
2413 my $unlinked_item_subfields = shift;
2416 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2417 my $marc = MARC::Record->new();
2418 # use of tag 999 is arbitrary, and doesn't need to match the item tag
2419 # used in the framework
2420 $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
2421 $marc->encoding("UTF-8");
2422 $xml = $marc->as_xml("USMARC");
2428 =head2 _parse_unlinked_item_subfields_from_xml
2430 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2434 sub _parse_unlinked_item_subfields_from_xml {
2437 return unless defined $xml and $xml ne "";
2438 my $marc = MARC::Record->new_from_xml(StripNonXmlChars($xml),'UTF-8');
2439 my $unlinked_subfields = [];
2440 my @fields = $marc->fields();
2441 if ($#fields > -1) {
2442 foreach my $subfield ($fields[0]->subfields()) {
2443 push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2446 return $unlinked_subfields;
2449 =head2 GetAnalyticsCount
2451 $count= &GetAnalyticsCount($itemnumber)
2453 counts Usage of itemnumber in Analytical bibliorecords.
2457 sub GetAnalyticsCount {
2458 my ($itemnumber) = @_;
2459 if (C4::Context->preference('NoZebra')) {
2460 # Read the index Koha-Auth-Number for this authid and count the lines
2461 my $result = C4::Search::NZanalyse("hi=$itemnumber");
2462 my @tab = split /;/,$result;
2465 ### ZOOM search here
2467 $query= "hi=".$itemnumber;
2468 my ($err,$res,$result) = C4::Search::SimpleSearch($query,0,10);
2476 $holds = &GetItemHolds($biblionumber, $itemnumber);
2480 This function return the count of holds with $biblionumber and $itemnumber
2485 my ($biblionumber, $itemnumber) = @_;
2487 my $dbh = C4::Context->dbh;
2488 my $query = "SELECT count(*)
2490 WHERE biblionumber=? AND itemnumber=?";
2491 my $sth = $dbh->prepare($query);
2492 $sth->execute($biblionumber, $itemnumber);
2493 $holds = $sth->fetchrow;