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
73 GetItemnumbersForBiblio
75 get_hostitemnumbers_of
76 GetItemnumberFromBarcode
77 GetBarcodeFromItemnumber
91 C4::Items - item management functions
95 This module contains an API for manipulating item
96 records in Koha, and is used by cataloguing, circulation,
97 acquisitions, and serials management.
99 A Koha item record is stored in two places: the
100 items table and embedded in a MARC tag in the XML
101 version of the associated bib record in C<biblioitems.marcxml>.
102 This is done to allow the item information to be readily
103 indexed (e.g., by Zebra), but means that each item
104 modification transaction must keep the items table
105 and the MARC XML in sync at all times.
107 Consequently, all code that creates, modifies, or deletes
108 item records B<must> use an appropriate function from
109 C<C4::Items>. If no existing function is suitable, it is
110 better to add one to C<C4::Items> than to use add
111 one-off SQL statements to add or modify items.
113 The items table will be considered authoritative. In other
114 words, if there is ever a discrepancy between the items
115 table and the MARC XML, the items table should be considered
118 =head1 HISTORICAL NOTE
120 Most of the functions in C<C4::Items> were originally in
121 the C<C4::Biblio> module.
123 =head1 CORE EXPORTED FUNCTIONS
125 The following functions are meant for use by users
132 $item = GetItem($itemnumber,$barcode,$serial);
134 Return item information, for a given itemnumber or barcode.
135 The return value is a hashref mapping item column
136 names to values. If C<$serial> is true, include serial publication data.
141 my ($itemnumber,$barcode, $serial) = @_;
142 my $dbh = C4::Context->dbh;
145 my $sth = $dbh->prepare("
147 WHERE itemnumber = ?");
148 $sth->execute($itemnumber);
149 $data = $sth->fetchrow_hashref;
151 my $sth = $dbh->prepare("
155 $sth->execute($barcode);
156 $data = $sth->fetchrow_hashref;
159 my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=?");
160 $ssth->execute($data->{'itemnumber'}) ;
161 ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
163 #if we don't have an items.itype, use biblioitems.itemtype.
164 if( ! $data->{'itype'} ) {
165 my $sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
166 $sth->execute($data->{'biblionumber'});
167 ($data->{'itype'}) = $sth->fetchrow_array;
174 CartToShelf($itemnumber);
176 Set the current shelving location of the item record
177 to its stored permanent shelving location. This is
178 primarily used to indicate when an item whose current
179 location is a special processing ('PROC') or shelving cart
180 ('CART') location is back in the stacks.
185 my ( $itemnumber ) = @_;
187 unless ( $itemnumber ) {
188 croak "FAILED CartToShelf() - no itemnumber supplied";
191 my $item = GetItem($itemnumber);
192 $item->{location} = $item->{permanent_location};
193 ModItem($item, undef, $itemnumber);
196 =head2 AddItemFromMarc
198 my ($biblionumber, $biblioitemnumber, $itemnumber)
199 = AddItemFromMarc($source_item_marc, $biblionumber);
201 Given a MARC::Record object containing an embedded item
202 record and a biblionumber, create a new item record.
206 sub AddItemFromMarc {
207 my ( $source_item_marc, $biblionumber ) = @_;
208 my $dbh = C4::Context->dbh;
210 # parse item hash from MARC
211 my $frameworkcode = GetFrameworkCode( $biblionumber );
212 my ($itemtag,$itemsubfield)=GetMarcFromKohaField("items.itemnumber",$frameworkcode);
214 my $localitemmarc=MARC::Record->new;
215 $localitemmarc->append_fields($source_item_marc->field($itemtag));
216 my $item = &TransformMarcToKoha( $dbh, $localitemmarc, $frameworkcode ,'items');
217 my $unlinked_item_subfields = _get_unlinked_item_subfields($localitemmarc, $frameworkcode);
218 return AddItem($item, $biblionumber, $dbh, $frameworkcode, $unlinked_item_subfields);
223 my ($biblionumber, $biblioitemnumber, $itemnumber)
224 = AddItem($item, $biblionumber[, $dbh, $frameworkcode, $unlinked_item_subfields]);
226 Given a hash containing item column names as keys,
227 create a new Koha item record.
229 The first two optional parameters (C<$dbh> and C<$frameworkcode>)
230 do not need to be supplied for general use; they exist
231 simply to allow them to be picked up from AddItemFromMarc.
233 The final optional parameter, C<$unlinked_item_subfields>, contains
234 an arrayref containing subfields present in the original MARC
235 representation of the item (e.g., from the item editor) that are
236 not mapped to C<items> columns directly but should instead
237 be stored in C<items.more_subfields_xml> and included in
238 the biblio items tag for display and indexing.
244 my $biblionumber = shift;
246 my $dbh = @_ ? shift : C4::Context->dbh;
247 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
248 my $unlinked_item_subfields;
250 $unlinked_item_subfields = shift
253 # needs old biblionumber and biblioitemnumber
254 $item->{'biblionumber'} = $biblionumber;
255 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
256 $sth->execute( $item->{'biblionumber'} );
257 ($item->{'biblioitemnumber'}) = $sth->fetchrow;
259 _set_defaults_for_add($item);
260 _set_derived_columns_for_add($item);
261 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
262 # FIXME - checks here
263 unless ( $item->{itype} ) { # default to biblioitem.itemtype if no itype
264 my $itype_sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
265 $itype_sth->execute( $item->{'biblionumber'} );
266 ( $item->{'itype'} ) = $itype_sth->fetchrow_array;
269 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
270 $item->{'itemnumber'} = $itemnumber;
272 ModZebra( $item->{biblionumber}, "specialUpdate", "biblioserver", undef, undef );
274 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
276 return ($item->{biblionumber}, $item->{biblioitemnumber}, $itemnumber);
279 =head2 AddItemBatchFromMarc
281 ($itemnumber_ref, $error_ref) = AddItemBatchFromMarc($record,
282 $biblionumber, $biblioitemnumber, $frameworkcode);
284 Efficiently create item records from a MARC biblio record with
285 embedded item fields. This routine is suitable for batch jobs.
287 This API assumes that the bib record has already been
288 saved to the C<biblio> and C<biblioitems> tables. It does
289 not expect that C<biblioitems.marc> and C<biblioitems.marcxml>
290 are populated, but it will do so via a call to ModBibiloMarc.
292 The goal of this API is to have a similar effect to using AddBiblio
293 and AddItems in succession, but without inefficient repeated
294 parsing of the MARC XML bib record.
296 This function returns an arrayref of new itemsnumbers and an arrayref of item
297 errors encountered during the processing. Each entry in the errors
298 list is a hashref containing the following keys:
304 Sequence number of original item tag in the MARC record.
308 Item barcode, provide to assist in the construction of
309 useful error messages.
311 =item error_condition
313 Code representing the error condition. Can be 'duplicate_barcode',
314 'invalid_homebranch', or 'invalid_holdingbranch'.
316 =item error_information
318 Additional information appropriate to the error condition.
324 sub AddItemBatchFromMarc {
325 my ($record, $biblionumber, $biblioitemnumber, $frameworkcode) = @_;
327 my @itemnumbers = ();
329 my $dbh = C4::Context->dbh;
331 # loop through the item tags and start creating items
332 my @bad_item_fields = ();
333 my ($itemtag, $itemsubfield) = &GetMarcFromKohaField("items.itemnumber",'');
334 my $item_sequence_num = 0;
335 ITEMFIELD: foreach my $item_field ($record->field($itemtag)) {
336 $item_sequence_num++;
337 # we take the item field and stick it into a new
338 # MARC record -- this is required so far because (FIXME)
339 # TransformMarcToKoha requires a MARC::Record, not a MARC::Field
340 # and there is no TransformMarcFieldToKoha
341 my $temp_item_marc = MARC::Record->new();
342 $temp_item_marc->append_fields($item_field);
344 # add biblionumber and biblioitemnumber
345 my $item = TransformMarcToKoha( $dbh, $temp_item_marc, $frameworkcode, 'items' );
346 my $unlinked_item_subfields = _get_unlinked_item_subfields($temp_item_marc, $frameworkcode);
347 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
348 $item->{'biblionumber'} = $biblionumber;
349 $item->{'biblioitemnumber'} = $biblioitemnumber;
351 # check for duplicate barcode
352 my %item_errors = CheckItemPreSave($item);
354 push @errors, _repack_item_errors($item_sequence_num, $item, \%item_errors);
355 push @bad_item_fields, $item_field;
359 _set_defaults_for_add($item);
360 _set_derived_columns_for_add($item);
361 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
362 warn $error if $error;
363 push @itemnumbers, $itemnumber; # FIXME not checking error
364 $item->{'itemnumber'} = $itemnumber;
366 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
368 my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
369 $item_field->replace_with($new_item_marc->field($itemtag));
372 # remove any MARC item fields for rejected items
373 foreach my $item_field (@bad_item_fields) {
374 $record->delete_field($item_field);
377 # update the MARC biblio
378 # $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode );
380 return (\@itemnumbers, \@errors);
383 =head2 ModItemFromMarc
385 ModItemFromMarc($item_marc, $biblionumber, $itemnumber);
387 This function updates an item record based on a supplied
388 C<MARC::Record> object containing an embedded item field.
389 This API is meant for the use of C<additem.pl>; for
390 other purposes, C<ModItem> should be used.
392 This function uses the hash %default_values_for_mod_from_marc,
393 which contains default values for item fields to
394 apply when modifying an item. This is needed beccause
395 if an item field's value is cleared, TransformMarcToKoha
396 does not include the column in the
397 hash that's passed to ModItem, which without
398 use of this hash makes it impossible to clear
399 an item field's value. See bug 2466.
401 Note that only columns that can be directly
402 changed from the cataloging and serials
403 item editors are included in this hash.
409 my %default_values_for_mod_from_marc = (
411 booksellerid => undef,
413 'items.cn_source' => undef,
416 # dateaccessioned => undef,
418 holdingbranch => undef,
420 itemcallnumber => undef,
425 permanent_location => undef,
430 replacementprice => undef,
431 replacementpricedate => undef,
434 stocknumber => undef,
439 sub ModItemFromMarc {
440 my $item_marc = shift;
441 my $biblionumber = shift;
442 my $itemnumber = shift;
444 my $dbh = C4::Context->dbh;
445 my $frameworkcode = GetFrameworkCode($biblionumber);
446 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
448 my $localitemmarc = MARC::Record->new;
449 $localitemmarc->append_fields( $item_marc->field($itemtag) );
450 my $item = &TransformMarcToKoha( $dbh, $localitemmarc, $frameworkcode, 'items' );
451 foreach my $item_field ( keys %default_values_for_mod_from_marc ) {
452 $item->{$item_field} = $default_values_for_mod_from_marc{$item_field} unless (exists $item->{$item_field});
454 my $unlinked_item_subfields = _get_unlinked_item_subfields( $localitemmarc, $frameworkcode );
456 ModItem($item, $biblionumber, $itemnumber, $dbh, $frameworkcode, $unlinked_item_subfields);
462 ModItem({ column => $newvalue }, $biblionumber,
463 $itemnumber[, $original_item_marc]);
465 Change one or more columns in an item record and update
466 the MARC representation of the item.
468 The first argument is a hashref mapping from item column
469 names to the new values. The second and third arguments
470 are the biblionumber and itemnumber, respectively.
472 The fourth, optional parameter, C<$unlinked_item_subfields>, contains
473 an arrayref containing subfields present in the original MARC
474 representation of the item (e.g., from the item editor) that are
475 not mapped to C<items> columns directly but should instead
476 be stored in C<items.more_subfields_xml> and included in
477 the biblio items tag for display and indexing.
479 If one of the changed columns is used to calculate
480 the derived value of a column such as C<items.cn_sort>,
481 this routine will perform the necessary calculation
488 my $biblionumber = shift;
489 my $itemnumber = shift;
491 # if $biblionumber is undefined, get it from the current item
492 unless (defined $biblionumber) {
493 $biblionumber = _get_single_item_column('biblionumber', $itemnumber);
496 my $dbh = @_ ? shift : C4::Context->dbh;
497 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
499 my $unlinked_item_subfields;
501 $unlinked_item_subfields = shift;
502 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
505 $item->{'itemnumber'} = $itemnumber or return undef;
507 $item->{onloan} = undef if $item->{itemlost};
509 _set_derived_columns_for_mod($item);
510 _do_column_fixes_for_mod($item);
513 # attempt to change itemnumber
514 # attempt to change biblionumber (if we want
515 # an API to relink an item to a different bib,
516 # it should be a separate function)
519 _koha_modify_item($item);
521 # request that bib be reindexed so that searching on current
522 # item status is possible
523 ModZebra( $biblionumber, "specialUpdate", "biblioserver", undef, undef );
525 logaction("CATALOGUING", "MODIFY", $itemnumber, Dumper($item)) if C4::Context->preference("CataloguingLog");
528 =head2 ModItemTransfer
530 ModItemTransfer($itenumber, $frombranch, $tobranch);
532 Marks an item as being transferred from one branch
537 sub ModItemTransfer {
538 my ( $itemnumber, $frombranch, $tobranch ) = @_;
540 my $dbh = C4::Context->dbh;
542 #new entry in branchtransfers....
543 my $sth = $dbh->prepare(
544 "INSERT INTO branchtransfers (itemnumber, frombranch, datesent, tobranch)
545 VALUES (?, ?, NOW(), ?)");
546 $sth->execute($itemnumber, $frombranch, $tobranch);
548 ModItem({ holdingbranch => $tobranch }, undef, $itemnumber);
549 ModDateLastSeen($itemnumber);
553 =head2 ModDateLastSeen
555 ModDateLastSeen($itemnum);
557 Mark item as seen. Is called when an item is issued, returned or manually marked during inventory/stocktaking.
558 C<$itemnum> is the item number
562 sub ModDateLastSeen {
563 my ($itemnumber) = @_;
565 my $today = C4::Dates->new();
566 ModItem({ itemlost => 0, datelastseen => $today->output("iso") }, undef, $itemnumber);
571 DelItem($dbh, $biblionumber, $itemnumber);
573 Exported function (core API) for deleting an item record in Koha.
578 my ( $dbh, $biblionumber, $itemnumber ) = @_;
580 # FIXME check the item has no current issues
582 _koha_delete_item( $dbh, $itemnumber );
584 # get the MARC record
585 my $record = GetMarcBiblio($biblionumber);
586 ModZebra( $biblionumber, "specialUpdate", "biblioserver", undef, undef );
589 my $copy2deleted = $dbh->prepare("UPDATE deleteditems SET marc=? WHERE itemnumber=?");
590 $copy2deleted->execute( $record->as_usmarc(), $itemnumber );
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 GetItemnumberForBiblio
1503 my @itemnumbers = GetItemnumbersForBiblio($biblionumber);
1505 Given a single biblionumber, return an array of all the corresponding itemnumbers
1509 sub GetItemnumbersForBiblio {
1510 my $biblionumber = shift;
1512 my $dbh = C4::Context->dbh;
1513 my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber = ?");
1514 $sth->execute($biblionumber);
1515 while (my $result = $sth->fetchrow_hashref) {
1516 push @items, $result->{'itemnumber'};
1521 =head2 get_itemnumbers_of
1523 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1525 Given a list of biblionumbers, return the list of corresponding itemnumbers
1526 for each biblionumber.
1528 Return a reference on a hash where keys are biblionumbers and values are
1529 references on array of itemnumbers.
1533 sub get_itemnumbers_of {
1534 my @biblionumbers = @_;
1536 my $dbh = C4::Context->dbh;
1542 WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1544 my $sth = $dbh->prepare($query);
1545 $sth->execute(@biblionumbers);
1549 while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1550 push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1553 return \%itemnumbers_of;
1556 =head2 get_hostitemnumbers_of
1558 my @itemnumbers_of = get_hostitemnumbers_of($biblionumber);
1560 Given a biblionumber, return the list of corresponding itemnumbers that are linked to it via host fields
1562 Return a reference on a hash where key is a biblionumber and values are
1563 references on array of itemnumbers.
1568 sub get_hostitemnumbers_of {
1569 my ($biblionumber) = @_;
1570 my $marcrecord = GetMarcBiblio($biblionumber);
1571 my (@returnhostitemnumbers,$tag, $biblio_s, $item_s);
1573 my $marcflavor = C4::Context->preference('marcflavour');
1574 if ($marcflavor eq 'MARC21' || $marcflavor eq 'NORMARC') {
1578 } elsif ($marcflavor eq 'UNIMARC') {
1584 foreach my $hostfield ( $marcrecord->field($tag) ) {
1585 my $hostbiblionumber = $hostfield->subfield($biblio_s);
1586 my $linkeditemnumber = $hostfield->subfield($item_s);
1588 if (my $itemnumbers = get_itemnumbers_of($hostbiblionumber)->{$hostbiblionumber})
1590 @itemnumbers = @$itemnumbers;
1592 foreach my $itemnumber (@itemnumbers){
1593 if ($itemnumber eq $linkeditemnumber){
1594 push (@returnhostitemnumbers,$itemnumber);
1599 return @returnhostitemnumbers;
1603 =head2 GetItemnumberFromBarcode
1605 $result = GetItemnumberFromBarcode($barcode);
1609 sub GetItemnumberFromBarcode {
1611 my $dbh = C4::Context->dbh;
1614 $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1615 $rq->execute($barcode);
1616 my ($result) = $rq->fetchrow;
1620 =head2 GetBarcodeFromItemnumber
1622 $result = GetBarcodeFromItemnumber($itemnumber);
1626 sub GetBarcodeFromItemnumber {
1627 my ($itemnumber) = @_;
1628 my $dbh = C4::Context->dbh;
1631 $dbh->prepare("SELECT barcode FROM items WHERE items.itemnumber=?");
1632 $rq->execute($itemnumber);
1633 my ($result) = $rq->fetchrow;
1637 =head2 GetHiddenItemnumbers
1641 $result = GetHiddenItemnumbers(@items);
1647 sub GetHiddenItemnumbers {
1651 my $yaml = C4::Context->preference('OpacHiddenItems');
1654 $hidingrules = YAML::Load($yaml);
1657 warn "Unable to parse OpacHiddenItems syspref : $@";
1660 my $dbh = C4::Context->dbh;
1663 foreach my $item (@items) {
1665 # We check each rule
1666 foreach my $field (keys %$hidingrules) {
1667 my $query = "SELECT $field from items where itemnumber = ?";
1668 my $sth = $dbh->prepare($query);
1669 $sth->execute($item->{'itemnumber'});
1670 my ($result) = $sth->fetchrow;
1672 # If the results matches the values in the yaml file
1673 if (any { $result eq $_ } @{$hidingrules->{$field}}) {
1675 # We add the itemnumber to the list
1676 push @resultitems, $item->{'itemnumber'};
1678 # If at least one rule matched for an item, no need to test the others
1683 return @resultitems;
1688 =head3 get_item_authorised_values
1690 find the types and values for all authorised values assigned to this item.
1692 parameters: itemnumber
1694 returns: a hashref malling the authorised value to the value set for this itemnumber
1696 $authorised_values = {
1702 'RESTRICTED' => undef,
1705 'branches' => 'CPL',
1706 'cn_source' => undef,
1707 'itemtypes' => 'SER',
1710 Notes: see C4::Biblio::get_biblio_authorised_values for a similar method at the biblio level.
1714 sub get_item_authorised_values {
1715 my $itemnumber = shift;
1717 # assume that these entries in the authorised_value table are item level.
1718 my $query = q(SELECT distinct authorised_value, kohafield
1719 FROM marc_subfield_structure
1720 WHERE kohafield like 'item%'
1721 AND authorised_value != '' );
1723 my $itemlevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
1724 my $iteminfo = GetItem( $itemnumber );
1725 # warn( Data::Dumper->Dump( [ $itemlevel_authorised_values ], [ 'itemlevel_authorised_values' ] ) );
1727 foreach my $this_authorised_value ( keys %$itemlevel_authorised_values ) {
1728 my $field = $itemlevel_authorised_values->{ $this_authorised_value }->{'kohafield'};
1729 $field =~ s/^items\.//;
1730 if ( exists $iteminfo->{ $field } ) {
1731 $return->{ $this_authorised_value } = $iteminfo->{ $field };
1734 # warn( Data::Dumper->Dump( [ $return ], [ 'return' ] ) );
1738 =head3 get_authorised_value_images
1740 find a list of icons that are appropriate for display based on the
1741 authorised values for a biblio.
1743 parameters: listref of authorised values, such as comes from
1744 get_item_authorised_values or
1745 from C4::Biblio::get_biblio_authorised_values
1747 returns: listref of hashrefs for each image. Each hashref looks like this:
1749 { imageurl => '/intranet-tmpl/prog/img/itemtypeimg/npl/WEB.gif',
1754 Notes: Currently, I put on the full path to the images on the staff
1755 side. This should either be configurable or not done at all. Since I
1756 have to deal with 'intranet' or 'opac' in
1757 get_biblio_authorised_values, perhaps I should be passing it in.
1761 sub get_authorised_value_images {
1762 my $authorised_values = shift;
1766 my $authorised_value_list = GetAuthorisedValues();
1767 # warn ( Data::Dumper->Dump( [ $authorised_value_list ], [ 'authorised_value_list' ] ) );
1768 foreach my $this_authorised_value ( @$authorised_value_list ) {
1769 if ( exists $authorised_values->{ $this_authorised_value->{'category'} }
1770 && $authorised_values->{ $this_authorised_value->{'category'} } eq $this_authorised_value->{'authorised_value'} ) {
1771 # warn ( Data::Dumper->Dump( [ $this_authorised_value ], [ 'this_authorised_value' ] ) );
1772 if ( defined $this_authorised_value->{'imageurl'} ) {
1773 push @imagelist, { imageurl => C4::Koha::getitemtypeimagelocation( 'intranet', $this_authorised_value->{'imageurl'} ),
1774 label => $this_authorised_value->{'lib'},
1775 category => $this_authorised_value->{'category'},
1776 value => $this_authorised_value->{'authorised_value'}, };
1781 # warn ( Data::Dumper->Dump( [ \@imagelist ], [ 'imagelist' ] ) );
1786 =head1 LIMITED USE FUNCTIONS
1788 The following functions, while part of the public API,
1789 are not exported. This is generally because they are
1790 meant to be used by only one script for a specific
1791 purpose, and should not be used in any other context
1792 without careful thought.
1798 my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1800 Returns MARC::Record of the item passed in parameter.
1801 This function is meant for use only in C<cataloguing/additem.pl>,
1802 where it is needed to support that script's MARC-like
1808 my ( $biblionumber, $itemnumber ) = @_;
1810 # GetMarcItem has been revised so that it does the following:
1811 # 1. Gets the item information from the items table.
1812 # 2. Converts it to a MARC field for storage in the bib record.
1814 # The previous behavior was:
1815 # 1. Get the bib record.
1816 # 2. Return the MARC tag corresponding to the item record.
1818 # The difference is that one treats the items row as authoritative,
1819 # while the other treats the MARC representation as authoritative
1820 # under certain circumstances.
1822 my $itemrecord = GetItem($itemnumber);
1824 # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1825 # Also, don't emit a subfield if the underlying field is blank.
1828 return Item2Marc($itemrecord,$biblionumber);
1832 my ($itemrecord,$biblionumber)=@_;
1835 defined($itemrecord->{$_}) && $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : ()
1836 } keys %{ $itemrecord }
1838 my $itemmarc = TransformKohaToMarc($mungeditem);
1839 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",GetFrameworkCode($biblionumber)||'');
1841 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1842 if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1843 foreach my $field ($itemmarc->field($itemtag)){
1844 $field->add_subfields(@$unlinked_item_subfields);
1850 =head1 PRIVATE FUNCTIONS AND VARIABLES
1852 The following functions are not meant to be called
1853 directly, but are documented in order to explain
1854 the inner workings of C<C4::Items>.
1858 =head2 %derived_columns
1860 This hash keeps track of item columns that
1861 are strictly derived from other columns in
1862 the item record and are not meant to be set
1865 Each key in the hash should be the name of a
1866 column (as named by TransformMarcToKoha). Each
1867 value should be hashref whose keys are the
1868 columns on which the derived column depends. The
1869 hashref should also contain a 'BUILDER' key
1870 that is a reference to a sub that calculates
1875 my %derived_columns = (
1876 'items.cn_sort' => {
1877 'itemcallnumber' => 1,
1878 'items.cn_source' => 1,
1879 'BUILDER' => \&_calc_items_cn_sort,
1883 =head2 _set_derived_columns_for_add
1885 _set_derived_column_for_add($item);
1887 Given an item hash representing a new item to be added,
1888 calculate any derived columns. Currently the only
1889 such column is C<items.cn_sort>.
1893 sub _set_derived_columns_for_add {
1896 foreach my $column (keys %derived_columns) {
1897 my $builder = $derived_columns{$column}->{'BUILDER'};
1898 my $source_values = {};
1899 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1900 next if $source_column eq 'BUILDER';
1901 $source_values->{$source_column} = $item->{$source_column};
1903 $builder->($item, $source_values);
1907 =head2 _set_derived_columns_for_mod
1909 _set_derived_column_for_mod($item);
1911 Given an item hash representing a new item to be modified.
1912 calculate any derived columns. Currently the only
1913 such column is C<items.cn_sort>.
1915 This routine differs from C<_set_derived_columns_for_add>
1916 in that it needs to handle partial item records. In other
1917 words, the caller of C<ModItem> may have supplied only one
1918 or two columns to be changed, so this function needs to
1919 determine whether any of the columns to be changed affect
1920 any of the derived columns. Also, if a derived column
1921 depends on more than one column, but the caller is not
1922 changing all of then, this routine retrieves the unchanged
1923 values from the database in order to ensure a correct
1928 sub _set_derived_columns_for_mod {
1931 foreach my $column (keys %derived_columns) {
1932 my $builder = $derived_columns{$column}->{'BUILDER'};
1933 my $source_values = {};
1934 my %missing_sources = ();
1935 my $must_recalc = 0;
1936 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1937 next if $source_column eq 'BUILDER';
1938 if (exists $item->{$source_column}) {
1940 $source_values->{$source_column} = $item->{$source_column};
1942 $missing_sources{$source_column} = 1;
1946 foreach my $source_column (keys %missing_sources) {
1947 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
1949 $builder->($item, $source_values);
1954 =head2 _do_column_fixes_for_mod
1956 _do_column_fixes_for_mod($item);
1958 Given an item hashref containing one or more
1959 columns to modify, fix up certain values.
1960 Specifically, set to 0 any passed value
1961 of C<notforloan>, C<damaged>, C<itemlost>, or
1962 C<wthdrawn> that is either undefined or
1963 contains the empty string.
1967 sub _do_column_fixes_for_mod {
1970 if (exists $item->{'notforloan'} and
1971 (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
1972 $item->{'notforloan'} = 0;
1974 if (exists $item->{'damaged'} and
1975 (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
1976 $item->{'damaged'} = 0;
1978 if (exists $item->{'itemlost'} and
1979 (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
1980 $item->{'itemlost'} = 0;
1982 if (exists $item->{'wthdrawn'} and
1983 (not defined $item->{'wthdrawn'} or $item->{'wthdrawn'} eq '')) {
1984 $item->{'wthdrawn'} = 0;
1986 if (exists $item->{'location'} && !exists $item->{'permanent_location'}) {
1987 $item->{'permanent_location'} = $item->{'location'};
1989 if (exists $item->{'timestamp'}) {
1990 delete $item->{'timestamp'};
1994 =head2 _get_single_item_column
1996 _get_single_item_column($column, $itemnumber);
1998 Retrieves the value of a single column from an C<items>
1999 row specified by C<$itemnumber>.
2003 sub _get_single_item_column {
2005 my $itemnumber = shift;
2007 my $dbh = C4::Context->dbh;
2008 my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
2009 $sth->execute($itemnumber);
2010 my ($value) = $sth->fetchrow();
2014 =head2 _calc_items_cn_sort
2016 _calc_items_cn_sort($item, $source_values);
2018 Helper routine to calculate C<items.cn_sort>.
2022 sub _calc_items_cn_sort {
2024 my $source_values = shift;
2026 $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
2029 =head2 _set_defaults_for_add
2031 _set_defaults_for_add($item_hash);
2033 Given an item hash representing an item to be added, set
2034 correct default values for columns whose default value
2035 is not handled by the DBMS. This includes the following
2042 C<items.dateaccessioned>
2064 sub _set_defaults_for_add {
2066 $item->{dateaccessioned} ||= C4::Dates->new->output('iso');
2067 $item->{$_} ||= 0 for (qw( notforloan damaged itemlost wthdrawn));
2070 =head2 _koha_new_item
2072 my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
2074 Perform the actual insert into the C<items> table.
2078 sub _koha_new_item {
2079 my ( $item, $barcode ) = @_;
2080 my $dbh=C4::Context->dbh;
2083 "INSERT INTO items SET
2085 biblioitemnumber = ?,
2087 dateaccessioned = ?,
2091 replacementprice = ?,
2092 replacementpricedate = ?,
2093 datelastborrowed = ?,
2106 permanent_location = ?,
2118 more_subfields_xml = ?,
2122 my $sth = $dbh->prepare($query);
2123 my $today = C4::Dates->today('iso');
2125 $item->{'biblionumber'},
2126 $item->{'biblioitemnumber'},
2128 $item->{'dateaccessioned'},
2129 $item->{'booksellerid'},
2130 $item->{'homebranch'},
2132 $item->{'replacementprice'},
2133 $item->{'replacementpricedate'} || $today,
2134 $item->{datelastborrowed},
2135 $item->{datelastseen} || $today,
2137 $item->{'notforloan'},
2139 $item->{'itemlost'},
2140 $item->{'wthdrawn'},
2141 $item->{'itemcallnumber'},
2142 $item->{'restricted'},
2143 $item->{'itemnotes'},
2144 $item->{'holdingbranch'},
2146 $item->{'location'},
2147 $item->{'permanent_location'},
2150 $item->{'renewals'},
2151 $item->{'reserves'},
2152 $item->{'items.cn_source'},
2153 $item->{'items.cn_sort'},
2156 $item->{'materials'},
2158 $item->{'enumchron'},
2159 $item->{'more_subfields_xml'},
2160 $item->{'copynumber'},
2161 $item->{'stocknumber'},
2163 my $itemnumber = $dbh->{'mysql_insertid'};
2164 if ( defined $sth->errstr ) {
2165 $error.="ERROR in _koha_new_item $query".$sth->errstr;
2167 return ( $itemnumber, $error );
2170 =head2 MoveItemFromBiblio
2172 MoveItemFromBiblio($itenumber, $frombiblio, $tobiblio);
2174 Moves an item from a biblio to another
2176 Returns undef if the move failed or the biblionumber of the destination record otherwise
2180 sub MoveItemFromBiblio {
2181 my ($itemnumber, $frombiblio, $tobiblio) = @_;
2182 my $dbh = C4::Context->dbh;
2183 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber = ?");
2184 $sth->execute( $tobiblio );
2185 my ( $tobiblioitem ) = $sth->fetchrow();
2186 $sth = $dbh->prepare("UPDATE items SET biblioitemnumber = ?, biblionumber = ? WHERE itemnumber = ? AND biblionumber = ?");
2187 my $return = $sth->execute($tobiblioitem, $tobiblio, $itemnumber, $frombiblio);
2189 ModZebra( $tobiblio, "specialUpdate", "biblioserver", undef, undef );
2190 ModZebra( $frombiblio, "specialUpdate", "biblioserver", undef, undef );
2191 # Checking if the item we want to move is in an order
2192 my $order = GetOrderFromItemnumber($itemnumber);
2194 # Replacing the biblionumber within the order if necessary
2195 $order->{'biblionumber'} = $tobiblio;
2205 DelItemCheck($dbh, $biblionumber, $itemnumber);
2207 Exported function (core API) for deleting an item record in Koha if there no current issue.
2212 my ( $dbh, $biblionumber, $itemnumber ) = @_;
2215 my $countanalytics=GetAnalyticsCount($itemnumber);
2218 # check that there is no issue on this item before deletion.
2219 my $sth=$dbh->prepare("select * from issues i where i.itemnumber=?");
2220 $sth->execute($itemnumber);
2222 my $item = GetItem($itemnumber);
2223 my $onloan=$sth->fetchrow;
2226 $error = "book_on_loan"
2228 elsif ( C4::Context->userenv->{flags} & 1 and
2229 C4::Context->preference("IndependantBranches") and
2230 (C4::Context->userenv->{branch} ne
2231 $item->{C4::Context->preference("HomeOrHoldingBranch")||'homebranch'}) )
2233 $error = "not_same_branch";
2236 # check it doesnt have a waiting reserve
2237 $sth=$dbh->prepare("SELECT * FROM reserves WHERE (found = 'W' or found = 'T') AND itemnumber = ?");
2238 $sth->execute($itemnumber);
2239 my $reserve=$sth->fetchrow;
2241 $error = "book_reserved";
2242 } elsif ($countanalytics > 0){
2243 $error = "linked_analytics";
2245 DelItem($dbh, $biblionumber, $itemnumber);
2252 =head2 _koha_modify_item
2254 my ($itemnumber,$error) =_koha_modify_item( $item );
2256 Perform the actual update of the C<items> row. Note that this
2257 routine accepts a hashref specifying the columns to update.
2261 sub _koha_modify_item {
2263 my $dbh=C4::Context->dbh;
2266 my $query = "UPDATE items SET ";
2268 for my $key ( keys %$item ) {
2270 push @bind, $item->{$key};
2273 $query .= " WHERE itemnumber=?";
2274 push @bind, $item->{'itemnumber'};
2275 my $sth = C4::Context->dbh->prepare($query);
2276 $sth->execute(@bind);
2277 if ( C4::Context->dbh->errstr ) {
2278 $error.="ERROR in _koha_modify_item $query".$dbh->errstr;
2281 return ($item->{'itemnumber'},$error);
2284 =head2 _koha_delete_item
2286 _koha_delete_item( $dbh, $itemnum );
2288 Internal function to delete an item record from the koha tables
2292 sub _koha_delete_item {
2293 my ( $dbh, $itemnum ) = @_;
2295 # save the deleted item to deleteditems table
2296 my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
2297 $sth->execute($itemnum);
2298 my $data = $sth->fetchrow_hashref();
2299 my $query = "INSERT INTO deleteditems SET ";
2301 foreach my $key ( keys %$data ) {
2302 $query .= "$key = ?,";
2303 push( @bind, $data->{$key} );
2306 $sth = $dbh->prepare($query);
2307 $sth->execute(@bind);
2309 # delete from items table
2310 $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
2311 $sth->execute($itemnum);
2315 =head2 _marc_from_item_hash
2317 my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
2319 Given an item hash representing a complete item record,
2320 create a C<MARC::Record> object containing an embedded
2321 tag representing that item.
2323 The third, optional parameter C<$unlinked_item_subfields> is
2324 an arrayref of subfields (not mapped to C<items> fields per the
2325 framework) to be added to the MARC representation
2330 sub _marc_from_item_hash {
2332 my $frameworkcode = shift;
2333 my $unlinked_item_subfields;
2335 $unlinked_item_subfields = shift;
2338 # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
2339 # Also, don't emit a subfield if the underlying field is blank.
2340 my $mungeditem = { map { (defined($item->{$_}) and $item->{$_} ne '') ?
2341 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
2342 : () } keys %{ $item } };
2344 my $item_marc = MARC::Record->new();
2345 foreach my $item_field ( keys %{$mungeditem} ) {
2346 my ( $tag, $subfield ) = GetMarcFromKohaField( $item_field, $frameworkcode );
2347 next unless defined $tag and defined $subfield; # skip if not mapped to MARC field
2348 my @values = split(/\s?\|\s?/, $mungeditem->{$item_field}, -1);
2349 foreach my $value (@values){
2350 if ( my $field = $item_marc->field($tag) ) {
2351 $field->add_subfields( $subfield => $value );
2353 my $add_subfields = [];
2354 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2355 $add_subfields = $unlinked_item_subfields;
2357 $item_marc->add_fields( $tag, " ", " ", $subfield => $value, @$add_subfields );
2365 =head2 _repack_item_errors
2367 Add an error message hash generated by C<CheckItemPreSave>
2368 to a list of errors.
2372 sub _repack_item_errors {
2373 my $item_sequence_num = shift;
2374 my $item_ref = shift;
2375 my $error_ref = shift;
2377 my @repacked_errors = ();
2379 foreach my $error_code (sort keys %{ $error_ref }) {
2380 my $repacked_error = {};
2381 $repacked_error->{'item_sequence'} = $item_sequence_num;
2382 $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
2383 $repacked_error->{'error_code'} = $error_code;
2384 $repacked_error->{'error_information'} = $error_ref->{$error_code};
2385 push @repacked_errors, $repacked_error;
2388 return @repacked_errors;
2391 =head2 _get_unlinked_item_subfields
2393 my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
2397 sub _get_unlinked_item_subfields {
2398 my $original_item_marc = shift;
2399 my $frameworkcode = shift;
2401 my $marcstructure = GetMarcStructure(1, $frameworkcode);
2403 # assume that this record has only one field, and that that
2404 # field contains only the item information
2406 my @fields = $original_item_marc->fields();
2407 if ($#fields > -1) {
2408 my $field = $fields[0];
2409 my $tag = $field->tag();
2410 foreach my $subfield ($field->subfields()) {
2411 if (defined $subfield->[1] and
2412 $subfield->[1] ne '' and
2413 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
2414 push @$subfields, $subfield->[0] => $subfield->[1];
2421 =head2 _get_unlinked_subfields_xml
2423 my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
2427 sub _get_unlinked_subfields_xml {
2428 my $unlinked_item_subfields = shift;
2431 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2432 my $marc = MARC::Record->new();
2433 # use of tag 999 is arbitrary, and doesn't need to match the item tag
2434 # used in the framework
2435 $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
2436 $marc->encoding("UTF-8");
2437 $xml = $marc->as_xml("USMARC");
2443 =head2 _parse_unlinked_item_subfields_from_xml
2445 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2449 sub _parse_unlinked_item_subfields_from_xml {
2452 return unless defined $xml and $xml ne "";
2453 my $marc = MARC::Record->new_from_xml(StripNonXmlChars($xml),'UTF-8');
2454 my $unlinked_subfields = [];
2455 my @fields = $marc->fields();
2456 if ($#fields > -1) {
2457 foreach my $subfield ($fields[0]->subfields()) {
2458 push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2461 return $unlinked_subfields;
2464 =head2 GetAnalyticsCount
2466 $count= &GetAnalyticsCount($itemnumber)
2468 counts Usage of itemnumber in Analytical bibliorecords.
2472 sub GetAnalyticsCount {
2473 my ($itemnumber) = @_;
2474 if (C4::Context->preference('NoZebra')) {
2475 # Read the index Koha-Auth-Number for this authid and count the lines
2476 my $result = C4::Search::NZanalyse("hi=$itemnumber");
2477 my @tab = split /;/,$result;
2480 ### ZOOM search here
2482 $query= "hi=".$itemnumber;
2483 my ($err,$res,$result) = C4::Search::SimpleSearch($query,0,10);
2491 $holds = &GetItemHolds($biblionumber, $itemnumber);
2495 This function return the count of holds with $biblionumber and $itemnumber
2500 my ($biblionumber, $itemnumber) = @_;
2502 my $dbh = C4::Context->dbh;
2503 my $query = "SELECT count(*)
2505 WHERE biblionumber=? AND itemnumber=?";
2506 my $sth = $dbh->prepare($query);
2507 $sth->execute($biblionumber, $itemnumber);
2508 $holds = $sth->fetchrow;