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 );
591 #search item field code
592 logaction("CATALOGUING", "DELETE", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
595 =head2 CheckItemPreSave
597 my $item_ref = TransformMarcToKoha($marc, 'items');
599 my %errors = CheckItemPreSave($item_ref);
600 if (exists $errors{'duplicate_barcode'}) {
601 print "item has duplicate barcode: ", $errors{'duplicate_barcode'}, "\n";
602 } elsif (exists $errors{'invalid_homebranch'}) {
603 print "item has invalid home branch: ", $errors{'invalid_homebranch'}, "\n";
604 } elsif (exists $errors{'invalid_holdingbranch'}) {
605 print "item has invalid holding branch: ", $errors{'invalid_holdingbranch'}, "\n";
610 Given a hashref containing item fields, determine if it can be
611 inserted or updated in the database. Specifically, checks for
612 database integrity issues, and returns a hash containing any
613 of the following keys, if applicable.
617 =item duplicate_barcode
619 Barcode, if it duplicates one already found in the database.
621 =item invalid_homebranch
623 Home branch, if not defined in branches table.
625 =item invalid_holdingbranch
627 Holding branch, if not defined in branches table.
631 This function does NOT implement any policy-related checks,
632 e.g., whether current operator is allowed to save an
633 item that has a given branch code.
637 sub CheckItemPreSave {
638 my $item_ref = shift;
642 # check for duplicate barcode
643 if (exists $item_ref->{'barcode'} and defined $item_ref->{'barcode'}) {
644 my $existing_itemnumber = GetItemnumberFromBarcode($item_ref->{'barcode'});
645 if ($existing_itemnumber) {
646 if (!exists $item_ref->{'itemnumber'} # new item
647 or $item_ref->{'itemnumber'} != $existing_itemnumber) { # existing item
648 $errors{'duplicate_barcode'} = $item_ref->{'barcode'};
653 # check for valid home branch
654 if (exists $item_ref->{'homebranch'} and defined $item_ref->{'homebranch'}) {
655 my $branch_name = GetBranchName($item_ref->{'homebranch'});
656 unless (defined $branch_name) {
657 # relies on fact that branches.branchname is a non-NULL column,
658 # so GetBranchName returns undef only if branch does not exist
659 $errors{'invalid_homebranch'} = $item_ref->{'homebranch'};
663 # check for valid holding branch
664 if (exists $item_ref->{'holdingbranch'} and defined $item_ref->{'holdingbranch'}) {
665 my $branch_name = GetBranchName($item_ref->{'holdingbranch'});
666 unless (defined $branch_name) {
667 # relies on fact that branches.branchname is a non-NULL column,
668 # so GetBranchName returns undef only if branch does not exist
669 $errors{'invalid_holdingbranch'} = $item_ref->{'holdingbranch'};
677 =head1 EXPORTED SPECIAL ACCESSOR FUNCTIONS
679 The following functions provide various ways of
680 getting an item record, a set of item records, or
681 lists of authorized values for certain item fields.
683 Some of the functions in this group are candidates
684 for refactoring -- for example, some of the code
685 in C<GetItemsByBiblioitemnumber> and C<GetItemsInfo>
686 has copy-and-paste work.
692 $itemstatushash = GetItemStatus($fwkcode);
694 Returns a list of valid values for the
695 C<items.notforloan> field.
697 NOTE: does B<not> return an individual item's
700 Can be MARC dependant.
702 But basically could be can be loan or not
703 Create a status selector with the following code
705 =head3 in PERL SCRIPT
707 my $itemstatushash = getitemstatus;
709 foreach my $thisstatus (keys %$itemstatushash) {
710 my %row =(value => $thisstatus,
711 statusname => $itemstatushash->{$thisstatus}->{'statusname'},
713 push @itemstatusloop, \%row;
715 $template->param(statusloop=>\@itemstatusloop);
719 <select name="statusloop">
720 <option value="">Default</option>
721 <!-- TMPL_LOOP name="statusloop" -->
722 <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="statusname" --></option>
730 # returns a reference to a hash of references to status...
733 my $dbh = C4::Context->dbh;
735 $fwk = '' unless ($fwk);
736 my ( $tag, $subfield ) =
737 GetMarcFromKohaField( "items.notforloan", $fwk );
738 if ( $tag and $subfield ) {
741 "SELECT authorised_value
742 FROM marc_subfield_structure
748 $sth->execute( $tag, $subfield, $fwk );
749 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
752 "SELECT authorised_value,lib
753 FROM authorised_values
758 $authvalsth->execute($authorisedvaluecat);
759 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
760 $itemstatus{$authorisedvalue} = $lib;
774 $itemstatus{"1"} = "Not For Loan";
778 =head2 GetItemLocation
780 $itemlochash = GetItemLocation($fwk);
782 Returns a list of valid values for the
783 C<items.location> field.
785 NOTE: does B<not> return an individual item's
788 where fwk stands for an optional framework code.
789 Create a location selector with the following code
791 =head3 in PERL SCRIPT
793 my $itemlochash = getitemlocation;
795 foreach my $thisloc (keys %$itemlochash) {
796 my $selected = 1 if $thisbranch eq $branch;
797 my %row =(locval => $thisloc,
798 selected => $selected,
799 locname => $itemlochash->{$thisloc},
801 push @itemlocloop, \%row;
803 $template->param(itemlocationloop => \@itemlocloop);
807 <select name="location">
808 <option value="">Default</option>
809 <!-- TMPL_LOOP name="itemlocationloop" -->
810 <option value="<!-- TMPL_VAR name="locval" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="locname" --></option>
816 sub GetItemLocation {
818 # returns a reference to a hash of references to location...
821 my $dbh = C4::Context->dbh;
823 $fwk = '' unless ($fwk);
824 my ( $tag, $subfield ) =
825 GetMarcFromKohaField( "items.location", $fwk );
826 if ( $tag and $subfield ) {
829 "SELECT authorised_value
830 FROM marc_subfield_structure
835 $sth->execute( $tag, $subfield, $fwk );
836 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
839 "SELECT authorised_value,lib
840 FROM authorised_values
844 $authvalsth->execute($authorisedvaluecat);
845 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
846 $itemlocation{$authorisedvalue} = $lib;
848 return \%itemlocation;
860 $itemlocation{"1"} = "Not For Loan";
861 return \%itemlocation;
866 $items = GetLostItems( $where, $orderby );
868 This function gets a list of lost items.
874 C<$where> is a hashref. it containts a field of the items table as key
875 and the value to match as value. For example:
877 { barcode => 'abc123',
878 homebranch => 'CPL', }
880 C<$orderby> is a field of the items table by which the resultset
885 C<$items> is a reference to an array full of hashrefs with columns
886 from the "items" table as keys.
888 =item usage in the perl script:
890 my $where = { barcode => '0001548' };
891 my $items = GetLostItems( $where, "homebranch" );
892 $template->param( itemsloop => $items );
899 # Getting input args.
902 my $dbh = C4::Context->dbh;
907 LEFT JOIN biblio ON (items.biblionumber = biblio.biblionumber)
908 LEFT JOIN biblioitems ON (items.biblionumber = biblioitems.biblionumber)
909 LEFT JOIN authorised_values ON (items.itemlost = authorised_values.authorised_value)
911 authorised_values.category = 'LOST'
912 AND itemlost IS NOT NULL
915 my @query_parameters;
916 foreach my $key (keys %$where) {
917 $query .= " AND $key LIKE ?";
918 push @query_parameters, "%$where->{$key}%";
920 my @ordervalues = qw/title author homebranch itype barcode price replacementprice lib datelastseen location/;
922 if ( defined $orderby && grep($orderby, @ordervalues)) {
923 $query .= ' ORDER BY '.$orderby;
926 my $sth = $dbh->prepare($query);
927 $sth->execute( @query_parameters );
929 while ( my $row = $sth->fetchrow_hashref ){
935 =head2 GetItemsForInventory
937 $itemlist = GetItemsForInventory($minlocation, $maxlocation,
938 $location, $itemtype $datelastseen, $branch,
939 $offset, $size, $statushash);
941 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
943 The sub returns a reference to a list of hashes, each containing
944 itemnumber, author, title, barcode, item callnumber, and date last
945 seen. It is ordered by callnumber then title.
947 The required minlocation & maxlocation parameters are used to specify a range of item callnumbers
948 the datelastseen can be used to specify that you want to see items not seen since a past date only.
949 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
950 $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.
954 sub GetItemsForInventory {
955 my ( $minlocation, $maxlocation,$location, $itemtype, $ignoreissued, $datelastseen, $branchcode, $branch, $offset, $size, $statushash ) = @_;
956 my $dbh = C4::Context->dbh;
957 my ( @bind_params, @where_strings );
959 my $query = <<'END_SQL';
960 SELECT items.itemnumber, barcode, itemcallnumber, title, author, biblio.biblionumber, datelastseen
962 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
963 LEFT JOIN biblioitems on items.biblionumber = biblioitems.biblionumber
966 for my $authvfield (keys %$statushash){
967 if ( scalar @{$statushash->{$authvfield}} > 0 ){
968 my $joinedvals = join ',', @{$statushash->{$authvfield}};
969 push @where_strings, "$authvfield in (" . $joinedvals . ")";
975 push @where_strings, 'itemcallnumber >= ?';
976 push @bind_params, $minlocation;
980 push @where_strings, 'itemcallnumber <= ?';
981 push @bind_params, $maxlocation;
985 $datelastseen = format_date_in_iso($datelastseen);
986 push @where_strings, '(datelastseen < ? OR datelastseen IS NULL)';
987 push @bind_params, $datelastseen;
991 push @where_strings, 'items.location = ?';
992 push @bind_params, $location;
996 if($branch eq "homebranch"){
997 push @where_strings, 'items.homebranch = ?';
999 push @where_strings, 'items.holdingbranch = ?';
1001 push @bind_params, $branchcode;
1005 push @where_strings, 'biblioitems.itemtype = ?';
1006 push @bind_params, $itemtype;
1009 if ( $ignoreissued) {
1010 $query .= "LEFT JOIN issues ON items.itemnumber = issues.itemnumber ";
1011 push @where_strings, 'issues.date_due IS NULL';
1014 if ( @where_strings ) {
1016 $query .= join ' AND ', @where_strings;
1018 $query .= ' ORDER BY items.cn_sort, itemcallnumber, title';
1019 my $sth = $dbh->prepare($query);
1020 $sth->execute( @bind_params );
1024 while ( my $row = $sth->fetchrow_hashref ) {
1025 $offset-- if ($offset);
1026 $row->{datelastseen}=format_date($row->{datelastseen});
1027 if ( ( !$offset ) && $size ) {
1028 push @results, $row;
1035 =head2 GetItemsCount
1037 $count = &GetItemsCount( $biblionumber);
1039 This function return count of item with $biblionumber
1044 my ( $biblionumber ) = @_;
1045 my $dbh = C4::Context->dbh;
1046 my $query = "SELECT count(*)
1048 WHERE biblionumber=?";
1049 my $sth = $dbh->prepare($query);
1050 $sth->execute($biblionumber);
1051 my $count = $sth->fetchrow;
1055 =head2 GetItemInfosOf
1057 GetItemInfosOf(@itemnumbers);
1061 sub GetItemInfosOf {
1062 my @itemnumbers = @_;
1067 WHERE itemnumber IN (' . join( ',', @itemnumbers ) . ')
1069 return get_infos_of( $query, 'itemnumber' );
1072 =head2 GetItemsByBiblioitemnumber
1074 GetItemsByBiblioitemnumber($biblioitemnumber);
1076 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1077 Called by C<C4::XISBN>
1081 sub GetItemsByBiblioitemnumber {
1082 my ( $bibitem ) = @_;
1083 my $dbh = C4::Context->dbh;
1084 my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1085 # Get all items attached to a biblioitem
1088 $sth->execute($bibitem) || die $sth->errstr;
1089 while ( my $data = $sth->fetchrow_hashref ) {
1090 # Foreach item, get circulation information
1091 my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1092 WHERE itemnumber = ?
1093 AND issues.borrowernumber = borrowers.borrowernumber"
1095 $sth2->execute( $data->{'itemnumber'} );
1096 if ( my $data2 = $sth2->fetchrow_hashref ) {
1097 # if item is out, set the due date and who it is out too
1098 $data->{'date_due'} = $data2->{'date_due'};
1099 $data->{'cardnumber'} = $data2->{'cardnumber'};
1100 $data->{'borrowernumber'} = $data2->{'borrowernumber'};
1103 # set date_due to blank, so in the template we check itemlost, and wthdrawn
1104 $data->{'date_due'} = '';
1106 # Find the last 3 people who borrowed this item.
1107 my $query2 = "SELECT * FROM old_issues, borrowers WHERE itemnumber = ?
1108 AND old_issues.borrowernumber = borrowers.borrowernumber
1109 ORDER BY returndate desc,timestamp desc LIMIT 3";
1110 $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1111 $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1113 while ( my $data2 = $sth2->fetchrow_hashref ) {
1114 $data->{"timestamp$i2"} = $data2->{'timestamp'};
1115 $data->{"card$i2"} = $data2->{'cardnumber'};
1116 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
1119 push(@results,$data);
1126 @results = GetItemsInfo($biblionumber);
1128 Returns information about items with the given biblionumber.
1130 C<GetItemsInfo> returns a list of references-to-hash. Each element
1131 contains a number of keys. Most of them are attributes from the
1132 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
1133 Koha database. Other keys include:
1137 =item C<$data-E<gt>{branchname}>
1139 The name (not the code) of the branch to which the book belongs.
1141 =item C<$data-E<gt>{datelastseen}>
1143 This is simply C<items.datelastseen>, except that while the date is
1144 stored in YYYY-MM-DD format in the database, here it is converted to
1145 DD/MM/YYYY format. A NULL date is returned as C<//>.
1147 =item C<$data-E<gt>{datedue}>
1149 =item C<$data-E<gt>{class}>
1151 This is the concatenation of C<biblioitems.classification>, the book's
1152 Dewey code, and C<biblioitems.subclass>.
1154 =item C<$data-E<gt>{ocount}>
1156 I think this is the number of copies of the book available.
1158 =item C<$data-E<gt>{order}>
1160 If this is set, it is set to C<One Order>.
1167 my ( $biblionumber ) = @_;
1168 my $dbh = C4::Context->dbh;
1169 # note biblioitems.* must be avoided to prevent large marc and marcxml fields from killing performance.
1175 biblioitems.itemtype,
1178 biblioitems.publicationyear,
1179 biblioitems.publishercode,
1180 biblioitems.volumedate,
1181 biblioitems.volumedesc,
1184 items.notforloan as itemnotforloan,
1185 itemtypes.description,
1186 itemtypes.notforloan as notforloan_per_itemtype,
1189 LEFT JOIN branches ON items.holdingbranch = branches.branchcode
1190 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1191 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1192 LEFT JOIN itemtypes ON itemtypes.itemtype = "
1193 . (C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype');
1194 $query .= " WHERE items.biblionumber = ? ORDER BY branches.branchname,items.dateaccessioned desc" ;
1195 my $sth = $dbh->prepare($query);
1196 $sth->execute($biblionumber);
1201 my $isth = $dbh->prepare(
1202 "SELECT issues.*,borrowers.cardnumber,borrowers.surname,borrowers.firstname,borrowers.branchcode as bcode
1203 FROM issues LEFT JOIN borrowers ON issues.borrowernumber=borrowers.borrowernumber
1204 WHERE itemnumber = ?"
1206 my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=? ");
1207 while ( my $data = $sth->fetchrow_hashref ) {
1210 $isth->execute( $data->{'itemnumber'} );
1211 if ( my $idata = $isth->fetchrow_hashref ) {
1212 $data->{borrowernumber} = $idata->{borrowernumber};
1213 $data->{cardnumber} = $idata->{cardnumber};
1214 $data->{surname} = $idata->{surname};
1215 $data->{firstname} = $idata->{firstname};
1216 $datedue = $idata->{'date_due'};
1217 if (C4::Context->preference("IndependantBranches")){
1218 my $userenv = C4::Context->userenv;
1219 if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
1220 $data->{'NOTSAMEBRANCH'} = 1 if ($idata->{'bcode'} ne $userenv->{branch});
1224 if ( $data->{'serial'}) {
1225 $ssth->execute($data->{'itemnumber'}) ;
1226 ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
1229 if ( $datedue eq '' ) {
1230 my ( $restype, $reserves ) =
1231 C4::Reserves::CheckReserves( $data->{'itemnumber'} );
1232 # Previous conditional check with if ($restype) is not needed because a true
1233 # result for one item will result in subsequent items defaulting to this true
1235 $count_reserves = $restype;
1237 #get branch information.....
1238 my $bsth = $dbh->prepare(
1239 "SELECT * FROM branches WHERE branchcode = ?
1242 $bsth->execute( $data->{'holdingbranch'} );
1243 if ( my $bdata = $bsth->fetchrow_hashref ) {
1244 $data->{'branchname'} = $bdata->{'branchname'};
1246 $data->{'datedue'} = $datedue;
1247 $data->{'count_reserves'} = $count_reserves;
1249 # get notforloan complete status if applicable
1250 my $sthnflstatus = $dbh->prepare(
1251 'SELECT authorised_value
1252 FROM marc_subfield_structure
1253 WHERE kohafield="items.notforloan"
1257 $sthnflstatus->execute;
1258 my ($authorised_valuecode) = $sthnflstatus->fetchrow;
1259 if ($authorised_valuecode) {
1260 $sthnflstatus = $dbh->prepare(
1261 "SELECT lib FROM authorised_values
1263 AND authorised_value=?"
1265 $sthnflstatus->execute( $authorised_valuecode,
1266 $data->{itemnotforloan} );
1267 my ($lib) = $sthnflstatus->fetchrow;
1268 $data->{notforloanvalue} = $lib;
1271 # get restricted status and description if applicable
1272 my $restrictedstatus = $dbh->prepare(
1273 'SELECT authorised_value
1274 FROM marc_subfield_structure
1275 WHERE kohafield="items.restricted"
1279 $restrictedstatus->execute;
1280 ($authorised_valuecode) = $restrictedstatus->fetchrow;
1281 if ($authorised_valuecode) {
1282 $restrictedstatus = $dbh->prepare(
1283 "SELECT lib,lib_opac FROM authorised_values
1285 AND authorised_value=?"
1287 $restrictedstatus->execute( $authorised_valuecode,
1288 $data->{restricted} );
1290 if ( my $rstdata = $restrictedstatus->fetchrow_hashref ) {
1291 $data->{restricted} = $rstdata->{'lib'};
1292 $data->{restrictedopac} = $rstdata->{'lib_opac'};
1296 # my stack procedures
1297 my $stackstatus = $dbh->prepare(
1298 'SELECT authorised_value
1299 FROM marc_subfield_structure
1300 WHERE kohafield="items.stack"
1303 $stackstatus->execute;
1305 ($authorised_valuecode) = $stackstatus->fetchrow;
1306 if ($authorised_valuecode) {
1307 $stackstatus = $dbh->prepare(
1309 FROM authorised_values
1311 AND authorised_value=?
1314 $stackstatus->execute( $authorised_valuecode, $data->{stack} );
1315 my ($lib) = $stackstatus->fetchrow;
1316 $data->{stack} = $lib;
1318 # Find the last 3 people who borrowed this item.
1319 my $sth2 = $dbh->prepare("SELECT * FROM old_issues,borrowers
1320 WHERE itemnumber = ?
1321 AND old_issues.borrowernumber = borrowers.borrowernumber
1322 ORDER BY returndate DESC
1324 $sth2->execute($data->{'itemnumber'});
1326 while (my $data2 = $sth2->fetchrow_hashref()) {
1327 $data->{"timestamp$ii"} = $data2->{'timestamp'} if $data2->{'timestamp'};
1328 $data->{"card$ii"} = $data2->{'cardnumber'} if $data2->{'cardnumber'};
1329 $data->{"borrower$ii"} = $data2->{'borrowernumber'} if $data2->{'borrowernumber'};
1333 $results[$i] = $data;
1337 return( sort { ($b->{'publisheddate'} || $b->{'enumchron'}) cmp ($a->{'publisheddate'} || $a->{'enumchron'}) } @results );
1343 =head2 GetItemsLocationInfo
1345 my @itemlocinfo = GetItemsLocationInfo($biblionumber);
1347 Returns the branch names, shelving location and itemcallnumber for each item attached to the biblio in question
1349 C<GetItemsInfo> returns a list of references-to-hash. Data returned:
1353 =item C<$data-E<gt>{homebranch}>
1355 Branch Name of the item's homebranch
1357 =item C<$data-E<gt>{holdingbranch}>
1359 Branch Name of the item's holdingbranch
1361 =item C<$data-E<gt>{location}>
1363 Item's shelving location code
1365 =item C<$data-E<gt>{location_intranet}>
1367 The intranet description for the Shelving Location as set in authorised_values 'LOC'
1369 =item C<$data-E<gt>{location_opac}>
1371 The OPAC description for the Shelving Location as set in authorised_values 'LOC'. Falls back to intranet description if no OPAC
1374 =item C<$data-E<gt>{itemcallnumber}>
1376 Item's itemcallnumber
1378 =item C<$data-E<gt>{cn_sort}>
1380 Item's call number normalized for sorting
1386 sub GetItemsLocationInfo {
1387 my $biblionumber = shift;
1390 my $dbh = C4::Context->dbh;
1391 my $query = "SELECT a.branchname as homebranch, b.branchname as holdingbranch,
1392 location, itemcallnumber, cn_sort
1393 FROM items, branches as a, branches as b
1394 WHERE homebranch = a.branchcode AND holdingbranch = b.branchcode
1395 AND biblionumber = ?
1396 ORDER BY cn_sort ASC";
1397 my $sth = $dbh->prepare($query);
1398 $sth->execute($biblionumber);
1400 while ( my $data = $sth->fetchrow_hashref ) {
1401 $data->{location_intranet} = GetKohaAuthorisedValueLib('LOC', $data->{location});
1402 $data->{location_opac}= GetKohaAuthorisedValueLib('LOC', $data->{location}, 1);
1403 push @results, $data;
1408 =head2 GetHostItemsInfo
1410 $hostiteminfo = GetHostItemsInfo($hostfield);
1411 Returns the iteminfo for items linked to records via a host field
1415 sub GetHostItemsInfo {
1417 my @returnitemsInfo;
1419 if (C4::Context->preference('marcflavour') eq 'MARC21' ||
1420 C4::Context->preference('marcflavour') eq 'NORMARC'){
1421 foreach my $hostfield ( $record->field('773') ) {
1422 my $hostbiblionumber = $hostfield->subfield("0");
1423 my $linkeditemnumber = $hostfield->subfield("9");
1424 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1425 foreach my $hostitemInfo (@hostitemInfos){
1426 if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1427 push (@returnitemsInfo,$hostitemInfo);
1432 } elsif ( C4::Context->preference('marcflavour') eq 'UNIMARC'){
1433 foreach my $hostfield ( $record->field('461') ) {
1434 my $hostbiblionumber = $hostfield->subfield("0");
1435 my $linkeditemnumber = $hostfield->subfield("9");
1436 my @hostitemInfos = GetItemsInfo($hostbiblionumber);
1437 foreach my $hostitemInfo (@hostitemInfos){
1438 if ($hostitemInfo->{itemnumber} eq $linkeditemnumber){
1439 push (@returnitemsInfo,$hostitemInfo);
1445 return @returnitemsInfo;
1449 =head2 GetLastAcquisitions
1451 my $lastacq = GetLastAcquisitions({'branches' => ('branch1','branch2'),
1452 'itemtypes' => ('BK','BD')}, 10);
1456 sub GetLastAcquisitions {
1457 my ($data,$max) = @_;
1459 my $itemtype = C4::Context->preference('item-level_itypes') ? 'itype' : 'itemtype';
1461 my $number_of_branches = @{$data->{branches}};
1462 my $number_of_itemtypes = @{$data->{itemtypes}};
1465 my @where = ('WHERE 1 ');
1466 $number_of_branches and push @where
1467 , 'AND holdingbranch IN ('
1468 , join(',', ('?') x $number_of_branches )
1472 $number_of_itemtypes and push @where
1473 , "AND $itemtype IN ("
1474 , join(',', ('?') x $number_of_itemtypes )
1478 my $query = "SELECT biblio.biblionumber as biblionumber, title, dateaccessioned
1479 FROM items RIGHT JOIN biblio ON (items.biblionumber=biblio.biblionumber)
1480 RIGHT JOIN biblioitems ON (items.biblioitemnumber=biblioitems.biblioitemnumber)
1482 GROUP BY biblio.biblionumber
1483 ORDER BY dateaccessioned DESC LIMIT $max";
1485 my $dbh = C4::Context->dbh;
1486 my $sth = $dbh->prepare($query);
1488 $sth->execute((@{$data->{branches}}, @{$data->{itemtypes}}));
1491 while( my $row = $sth->fetchrow_hashref){
1492 push @results, {date => $row->{dateaccessioned}
1493 , biblionumber => $row->{biblionumber}
1494 , title => $row->{title}};
1500 =head2 get_itemnumbers_of
1502 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1504 Given a list of biblionumbers, return the list of corresponding itemnumbers
1505 for each biblionumber.
1507 Return a reference on a hash where keys are biblionumbers and values are
1508 references on array of itemnumbers.
1512 sub get_itemnumbers_of {
1513 my @biblionumbers = @_;
1515 my $dbh = C4::Context->dbh;
1521 WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1523 my $sth = $dbh->prepare($query);
1524 $sth->execute(@biblionumbers);
1528 while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1529 push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1532 return \%itemnumbers_of;
1535 =head2 get_hostitemnumbers_of
1537 my @itemnumbers_of = get_hostitemnumbers_of($biblionumber);
1539 Given a biblionumber, return the list of corresponding itemnumbers that are linked to it via host fields
1541 Return a reference on a hash where key is a biblionumber and values are
1542 references on array of itemnumbers.
1547 sub get_hostitemnumbers_of {
1548 my ($biblionumber) = @_;
1549 my $marcrecord = GetMarcBiblio($biblionumber);
1550 my (@returnhostitemnumbers,$tag, $biblio_s, $item_s);
1552 my $marcflavor = C4::Context->preference('marcflavour');
1553 if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1557 } elsif ($marcflavor eq 'UNIMARC') {
1563 foreach my $hostfield ( $marcrecord->field($tag) ) {
1564 my $hostbiblionumber = $hostfield->subfield($biblio_s);
1565 my $linkeditemnumber = $hostfield->subfield($item_s);
1567 if (my $itemnumbers = get_itemnumbers_of($hostbiblionumber)->{$hostbiblionumber})
1569 @itemnumbers = @$itemnumbers;
1571 foreach my $itemnumber (@itemnumbers){
1572 if ($itemnumber eq $linkeditemnumber){
1573 push (@returnhostitemnumbers,$itemnumber);
1578 return @returnhostitemnumbers;
1582 =head2 GetItemnumberFromBarcode
1584 $result = GetItemnumberFromBarcode($barcode);
1588 sub GetItemnumberFromBarcode {
1590 my $dbh = C4::Context->dbh;
1593 $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1594 $rq->execute($barcode);
1595 my ($result) = $rq->fetchrow;
1599 =head2 GetBarcodeFromItemnumber
1601 $result = GetBarcodeFromItemnumber($itemnumber);
1605 sub GetBarcodeFromItemnumber {
1606 my ($itemnumber) = @_;
1607 my $dbh = C4::Context->dbh;
1610 $dbh->prepare("SELECT barcode FROM items WHERE items.itemnumber=?");
1611 $rq->execute($itemnumber);
1612 my ($result) = $rq->fetchrow;
1616 =head2 GetHiddenItemnumbers
1620 $result = GetHiddenItemnumbers(@items);
1626 sub GetHiddenItemnumbers {
1630 my $yaml = C4::Context->preference('OpacHiddenItems');
1633 $hidingrules = YAML::Load($yaml);
1636 warn "Unable to parse OpacHiddenItems syspref : $@";
1639 my $dbh = C4::Context->dbh;
1642 foreach my $item (@items) {
1644 # We check each rule
1645 foreach my $field (keys %$hidingrules) {
1646 my $query = "SELECT $field from items where itemnumber = ?";
1647 my $sth = $dbh->prepare($query);
1648 $sth->execute($item->{'itemnumber'});
1649 my ($result) = $sth->fetchrow;
1651 # If the results matches the values in the yaml file
1652 if (any { $result eq $_ } @{$hidingrules->{$field}}) {
1654 # We add the itemnumber to the list
1655 push @resultitems, $item->{'itemnumber'};
1657 # If at least one rule matched for an item, no need to test the others
1662 return @resultitems;
1667 =head3 get_item_authorised_values
1669 find the types and values for all authorised values assigned to this item.
1671 parameters: itemnumber
1673 returns: a hashref malling the authorised value to the value set for this itemnumber
1675 $authorised_values = {
1681 'RESTRICTED' => undef,
1684 'branches' => 'CPL',
1685 'cn_source' => undef,
1686 'itemtypes' => 'SER',
1689 Notes: see C4::Biblio::get_biblio_authorised_values for a similar method at the biblio level.
1693 sub get_item_authorised_values {
1694 my $itemnumber = shift;
1696 # assume that these entries in the authorised_value table are item level.
1697 my $query = q(SELECT distinct authorised_value, kohafield
1698 FROM marc_subfield_structure
1699 WHERE kohafield like 'item%'
1700 AND authorised_value != '' );
1702 my $itemlevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
1703 my $iteminfo = GetItem( $itemnumber );
1704 # warn( Data::Dumper->Dump( [ $itemlevel_authorised_values ], [ 'itemlevel_authorised_values' ] ) );
1706 foreach my $this_authorised_value ( keys %$itemlevel_authorised_values ) {
1707 my $field = $itemlevel_authorised_values->{ $this_authorised_value }->{'kohafield'};
1708 $field =~ s/^items\.//;
1709 if ( exists $iteminfo->{ $field } ) {
1710 $return->{ $this_authorised_value } = $iteminfo->{ $field };
1713 # warn( Data::Dumper->Dump( [ $return ], [ 'return' ] ) );
1717 =head3 get_authorised_value_images
1719 find a list of icons that are appropriate for display based on the
1720 authorised values for a biblio.
1722 parameters: listref of authorised values, such as comes from
1723 get_item_authorised_values or
1724 from C4::Biblio::get_biblio_authorised_values
1726 returns: listref of hashrefs for each image. Each hashref looks like this:
1728 { imageurl => '/intranet-tmpl/prog/img/itemtypeimg/npl/WEB.gif',
1733 Notes: Currently, I put on the full path to the images on the staff
1734 side. This should either be configurable or not done at all. Since I
1735 have to deal with 'intranet' or 'opac' in
1736 get_biblio_authorised_values, perhaps I should be passing it in.
1740 sub get_authorised_value_images {
1741 my $authorised_values = shift;
1745 my $authorised_value_list = GetAuthorisedValues();
1746 # warn ( Data::Dumper->Dump( [ $authorised_value_list ], [ 'authorised_value_list' ] ) );
1747 foreach my $this_authorised_value ( @$authorised_value_list ) {
1748 if ( exists $authorised_values->{ $this_authorised_value->{'category'} }
1749 && $authorised_values->{ $this_authorised_value->{'category'} } eq $this_authorised_value->{'authorised_value'} ) {
1750 # warn ( Data::Dumper->Dump( [ $this_authorised_value ], [ 'this_authorised_value' ] ) );
1751 if ( defined $this_authorised_value->{'imageurl'} ) {
1752 push @imagelist, { imageurl => C4::Koha::getitemtypeimagelocation( 'intranet', $this_authorised_value->{'imageurl'} ),
1753 label => $this_authorised_value->{'lib'},
1754 category => $this_authorised_value->{'category'},
1755 value => $this_authorised_value->{'authorised_value'}, };
1760 # warn ( Data::Dumper->Dump( [ \@imagelist ], [ 'imagelist' ] ) );
1765 =head1 LIMITED USE FUNCTIONS
1767 The following functions, while part of the public API,
1768 are not exported. This is generally because they are
1769 meant to be used by only one script for a specific
1770 purpose, and should not be used in any other context
1771 without careful thought.
1777 my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1779 Returns MARC::Record of the item passed in parameter.
1780 This function is meant for use only in C<cataloguing/additem.pl>,
1781 where it is needed to support that script's MARC-like
1787 my ( $biblionumber, $itemnumber ) = @_;
1789 # GetMarcItem has been revised so that it does the following:
1790 # 1. Gets the item information from the items table.
1791 # 2. Converts it to a MARC field for storage in the bib record.
1793 # The previous behavior was:
1794 # 1. Get the bib record.
1795 # 2. Return the MARC tag corresponding to the item record.
1797 # The difference is that one treats the items row as authoritative,
1798 # while the other treats the MARC representation as authoritative
1799 # under certain circumstances.
1801 my $itemrecord = GetItem($itemnumber);
1803 # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1804 # Also, don't emit a subfield if the underlying field is blank.
1807 return Item2Marc($itemrecord,$biblionumber);
1811 my ($itemrecord,$biblionumber)=@_;
1814 defined($itemrecord->{$_}) && $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : ()
1815 } keys %{ $itemrecord }
1817 my $itemmarc = TransformKohaToMarc($mungeditem);
1818 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",GetFrameworkCode($biblionumber)||'');
1820 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1821 if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1822 foreach my $field ($itemmarc->field($itemtag)){
1823 $field->add_subfields(@$unlinked_item_subfields);
1829 =head1 PRIVATE FUNCTIONS AND VARIABLES
1831 The following functions are not meant to be called
1832 directly, but are documented in order to explain
1833 the inner workings of C<C4::Items>.
1837 =head2 %derived_columns
1839 This hash keeps track of item columns that
1840 are strictly derived from other columns in
1841 the item record and are not meant to be set
1844 Each key in the hash should be the name of a
1845 column (as named by TransformMarcToKoha). Each
1846 value should be hashref whose keys are the
1847 columns on which the derived column depends. The
1848 hashref should also contain a 'BUILDER' key
1849 that is a reference to a sub that calculates
1854 my %derived_columns = (
1855 'items.cn_sort' => {
1856 'itemcallnumber' => 1,
1857 'items.cn_source' => 1,
1858 'BUILDER' => \&_calc_items_cn_sort,
1862 =head2 _set_derived_columns_for_add
1864 _set_derived_column_for_add($item);
1866 Given an item hash representing a new item to be added,
1867 calculate any derived columns. Currently the only
1868 such column is C<items.cn_sort>.
1872 sub _set_derived_columns_for_add {
1875 foreach my $column (keys %derived_columns) {
1876 my $builder = $derived_columns{$column}->{'BUILDER'};
1877 my $source_values = {};
1878 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1879 next if $source_column eq 'BUILDER';
1880 $source_values->{$source_column} = $item->{$source_column};
1882 $builder->($item, $source_values);
1886 =head2 _set_derived_columns_for_mod
1888 _set_derived_column_for_mod($item);
1890 Given an item hash representing a new item to be modified.
1891 calculate any derived columns. Currently the only
1892 such column is C<items.cn_sort>.
1894 This routine differs from C<_set_derived_columns_for_add>
1895 in that it needs to handle partial item records. In other
1896 words, the caller of C<ModItem> may have supplied only one
1897 or two columns to be changed, so this function needs to
1898 determine whether any of the columns to be changed affect
1899 any of the derived columns. Also, if a derived column
1900 depends on more than one column, but the caller is not
1901 changing all of then, this routine retrieves the unchanged
1902 values from the database in order to ensure a correct
1907 sub _set_derived_columns_for_mod {
1910 foreach my $column (keys %derived_columns) {
1911 my $builder = $derived_columns{$column}->{'BUILDER'};
1912 my $source_values = {};
1913 my %missing_sources = ();
1914 my $must_recalc = 0;
1915 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1916 next if $source_column eq 'BUILDER';
1917 if (exists $item->{$source_column}) {
1919 $source_values->{$source_column} = $item->{$source_column};
1921 $missing_sources{$source_column} = 1;
1925 foreach my $source_column (keys %missing_sources) {
1926 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
1928 $builder->($item, $source_values);
1933 =head2 _do_column_fixes_for_mod
1935 _do_column_fixes_for_mod($item);
1937 Given an item hashref containing one or more
1938 columns to modify, fix up certain values.
1939 Specifically, set to 0 any passed value
1940 of C<notforloan>, C<damaged>, C<itemlost>, or
1941 C<wthdrawn> that is either undefined or
1942 contains the empty string.
1946 sub _do_column_fixes_for_mod {
1949 if (exists $item->{'notforloan'} and
1950 (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
1951 $item->{'notforloan'} = 0;
1953 if (exists $item->{'damaged'} and
1954 (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
1955 $item->{'damaged'} = 0;
1957 if (exists $item->{'itemlost'} and
1958 (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
1959 $item->{'itemlost'} = 0;
1961 if (exists $item->{'wthdrawn'} and
1962 (not defined $item->{'wthdrawn'} or $item->{'wthdrawn'} eq '')) {
1963 $item->{'wthdrawn'} = 0;
1965 if (exists $item->{'location'} && !exists $item->{'permanent_location'}) {
1966 $item->{'permanent_location'} = $item->{'location'};
1968 if (exists $item->{'timestamp'}) {
1969 delete $item->{'timestamp'};
1973 =head2 _get_single_item_column
1975 _get_single_item_column($column, $itemnumber);
1977 Retrieves the value of a single column from an C<items>
1978 row specified by C<$itemnumber>.
1982 sub _get_single_item_column {
1984 my $itemnumber = shift;
1986 my $dbh = C4::Context->dbh;
1987 my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
1988 $sth->execute($itemnumber);
1989 my ($value) = $sth->fetchrow();
1993 =head2 _calc_items_cn_sort
1995 _calc_items_cn_sort($item, $source_values);
1997 Helper routine to calculate C<items.cn_sort>.
2001 sub _calc_items_cn_sort {
2003 my $source_values = shift;
2005 $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
2008 =head2 _set_defaults_for_add
2010 _set_defaults_for_add($item_hash);
2012 Given an item hash representing an item to be added, set
2013 correct default values for columns whose default value
2014 is not handled by the DBMS. This includes the following
2021 C<items.dateaccessioned>
2043 sub _set_defaults_for_add {
2045 $item->{dateaccessioned} ||= C4::Dates->new->output('iso');
2046 $item->{$_} ||= 0 for (qw( notforloan damaged itemlost wthdrawn));
2049 =head2 _koha_new_item
2051 my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
2053 Perform the actual insert into the C<items> table.
2057 sub _koha_new_item {
2058 my ( $item, $barcode ) = @_;
2059 my $dbh=C4::Context->dbh;
2062 "INSERT INTO items SET
2064 biblioitemnumber = ?,
2066 dateaccessioned = ?,
2070 replacementprice = ?,
2071 replacementpricedate = ?,
2072 datelastborrowed = ?,
2085 permanent_location = ?,
2097 more_subfields_xml = ?,
2101 my $sth = $dbh->prepare($query);
2102 my $today = C4::Dates->today('iso');
2104 $item->{'biblionumber'},
2105 $item->{'biblioitemnumber'},
2107 $item->{'dateaccessioned'},
2108 $item->{'booksellerid'},
2109 $item->{'homebranch'},
2111 $item->{'replacementprice'},
2112 $item->{'replacementpricedate'} || $today,
2113 $item->{datelastborrowed},
2114 $item->{datelastseen} || $today,
2116 $item->{'notforloan'},
2118 $item->{'itemlost'},
2119 $item->{'wthdrawn'},
2120 $item->{'itemcallnumber'},
2121 $item->{'restricted'},
2122 $item->{'itemnotes'},
2123 $item->{'holdingbranch'},
2125 $item->{'location'},
2126 $item->{'permanent_location'},
2129 $item->{'renewals'},
2130 $item->{'reserves'},
2131 $item->{'items.cn_source'},
2132 $item->{'items.cn_sort'},
2135 $item->{'materials'},
2137 $item->{'enumchron'},
2138 $item->{'more_subfields_xml'},
2139 $item->{'copynumber'},
2140 $item->{'stocknumber'},
2144 if ( defined $sth->errstr ) {
2145 $error.="ERROR in _koha_new_item $query".$sth->errstr;
2148 $itemnumber = $dbh->{'mysql_insertid'};
2151 return ( $itemnumber, $error );
2154 =head2 MoveItemFromBiblio
2156 MoveItemFromBiblio($itenumber, $frombiblio, $tobiblio);
2158 Moves an item from a biblio to another
2160 Returns undef if the move failed or the biblionumber of the destination record otherwise
2164 sub MoveItemFromBiblio {
2165 my ($itemnumber, $frombiblio, $tobiblio) = @_;
2166 my $dbh = C4::Context->dbh;
2167 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber = ?");
2168 $sth->execute( $tobiblio );
2169 my ( $tobiblioitem ) = $sth->fetchrow();
2170 $sth = $dbh->prepare("UPDATE items SET biblioitemnumber = ?, biblionumber = ? WHERE itemnumber = ? AND biblionumber = ?");
2171 my $return = $sth->execute($tobiblioitem, $tobiblio, $itemnumber, $frombiblio);
2173 ModZebra( $tobiblio, "specialUpdate", "biblioserver", undef, undef );
2174 ModZebra( $frombiblio, "specialUpdate", "biblioserver", undef, undef );
2175 # Checking if the item we want to move is in an order
2176 my $order = GetOrderFromItemnumber($itemnumber);
2178 # Replacing the biblionumber within the order if necessary
2179 $order->{'biblionumber'} = $tobiblio;
2189 DelItemCheck($dbh, $biblionumber, $itemnumber);
2191 Exported function (core API) for deleting an item record in Koha if there no current issue.
2196 my ( $dbh, $biblionumber, $itemnumber ) = @_;
2199 my $countanalytics=GetAnalyticsCount($itemnumber);
2202 # check that there is no issue on this item before deletion.
2203 my $sth=$dbh->prepare("select * from issues i where i.itemnumber=?");
2204 $sth->execute($itemnumber);
2206 my $item = GetItem($itemnumber);
2207 my $onloan=$sth->fetchrow;
2210 $error = "book_on_loan"
2212 elsif ( C4::Context->userenv->{flags} & 1 and
2213 C4::Context->preference("IndependantBranches") and
2214 (C4::Context->userenv->{branch} ne
2215 $item->{C4::Context->preference("HomeOrHoldingBranch")||'homebranch'}) )
2217 $error = "not_same_branch";
2220 # check it doesnt have a waiting reserve
2221 $sth=$dbh->prepare("SELECT * FROM reserves WHERE (found = 'W' or found = 'T') AND itemnumber = ?");
2222 $sth->execute($itemnumber);
2223 my $reserve=$sth->fetchrow;
2225 $error = "book_reserved";
2226 } elsif ($countanalytics > 0){
2227 $error = "linked_analytics";
2229 DelItem($dbh, $biblionumber, $itemnumber);
2236 =head2 _koha_modify_item
2238 my ($itemnumber,$error) =_koha_modify_item( $item );
2240 Perform the actual update of the C<items> row. Note that this
2241 routine accepts a hashref specifying the columns to update.
2245 sub _koha_modify_item {
2247 my $dbh=C4::Context->dbh;
2250 my $query = "UPDATE items SET ";
2252 for my $key ( keys %$item ) {
2254 push @bind, $item->{$key};
2257 $query .= " WHERE itemnumber=?";
2258 push @bind, $item->{'itemnumber'};
2259 my $sth = C4::Context->dbh->prepare($query);
2260 $sth->execute(@bind);
2261 if ( C4::Context->dbh->errstr ) {
2262 $error.="ERROR in _koha_modify_item $query".$dbh->errstr;
2265 return ($item->{'itemnumber'},$error);
2268 =head2 _koha_delete_item
2270 _koha_delete_item( $dbh, $itemnum );
2272 Internal function to delete an item record from the koha tables
2276 sub _koha_delete_item {
2277 my ( $dbh, $itemnum ) = @_;
2279 # save the deleted item to deleteditems table
2280 my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
2281 $sth->execute($itemnum);
2282 my $data = $sth->fetchrow_hashref();
2283 my $query = "INSERT INTO deleteditems SET ";
2285 foreach my $key ( keys %$data ) {
2286 $query .= "$key = ?,";
2287 push( @bind, $data->{$key} );
2290 $sth = $dbh->prepare($query);
2291 $sth->execute(@bind);
2293 # delete from items table
2294 $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
2295 $sth->execute($itemnum);
2299 =head2 _marc_from_item_hash
2301 my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
2303 Given an item hash representing a complete item record,
2304 create a C<MARC::Record> object containing an embedded
2305 tag representing that item.
2307 The third, optional parameter C<$unlinked_item_subfields> is
2308 an arrayref of subfields (not mapped to C<items> fields per the
2309 framework) to be added to the MARC representation
2314 sub _marc_from_item_hash {
2316 my $frameworkcode = shift;
2317 my $unlinked_item_subfields;
2319 $unlinked_item_subfields = shift;
2322 # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
2323 # Also, don't emit a subfield if the underlying field is blank.
2324 my $mungeditem = { map { (defined($item->{$_}) and $item->{$_} ne '') ?
2325 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
2326 : () } keys %{ $item } };
2328 my $item_marc = MARC::Record->new();
2329 foreach my $item_field ( keys %{$mungeditem} ) {
2330 my ( $tag, $subfield ) = GetMarcFromKohaField( $item_field, $frameworkcode );
2331 next unless defined $tag and defined $subfield; # skip if not mapped to MARC field
2332 my @values = split(/\s?\|\s?/, $mungeditem->{$item_field}, -1);
2333 foreach my $value (@values){
2334 if ( my $field = $item_marc->field($tag) ) {
2335 $field->add_subfields( $subfield => $value );
2337 my $add_subfields = [];
2338 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2339 $add_subfields = $unlinked_item_subfields;
2341 $item_marc->add_fields( $tag, " ", " ", $subfield => $value, @$add_subfields );
2349 =head2 _repack_item_errors
2351 Add an error message hash generated by C<CheckItemPreSave>
2352 to a list of errors.
2356 sub _repack_item_errors {
2357 my $item_sequence_num = shift;
2358 my $item_ref = shift;
2359 my $error_ref = shift;
2361 my @repacked_errors = ();
2363 foreach my $error_code (sort keys %{ $error_ref }) {
2364 my $repacked_error = {};
2365 $repacked_error->{'item_sequence'} = $item_sequence_num;
2366 $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
2367 $repacked_error->{'error_code'} = $error_code;
2368 $repacked_error->{'error_information'} = $error_ref->{$error_code};
2369 push @repacked_errors, $repacked_error;
2372 return @repacked_errors;
2375 =head2 _get_unlinked_item_subfields
2377 my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
2381 sub _get_unlinked_item_subfields {
2382 my $original_item_marc = shift;
2383 my $frameworkcode = shift;
2385 my $marcstructure = GetMarcStructure(1, $frameworkcode);
2387 # assume that this record has only one field, and that that
2388 # field contains only the item information
2390 my @fields = $original_item_marc->fields();
2391 if ($#fields > -1) {
2392 my $field = $fields[0];
2393 my $tag = $field->tag();
2394 foreach my $subfield ($field->subfields()) {
2395 if (defined $subfield->[1] and
2396 $subfield->[1] ne '' and
2397 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
2398 push @$subfields, $subfield->[0] => $subfield->[1];
2405 =head2 _get_unlinked_subfields_xml
2407 my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
2411 sub _get_unlinked_subfields_xml {
2412 my $unlinked_item_subfields = shift;
2415 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2416 my $marc = MARC::Record->new();
2417 # use of tag 999 is arbitrary, and doesn't need to match the item tag
2418 # used in the framework
2419 $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
2420 $marc->encoding("UTF-8");
2421 $xml = $marc->as_xml("USMARC");
2427 =head2 _parse_unlinked_item_subfields_from_xml
2429 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2433 sub _parse_unlinked_item_subfields_from_xml {
2436 return unless defined $xml and $xml ne "";
2437 my $marc = MARC::Record->new_from_xml(StripNonXmlChars($xml),'UTF-8');
2438 my $unlinked_subfields = [];
2439 my @fields = $marc->fields();
2440 if ($#fields > -1) {
2441 foreach my $subfield ($fields[0]->subfields()) {
2442 push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2445 return $unlinked_subfields;
2448 =head2 GetAnalyticsCount
2450 $count= &GetAnalyticsCount($itemnumber)
2452 counts Usage of itemnumber in Analytical bibliorecords.
2456 sub GetAnalyticsCount {
2457 my ($itemnumber) = @_;
2458 if (C4::Context->preference('NoZebra')) {
2459 # Read the index Koha-Auth-Number for this authid and count the lines
2460 my $result = C4::Search::NZanalyse("hi=$itemnumber");
2461 my @tab = split /;/,$result;
2464 ### ZOOM search here
2466 $query= "hi=".$itemnumber;
2467 my ($err,$res,$result) = C4::Search::SimpleSearch($query,0,10);
2475 $holds = &GetItemHolds($biblionumber, $itemnumber);
2479 This function return the count of holds with $biblionumber and $itemnumber
2484 my ($biblionumber, $itemnumber) = @_;
2486 my $dbh = C4::Context->dbh;
2487 my $query = "SELECT count(*)
2489 WHERE biblionumber=? AND itemnumber=?";
2490 my $sth = $dbh->prepare($query);
2491 $sth->execute($biblionumber, $itemnumber);
2492 $holds = $sth->fetchrow;