3 # Copyright 2007 LibLime, Inc.
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #use warnings; FIXME - Bug 2505
27 use C4::Dates qw/format_date format_date_in_iso/;
36 use vars qw($VERSION @ISA @EXPORT);
42 @ISA = qw( Exporter );
65 GetItemsByBiblioitemnumber
68 GetItemnumberFromBarcode
69 GetBarcodeFromItemnumber
80 C4::Items - item management functions
84 This module contains an API for manipulating item
85 records in Koha, and is used by cataloguing, circulation,
86 acquisitions, and serials management.
88 A Koha item record is stored in two places: the
89 items table and embedded in a MARC tag in the XML
90 version of the associated bib record in C<biblioitems.marcxml>.
91 This is done to allow the item information to be readily
92 indexed (e.g., by Zebra), but means that each item
93 modification transaction must keep the items table
94 and the MARC XML in sync at all times.
96 Consequently, all code that creates, modifies, or deletes
97 item records B<must> use an appropriate function from
98 C<C4::Items>. If no existing function is suitable, it is
99 better to add one to C<C4::Items> than to use add
100 one-off SQL statements to add or modify items.
102 The items table will be considered authoritative. In other
103 words, if there is ever a discrepancy between the items
104 table and the MARC XML, the items table should be considered
107 =head1 HISTORICAL NOTE
109 Most of the functions in C<C4::Items> were originally in
110 the C<C4::Biblio> module.
112 =head1 CORE EXPORTED FUNCTIONS
114 The following functions are meant for use by users
121 $item = GetItem($itemnumber,$barcode,$serial);
123 Return item information, for a given itemnumber or barcode.
124 The return value is a hashref mapping item column
125 names to values. If C<$serial> is true, include serial publication data.
130 my ($itemnumber,$barcode, $serial) = @_;
131 my $dbh = C4::Context->dbh;
134 my $sth = $dbh->prepare("
136 WHERE itemnumber = ?");
137 $sth->execute($itemnumber);
138 $data = $sth->fetchrow_hashref;
140 my $sth = $dbh->prepare("
144 $sth->execute($barcode);
145 $data = $sth->fetchrow_hashref;
148 my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=?");
149 $ssth->execute($data->{'itemnumber'}) ;
150 ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
152 #if we don't have an items.itype, use biblioitems.itemtype.
153 if( ! $data->{'itype'} ) {
154 my $sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
155 $sth->execute($data->{'biblionumber'});
156 ($data->{'itype'}) = $sth->fetchrow_array;
163 CartToShelf($itemnumber);
165 Set the current shelving location of the item record
166 to its stored permanent shelving location. This is
167 primarily used to indicate when an item whose current
168 location is a special processing ('PROC') or shelving cart
169 ('CART') location is back in the stacks.
174 my ( $itemnumber ) = @_;
176 unless ( $itemnumber ) {
177 croak "FAILED CartToShelf() - no itemnumber supplied";
180 my $item = GetItem($itemnumber);
181 $item->{location} = $item->{permanent_location};
182 ModItem($item, undef, $itemnumber);
185 =head2 AddItemFromMarc
187 my ($biblionumber, $biblioitemnumber, $itemnumber)
188 = AddItemFromMarc($source_item_marc, $biblionumber);
190 Given a MARC::Record object containing an embedded item
191 record and a biblionumber, create a new item record.
195 sub AddItemFromMarc {
196 my ( $source_item_marc, $biblionumber ) = @_;
197 my $dbh = C4::Context->dbh;
199 # parse item hash from MARC
200 my $frameworkcode = GetFrameworkCode( $biblionumber );
201 my ($itemtag,$itemsubfield)=GetMarcFromKohaField("items.itemnumber",$frameworkcode);
203 my $localitemmarc=MARC::Record->new;
204 $localitemmarc->append_fields($source_item_marc->field($itemtag));
205 my $item = &TransformMarcToKoha( $dbh, $localitemmarc, $frameworkcode ,'items');
206 my $unlinked_item_subfields = _get_unlinked_item_subfields($localitemmarc, $frameworkcode);
207 return AddItem($item, $biblionumber, $dbh, $frameworkcode, $unlinked_item_subfields);
212 my ($biblionumber, $biblioitemnumber, $itemnumber)
213 = AddItem($item, $biblionumber[, $dbh, $frameworkcode, $unlinked_item_subfields]);
215 Given a hash containing item column names as keys,
216 create a new Koha item record.
218 The first two optional parameters (C<$dbh> and C<$frameworkcode>)
219 do not need to be supplied for general use; they exist
220 simply to allow them to be picked up from AddItemFromMarc.
222 The final optional parameter, C<$unlinked_item_subfields>, contains
223 an arrayref containing subfields present in the original MARC
224 representation of the item (e.g., from the item editor) that are
225 not mapped to C<items> columns directly but should instead
226 be stored in C<items.more_subfields_xml> and included in
227 the biblio items tag for display and indexing.
233 my $biblionumber = shift;
235 my $dbh = @_ ? shift : C4::Context->dbh;
236 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
237 my $unlinked_item_subfields;
239 $unlinked_item_subfields = shift
242 # needs old biblionumber and biblioitemnumber
243 $item->{'biblionumber'} = $biblionumber;
244 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
245 $sth->execute( $item->{'biblionumber'} );
246 ($item->{'biblioitemnumber'}) = $sth->fetchrow;
248 _set_defaults_for_add($item);
249 _set_derived_columns_for_add($item);
250 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
251 # FIXME - checks here
252 unless ( $item->{itype} ) { # default to biblioitem.itemtype if no itype
253 my $itype_sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
254 $itype_sth->execute( $item->{'biblionumber'} );
255 ( $item->{'itype'} ) = $itype_sth->fetchrow_array;
258 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
259 $item->{'itemnumber'} = $itemnumber;
261 # create MARC tag representing item and add to bib
262 my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
263 _add_item_field_to_biblio($new_item_marc, $item->{'biblionumber'}, $frameworkcode );
265 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
267 return ($item->{biblionumber}, $item->{biblioitemnumber}, $itemnumber);
270 =head2 AddItemBatchFromMarc
272 ($itemnumber_ref, $error_ref) = AddItemBatchFromMarc($record,
273 $biblionumber, $biblioitemnumber, $frameworkcode);
275 Efficiently create item records from a MARC biblio record with
276 embedded item fields. This routine is suitable for batch jobs.
278 This API assumes that the bib record has already been
279 saved to the C<biblio> and C<biblioitems> tables. It does
280 not expect that C<biblioitems.marc> and C<biblioitems.marcxml>
281 are populated, but it will do so via a call to ModBibiloMarc.
283 The goal of this API is to have a similar effect to using AddBiblio
284 and AddItems in succession, but without inefficient repeated
285 parsing of the MARC XML bib record.
287 This function returns an arrayref of new itemsnumbers and an arrayref of item
288 errors encountered during the processing. Each entry in the errors
289 list is a hashref containing the following keys:
295 Sequence number of original item tag in the MARC record.
299 Item barcode, provide to assist in the construction of
300 useful error messages.
302 =item error_condition
304 Code representing the error condition. Can be 'duplicate_barcode',
305 'invalid_homebranch', or 'invalid_holdingbranch'.
307 =item error_information
309 Additional information appropriate to the error condition.
315 sub AddItemBatchFromMarc {
316 my ($record, $biblionumber, $biblioitemnumber, $frameworkcode) = @_;
318 my @itemnumbers = ();
320 my $dbh = C4::Context->dbh;
322 # loop through the item tags and start creating items
323 my @bad_item_fields = ();
324 my ($itemtag, $itemsubfield) = &GetMarcFromKohaField("items.itemnumber",'');
325 my $item_sequence_num = 0;
326 ITEMFIELD: foreach my $item_field ($record->field($itemtag)) {
327 $item_sequence_num++;
328 # we take the item field and stick it into a new
329 # MARC record -- this is required so far because (FIXME)
330 # TransformMarcToKoha requires a MARC::Record, not a MARC::Field
331 # and there is no TransformMarcFieldToKoha
332 my $temp_item_marc = MARC::Record->new();
333 $temp_item_marc->append_fields($item_field);
335 # add biblionumber and biblioitemnumber
336 my $item = TransformMarcToKoha( $dbh, $temp_item_marc, $frameworkcode, 'items' );
337 my $unlinked_item_subfields = _get_unlinked_item_subfields($temp_item_marc, $frameworkcode);
338 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
339 $item->{'biblionumber'} = $biblionumber;
340 $item->{'biblioitemnumber'} = $biblioitemnumber;
342 # check for duplicate barcode
343 my %item_errors = CheckItemPreSave($item);
345 push @errors, _repack_item_errors($item_sequence_num, $item, \%item_errors);
346 push @bad_item_fields, $item_field;
350 _set_defaults_for_add($item);
351 _set_derived_columns_for_add($item);
352 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
353 warn $error if $error;
354 push @itemnumbers, $itemnumber; # FIXME not checking error
355 $item->{'itemnumber'} = $itemnumber;
357 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
359 my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
360 $item_field->replace_with($new_item_marc->field($itemtag));
363 # remove any MARC item fields for rejected items
364 foreach my $item_field (@bad_item_fields) {
365 $record->delete_field($item_field);
368 # update the MARC biblio
369 $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode );
371 return (\@itemnumbers, \@errors);
374 =head2 ModItemFromMarc
376 ModItemFromMarc($item_marc, $biblionumber, $itemnumber);
378 This function updates an item record based on a supplied
379 C<MARC::Record> object containing an embedded item field.
380 This API is meant for the use of C<additem.pl>; for
381 other purposes, C<ModItem> should be used.
383 This function uses the hash %default_values_for_mod_from_marc,
384 which contains default values for item fields to
385 apply when modifying an item. This is needed beccause
386 if an item field's value is cleared, TransformMarcToKoha
387 does not include the column in the
388 hash that's passed to ModItem, which without
389 use of this hash makes it impossible to clear
390 an item field's value. See bug 2466.
392 Note that only columns that can be directly
393 changed from the cataloging and serials
394 item editors are included in this hash.
398 my %default_values_for_mod_from_marc = (
400 booksellerid => undef,
402 'items.cn_source' => undef,
405 dateaccessioned => undef,
407 holdingbranch => undef,
409 itemcallnumber => undef,
418 replacementprice => undef,
419 replacementpricedate => undef,
422 stocknumber => undef,
427 sub ModItemFromMarc {
428 my $item_marc = shift;
429 my $biblionumber = shift;
430 my $itemnumber = shift;
432 my $dbh = C4::Context->dbh;
433 my $frameworkcode = GetFrameworkCode( $biblionumber );
434 my ($itemtag,$itemsubfield)=GetMarcFromKohaField("items.itemnumber",$frameworkcode);
436 my $localitemmarc=MARC::Record->new;
437 $localitemmarc->append_fields($item_marc->field($itemtag));
438 my $item = &TransformMarcToKoha( $dbh, $localitemmarc, $frameworkcode, 'items');
439 foreach my $item_field (keys %default_values_for_mod_from_marc) {
440 $item->{$item_field} = $default_values_for_mod_from_marc{$item_field} unless exists $item->{$item_field};
442 my $unlinked_item_subfields = _get_unlinked_item_subfields($localitemmarc, $frameworkcode);
444 return ModItem($item, $biblionumber, $itemnumber, $dbh, $frameworkcode, $unlinked_item_subfields);
449 ModItem({ column => $newvalue }, $biblionumber,
450 $itemnumber[, $original_item_marc]);
452 Change one or more columns in an item record and update
453 the MARC representation of the item.
455 The first argument is a hashref mapping from item column
456 names to the new values. The second and third arguments
457 are the biblionumber and itemnumber, respectively.
459 The fourth, optional parameter, C<$unlinked_item_subfields>, contains
460 an arrayref containing subfields present in the original MARC
461 representation of the item (e.g., from the item editor) that are
462 not mapped to C<items> columns directly but should instead
463 be stored in C<items.more_subfields_xml> and included in
464 the biblio items tag for display and indexing.
466 If one of the changed columns is used to calculate
467 the derived value of a column such as C<items.cn_sort>,
468 this routine will perform the necessary calculation
475 my $biblionumber = shift;
476 my $itemnumber = shift;
478 # if $biblionumber is undefined, get it from the current item
479 unless (defined $biblionumber) {
480 $biblionumber = _get_single_item_column('biblionumber', $itemnumber);
483 my $dbh = @_ ? shift : C4::Context->dbh;
484 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
486 my $unlinked_item_subfields;
488 $unlinked_item_subfields = shift;
489 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
492 $item->{'itemnumber'} = $itemnumber or return undef;
493 _set_derived_columns_for_mod($item);
494 _do_column_fixes_for_mod($item);
497 # attempt to change itemnumber
498 # attempt to change biblionumber (if we want
499 # an API to relink an item to a different bib,
500 # it should be a separate function)
503 _koha_modify_item($item);
505 # update biblio MARC XML
506 my $whole_item = GetItem($itemnumber) or die "FAILED GetItem($itemnumber)";
508 unless (defined $unlinked_item_subfields) {
509 $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'});
511 my $new_item_marc = _marc_from_item_hash($whole_item, $frameworkcode, $unlinked_item_subfields)
512 or die "FAILED _marc_from_item_hash($whole_item, $frameworkcode)";
514 _replace_item_field_in_biblio($new_item_marc, $biblionumber, $itemnumber, $frameworkcode);
515 ($new_item_marc eq '0') and die "$new_item_marc is '0', not hashref"; # logaction line would crash anyway
516 logaction("CATALOGUING", "MODIFY", $itemnumber, $new_item_marc->as_formatted) if C4::Context->preference("CataloguingLog");
519 =head2 ModItemTransfer
521 ModItemTransfer($itenumber, $frombranch, $tobranch);
523 Marks an item as being transferred from one branch
528 sub ModItemTransfer {
529 my ( $itemnumber, $frombranch, $tobranch ) = @_;
531 my $dbh = C4::Context->dbh;
533 #new entry in branchtransfers....
534 my $sth = $dbh->prepare(
535 "INSERT INTO branchtransfers (itemnumber, frombranch, datesent, tobranch)
536 VALUES (?, ?, NOW(), ?)");
537 $sth->execute($itemnumber, $frombranch, $tobranch);
539 ModItem({ holdingbranch => $tobranch }, undef, $itemnumber);
540 ModDateLastSeen($itemnumber);
544 =head2 ModDateLastSeen
546 ModDateLastSeen($itemnum);
548 Mark item as seen. Is called when an item is issued, returned or manually marked during inventory/stocktaking.
549 C<$itemnum> is the item number
553 sub ModDateLastSeen {
554 my ($itemnumber) = @_;
556 my $today = C4::Dates->new();
557 ModItem({ itemlost => 0, datelastseen => $today->output("iso") }, undef, $itemnumber);
562 DelItem($dbh, $biblionumber, $itemnumber);
564 Exported function (core API) for deleting an item record in Koha.
569 my ( $dbh, $biblionumber, $itemnumber ) = @_;
571 # FIXME check the item has no current issues
573 _koha_delete_item( $dbh, $itemnumber );
575 # get the MARC record
576 my $record = GetMarcBiblio($biblionumber);
577 my $frameworkcode = GetFrameworkCode($biblionumber);
580 my $copy2deleted = $dbh->prepare("UPDATE deleteditems SET marc=? WHERE itemnumber=?");
581 $copy2deleted->execute( $record->as_usmarc(), $itemnumber );
583 #search item field code
584 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
585 my @fields = $record->field($itemtag);
587 # delete the item specified
588 foreach my $field (@fields) {
589 if ( $field->subfield($itemsubfield) eq $itemnumber ) {
590 $record->delete_field($field);
593 &ModBiblioMarc( $record, $biblionumber, $frameworkcode );
594 logaction("CATALOGUING", "DELETE", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
597 =head2 CheckItemPreSave
599 my $item_ref = TransformMarcToKoha($marc, 'items');
601 my %errors = CheckItemPreSave($item_ref);
602 if (exists $errors{'duplicate_barcode'}) {
603 print "item has duplicate barcode: ", $errors{'duplicate_barcode'}, "\n";
604 } elsif (exists $errors{'invalid_homebranch'}) {
605 print "item has invalid home branch: ", $errors{'invalid_homebranch'}, "\n";
606 } elsif (exists $errors{'invalid_holdingbranch'}) {
607 print "item has invalid holding branch: ", $errors{'invalid_holdingbranch'}, "\n";
612 Given a hashref containing item fields, determine if it can be
613 inserted or updated in the database. Specifically, checks for
614 database integrity issues, and returns a hash containing any
615 of the following keys, if applicable.
619 =item duplicate_barcode
621 Barcode, if it duplicates one already found in the database.
623 =item invalid_homebranch
625 Home branch, if not defined in branches table.
627 =item invalid_holdingbranch
629 Holding branch, if not defined in branches table.
633 This function does NOT implement any policy-related checks,
634 e.g., whether current operator is allowed to save an
635 item that has a given branch code.
639 sub CheckItemPreSave {
640 my $item_ref = shift;
644 # check for duplicate barcode
645 if (exists $item_ref->{'barcode'} and defined $item_ref->{'barcode'}) {
646 my $existing_itemnumber = GetItemnumberFromBarcode($item_ref->{'barcode'});
647 if ($existing_itemnumber) {
648 if (!exists $item_ref->{'itemnumber'} # new item
649 or $item_ref->{'itemnumber'} != $existing_itemnumber) { # existing item
650 $errors{'duplicate_barcode'} = $item_ref->{'barcode'};
655 # check for valid home branch
656 if (exists $item_ref->{'homebranch'} and defined $item_ref->{'homebranch'}) {
657 my $branch_name = GetBranchName($item_ref->{'homebranch'});
658 unless (defined $branch_name) {
659 # relies on fact that branches.branchname is a non-NULL column,
660 # so GetBranchName returns undef only if branch does not exist
661 $errors{'invalid_homebranch'} = $item_ref->{'homebranch'};
665 # check for valid holding branch
666 if (exists $item_ref->{'holdingbranch'} and defined $item_ref->{'holdingbranch'}) {
667 my $branch_name = GetBranchName($item_ref->{'holdingbranch'});
668 unless (defined $branch_name) {
669 # relies on fact that branches.branchname is a non-NULL column,
670 # so GetBranchName returns undef only if branch does not exist
671 $errors{'invalid_holdingbranch'} = $item_ref->{'holdingbranch'};
679 =head1 EXPORTED SPECIAL ACCESSOR FUNCTIONS
681 The following functions provide various ways of
682 getting an item record, a set of item records, or
683 lists of authorized values for certain item fields.
685 Some of the functions in this group are candidates
686 for refactoring -- for example, some of the code
687 in C<GetItemsByBiblioitemnumber> and C<GetItemsInfo>
688 has copy-and-paste work.
694 $itemstatushash = GetItemStatus($fwkcode);
696 Returns a list of valid values for the
697 C<items.notforloan> field.
699 NOTE: does B<not> return an individual item's
702 Can be MARC dependant.
704 But basically could be can be loan or not
705 Create a status selector with the following code
707 =head3 in PERL SCRIPT
709 my $itemstatushash = getitemstatus;
711 foreach my $thisstatus (keys %$itemstatushash) {
712 my %row =(value => $thisstatus,
713 statusname => $itemstatushash->{$thisstatus}->{'statusname'},
715 push @itemstatusloop, \%row;
717 $template->param(statusloop=>\@itemstatusloop);
721 <select name="statusloop">
722 <option value="">Default</option>
723 <!-- TMPL_LOOP name="statusloop" -->
724 <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="statusname" --></option>
732 # returns a reference to a hash of references to status...
735 my $dbh = C4::Context->dbh;
737 $fwk = '' unless ($fwk);
738 my ( $tag, $subfield ) =
739 GetMarcFromKohaField( "items.notforloan", $fwk );
740 if ( $tag and $subfield ) {
743 "SELECT authorised_value
744 FROM marc_subfield_structure
750 $sth->execute( $tag, $subfield, $fwk );
751 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
754 "SELECT authorised_value,lib
755 FROM authorised_values
760 $authvalsth->execute($authorisedvaluecat);
761 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
762 $itemstatus{$authorisedvalue} = $lib;
776 $itemstatus{"1"} = "Not For Loan";
780 =head2 GetItemLocation
782 $itemlochash = GetItemLocation($fwk);
784 Returns a list of valid values for the
785 C<items.location> field.
787 NOTE: does B<not> return an individual item's
790 where fwk stands for an optional framework code.
791 Create a location selector with the following code
793 =head3 in PERL SCRIPT
795 my $itemlochash = getitemlocation;
797 foreach my $thisloc (keys %$itemlochash) {
798 my $selected = 1 if $thisbranch eq $branch;
799 my %row =(locval => $thisloc,
800 selected => $selected,
801 locname => $itemlochash->{$thisloc},
803 push @itemlocloop, \%row;
805 $template->param(itemlocationloop => \@itemlocloop);
809 <select name="location">
810 <option value="">Default</option>
811 <!-- TMPL_LOOP name="itemlocationloop" -->
812 <option value="<!-- TMPL_VAR name="locval" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="locname" --></option>
818 sub GetItemLocation {
820 # returns a reference to a hash of references to location...
823 my $dbh = C4::Context->dbh;
825 $fwk = '' unless ($fwk);
826 my ( $tag, $subfield ) =
827 GetMarcFromKohaField( "items.location", $fwk );
828 if ( $tag and $subfield ) {
831 "SELECT authorised_value
832 FROM marc_subfield_structure
837 $sth->execute( $tag, $subfield, $fwk );
838 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
841 "SELECT authorised_value,lib
842 FROM authorised_values
846 $authvalsth->execute($authorisedvaluecat);
847 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
848 $itemlocation{$authorisedvalue} = $lib;
850 return \%itemlocation;
862 $itemlocation{"1"} = "Not For Loan";
863 return \%itemlocation;
868 $items = GetLostItems( $where, $orderby );
870 This function gets a list of lost items.
876 C<$where> is a hashref. it containts a field of the items table as key
877 and the value to match as value. For example:
879 { barcode => 'abc123',
880 homebranch => 'CPL', }
882 C<$orderby> is a field of the items table by which the resultset
887 C<$items> is a reference to an array full of hashrefs with columns
888 from the "items" table as keys.
890 =item usage in the perl script:
892 my $where = { barcode => '0001548' };
893 my $items = GetLostItems( $where, "homebranch" );
894 $template->param( itemsloop => $items );
901 # Getting input args.
904 my $dbh = C4::Context->dbh;
909 LEFT JOIN biblio ON (items.biblionumber = biblio.biblionumber)
910 LEFT JOIN biblioitems ON (items.biblionumber = biblioitems.biblionumber)
911 LEFT JOIN authorised_values ON (items.itemlost = authorised_values.authorised_value)
913 authorised_values.category = 'LOST'
914 AND itemlost IS NOT NULL
917 my @query_parameters;
918 foreach my $key (keys %$where) {
919 $query .= " AND $key LIKE ?";
920 push @query_parameters, "%$where->{$key}%";
922 my @ordervalues = qw/title author homebranch itype barcode price replacementprice lib datelastseen location/;
924 if ( defined $orderby && grep($orderby, @ordervalues)) {
925 $query .= ' ORDER BY '.$orderby;
928 my $sth = $dbh->prepare($query);
929 $sth->execute( @query_parameters );
931 while ( my $row = $sth->fetchrow_hashref ){
937 =head2 GetItemsForInventory
939 $itemlist = GetItemsForInventory($minlocation, $maxlocation,
940 $location, $itemtype $datelastseen, $branch,
941 $offset, $size, $statushash);
943 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
945 The sub returns a reference to a list of hashes, each containing
946 itemnumber, author, title, barcode, item callnumber, and date last
947 seen. It is ordered by callnumber then title.
949 The required minlocation & maxlocation parameters are used to specify a range of item callnumbers
950 the datelastseen can be used to specify that you want to see items not seen since a past date only.
951 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
952 $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.
956 sub GetItemsForInventory {
957 my ( $minlocation, $maxlocation,$location, $itemtype, $ignoreissued, $datelastseen, $branch, $offset, $size, $statushash ) = @_;
958 my $dbh = C4::Context->dbh;
959 my ( @bind_params, @where_strings );
961 my $query = <<'END_SQL';
962 SELECT items.itemnumber, barcode, itemcallnumber, title, author, biblio.biblionumber, datelastseen
964 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
965 LEFT JOIN biblioitems on items.biblionumber = biblioitems.biblionumber
968 for my $authvfield (keys %$statushash){
969 if ( scalar @{$statushash->{$authvfield}} > 0 ){
970 my $joinedvals = join ',', @{$statushash->{$authvfield}};
971 push @where_strings, "$authvfield in (" . $joinedvals . ")";
977 push @where_strings, 'itemcallnumber >= ?';
978 push @bind_params, $minlocation;
982 push @where_strings, 'itemcallnumber <= ?';
983 push @bind_params, $maxlocation;
987 $datelastseen = format_date_in_iso($datelastseen);
988 push @where_strings, '(datelastseen < ? OR datelastseen IS NULL)';
989 push @bind_params, $datelastseen;
993 push @where_strings, 'items.location = ?';
994 push @bind_params, $location;
998 push @where_strings, 'items.homebranch = ?';
999 push @bind_params, $branch;
1003 push @where_strings, 'biblioitems.itemtype = ?';
1004 push @bind_params, $itemtype;
1007 if ( $ignoreissued) {
1008 $query .= "LEFT JOIN issues ON items.itemnumber = issues.itemnumber ";
1009 push @where_strings, 'issues.date_due IS NULL';
1012 if ( @where_strings ) {
1014 $query .= join ' AND ', @where_strings;
1016 $query .= ' ORDER BY items.cn_sort, itemcallnumber, title';
1017 my $sth = $dbh->prepare($query);
1018 $sth->execute( @bind_params );
1022 while ( my $row = $sth->fetchrow_hashref ) {
1023 $offset-- if ($offset);
1024 $row->{datelastseen}=format_date($row->{datelastseen});
1025 if ( ( !$offset ) && $size ) {
1026 push @results, $row;
1033 =head2 GetItemsCount
1035 $count = &GetItemsCount( $biblionumber);
1037 This function return count of item with $biblionumber
1042 my ( $biblionumber ) = @_;
1043 my $dbh = C4::Context->dbh;
1044 my $query = "SELECT count(*)
1046 WHERE biblionumber=?";
1047 my $sth = $dbh->prepare($query);
1048 $sth->execute($biblionumber);
1049 my $count = $sth->fetchrow;
1053 =head2 GetItemInfosOf
1055 GetItemInfosOf(@itemnumbers);
1059 sub GetItemInfosOf {
1060 my @itemnumbers = @_;
1065 WHERE itemnumber IN (' . join( ',', @itemnumbers ) . ')
1067 return get_infos_of( $query, 'itemnumber' );
1070 =head2 GetItemsByBiblioitemnumber
1072 GetItemsByBiblioitemnumber($biblioitemnumber);
1074 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1075 Called by C<C4::XISBN>
1079 sub GetItemsByBiblioitemnumber {
1080 my ( $bibitem ) = @_;
1081 my $dbh = C4::Context->dbh;
1082 my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1083 # Get all items attached to a biblioitem
1086 $sth->execute($bibitem) || die $sth->errstr;
1087 while ( my $data = $sth->fetchrow_hashref ) {
1088 # Foreach item, get circulation information
1089 my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1090 WHERE itemnumber = ?
1091 AND issues.borrowernumber = borrowers.borrowernumber"
1093 $sth2->execute( $data->{'itemnumber'} );
1094 if ( my $data2 = $sth2->fetchrow_hashref ) {
1095 # if item is out, set the due date and who it is out too
1096 $data->{'date_due'} = $data2->{'date_due'};
1097 $data->{'cardnumber'} = $data2->{'cardnumber'};
1098 $data->{'borrowernumber'} = $data2->{'borrowernumber'};
1101 # set date_due to blank, so in the template we check itemlost, and wthdrawn
1102 $data->{'date_due'} = '';
1104 # Find the last 3 people who borrowed this item.
1105 my $query2 = "SELECT * FROM old_issues, borrowers WHERE itemnumber = ?
1106 AND old_issues.borrowernumber = borrowers.borrowernumber
1107 ORDER BY returndate desc,timestamp desc LIMIT 3";
1108 $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1109 $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1111 while ( my $data2 = $sth2->fetchrow_hashref ) {
1112 $data->{"timestamp$i2"} = $data2->{'timestamp'};
1113 $data->{"card$i2"} = $data2->{'cardnumber'};
1114 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
1117 push(@results,$data);
1124 @results = GetItemsInfo($biblionumber, $type);
1126 Returns information about books with the given biblionumber.
1128 C<$type> may be either C<intra> or anything else. If it is not set to
1129 C<intra>, then the search will exclude lost, very overdue, and
1132 C<GetItemsInfo> returns a list of references-to-hash. Each element
1133 contains a number of keys. Most of them are table items from the
1134 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
1135 Koha database. Other keys include:
1139 =item C<$data-E<gt>{branchname}>
1141 The name (not the code) of the branch to which the book belongs.
1143 =item C<$data-E<gt>{datelastseen}>
1145 This is simply C<items.datelastseen>, except that while the date is
1146 stored in YYYY-MM-DD format in the database, here it is converted to
1147 DD/MM/YYYY format. A NULL date is returned as C<//>.
1149 =item C<$data-E<gt>{datedue}>
1151 =item C<$data-E<gt>{class}>
1153 This is the concatenation of C<biblioitems.classification>, the book's
1154 Dewey code, and C<biblioitems.subclass>.
1156 =item C<$data-E<gt>{ocount}>
1158 I think this is the number of copies of the book available.
1160 =item C<$data-E<gt>{order}>
1162 If this is set, it is set to C<One Order>.
1169 my ( $biblionumber, $type ) = @_;
1170 my $dbh = C4::Context->dbh;
1171 # note biblioitems.* must be avoided to prevent large marc and marcxml fields from killing performance.
1177 biblioitems.itemtype,
1180 biblioitems.publicationyear,
1181 biblioitems.publishercode,
1182 biblioitems.volumedate,
1183 biblioitems.volumedesc,
1186 items.notforloan as itemnotforloan,
1187 itemtypes.description,
1188 itemtypes.notforloan as notforloan_per_itemtype,
1191 LEFT JOIN branches ON items.homebranch = branches.branchcode
1192 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1193 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1194 LEFT JOIN itemtypes ON itemtypes.itemtype = "
1195 . (C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype');
1196 $query .= " WHERE items.biblionumber = ? ORDER BY branches.branchname,items.dateaccessioned desc" ;
1197 my $sth = $dbh->prepare($query);
1198 $sth->execute($biblionumber);
1203 my $isth = $dbh->prepare(
1204 "SELECT issues.*,borrowers.cardnumber,borrowers.surname,borrowers.firstname,borrowers.branchcode as bcode
1205 FROM issues LEFT JOIN borrowers ON issues.borrowernumber=borrowers.borrowernumber
1206 WHERE itemnumber = ?"
1208 my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=? ");
1209 while ( my $data = $sth->fetchrow_hashref ) {
1212 $isth->execute( $data->{'itemnumber'} );
1213 if ( my $idata = $isth->fetchrow_hashref ) {
1214 $data->{borrowernumber} = $idata->{borrowernumber};
1215 $data->{cardnumber} = $idata->{cardnumber};
1216 $data->{surname} = $idata->{surname};
1217 $data->{firstname} = $idata->{firstname};
1218 $datedue = $idata->{'date_due'};
1219 if (C4::Context->preference("IndependantBranches")){
1220 my $userenv = C4::Context->userenv;
1221 if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
1222 $data->{'NOTSAMEBRANCH'} = 1 if ($idata->{'bcode'} ne $userenv->{branch});
1226 if ( $data->{'serial'}) {
1227 $ssth->execute($data->{'itemnumber'}) ;
1228 ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
1231 if ( $datedue eq '' ) {
1232 my ( $restype, $reserves ) =
1233 C4::Reserves::CheckReserves( $data->{'itemnumber'} );
1234 # Previous conditional check with if ($restype) is not needed because a true
1235 # result for one item will result in subsequent items defaulting to this true
1237 $count_reserves = $restype;
1239 #get branch information.....
1240 my $bsth = $dbh->prepare(
1241 "SELECT * FROM branches WHERE branchcode = ?
1244 $bsth->execute( $data->{'holdingbranch'} );
1245 if ( my $bdata = $bsth->fetchrow_hashref ) {
1246 $data->{'branchname'} = $bdata->{'branchname'};
1248 $data->{'datedue'} = $datedue;
1249 $data->{'count_reserves'} = $count_reserves;
1251 # get notforloan complete status if applicable
1252 my $sthnflstatus = $dbh->prepare(
1253 'SELECT authorised_value
1254 FROM marc_subfield_structure
1255 WHERE kohafield="items.notforloan"
1259 $sthnflstatus->execute;
1260 my ($authorised_valuecode) = $sthnflstatus->fetchrow;
1261 if ($authorised_valuecode) {
1262 $sthnflstatus = $dbh->prepare(
1263 "SELECT lib FROM authorised_values
1265 AND authorised_value=?"
1267 $sthnflstatus->execute( $authorised_valuecode,
1268 $data->{itemnotforloan} );
1269 my ($lib) = $sthnflstatus->fetchrow;
1270 $data->{notforloanvalue} = $lib;
1273 # get restricted status and description if applicable
1274 my $restrictedstatus = $dbh->prepare(
1275 'SELECT authorised_value
1276 FROM marc_subfield_structure
1277 WHERE kohafield="items.restricted"
1281 $restrictedstatus->execute;
1282 ($authorised_valuecode) = $restrictedstatus->fetchrow;
1283 if ($authorised_valuecode) {
1284 $restrictedstatus = $dbh->prepare(
1285 "SELECT lib,lib_opac FROM authorised_values
1287 AND authorised_value=?"
1289 $restrictedstatus->execute( $authorised_valuecode,
1290 $data->{restricted} );
1292 if ( my $rstdata = $restrictedstatus->fetchrow_hashref ) {
1293 $data->{restricted} = $rstdata->{'lib'};
1294 $data->{restrictedopac} = $rstdata->{'lib_opac'};
1298 # my stack procedures
1299 my $stackstatus = $dbh->prepare(
1300 'SELECT authorised_value
1301 FROM marc_subfield_structure
1302 WHERE kohafield="items.stack"
1305 $stackstatus->execute;
1307 ($authorised_valuecode) = $stackstatus->fetchrow;
1308 if ($authorised_valuecode) {
1309 $stackstatus = $dbh->prepare(
1311 FROM authorised_values
1313 AND authorised_value=?
1316 $stackstatus->execute( $authorised_valuecode, $data->{stack} );
1317 my ($lib) = $stackstatus->fetchrow;
1318 $data->{stack} = $lib;
1320 # Find the last 3 people who borrowed this item.
1321 my $sth2 = $dbh->prepare("SELECT * FROM old_issues,borrowers
1322 WHERE itemnumber = ?
1323 AND old_issues.borrowernumber = borrowers.borrowernumber
1324 ORDER BY returndate DESC
1326 $sth2->execute($data->{'itemnumber'});
1328 while (my $data2 = $sth2->fetchrow_hashref()) {
1329 $data->{"timestamp$ii"} = $data2->{'timestamp'} if $data2->{'timestamp'};
1330 $data->{"card$ii"} = $data2->{'cardnumber'} if $data2->{'cardnumber'};
1331 $data->{"borrower$ii"} = $data2->{'borrowernumber'} if $data2->{'borrowernumber'};
1335 $results[$i] = $data;
1339 return( sort { ($b->{'publisheddate'} || $b->{'enumchron'}) cmp ($a->{'publisheddate'} || $a->{'enumchron'}) } @results );
1345 =head2 GetLastAcquisitions
1347 my $lastacq = GetLastAcquisitions({'branches' => ('branch1','branch2'),
1348 'itemtypes' => ('BK','BD')}, 10);
1352 sub GetLastAcquisitions {
1353 my ($data,$max) = @_;
1355 my $itemtype = C4::Context->preference('item-level_itypes') ? 'itype' : 'itemtype';
1357 my $number_of_branches = @{$data->{branches}};
1358 my $number_of_itemtypes = @{$data->{itemtypes}};
1361 my @where = ('WHERE 1 ');
1362 $number_of_branches and push @where
1363 , 'AND holdingbranch IN ('
1364 , join(',', ('?') x $number_of_branches )
1368 $number_of_itemtypes and push @where
1369 , "AND $itemtype IN ("
1370 , join(',', ('?') x $number_of_itemtypes )
1374 my $query = "SELECT biblio.biblionumber as biblionumber, title, dateaccessioned
1375 FROM items RIGHT JOIN biblio ON (items.biblionumber=biblio.biblionumber)
1376 RIGHT JOIN biblioitems ON (items.biblioitemnumber=biblioitems.biblioitemnumber)
1378 GROUP BY biblio.biblionumber
1379 ORDER BY dateaccessioned DESC LIMIT $max";
1381 my $dbh = C4::Context->dbh;
1382 my $sth = $dbh->prepare($query);
1384 $sth->execute((@{$data->{branches}}, @{$data->{itemtypes}}));
1387 while( my $row = $sth->fetchrow_hashref){
1388 push @results, {date => $row->{dateaccessioned}
1389 , biblionumber => $row->{biblionumber}
1390 , title => $row->{title}};
1396 =head2 get_itemnumbers_of
1398 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1400 Given a list of biblionumbers, return the list of corresponding itemnumbers
1401 for each biblionumber.
1403 Return a reference on a hash where keys are biblionumbers and values are
1404 references on array of itemnumbers.
1408 sub get_itemnumbers_of {
1409 my @biblionumbers = @_;
1411 my $dbh = C4::Context->dbh;
1417 WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1419 my $sth = $dbh->prepare($query);
1420 $sth->execute(@biblionumbers);
1424 while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1425 push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1428 return \%itemnumbers_of;
1431 =head2 GetItemnumberFromBarcode
1433 $result = GetItemnumberFromBarcode($barcode);
1437 sub GetItemnumberFromBarcode {
1439 my $dbh = C4::Context->dbh;
1442 $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1443 $rq->execute($barcode);
1444 my ($result) = $rq->fetchrow;
1448 =head2 GetBarcodeFromItemnumber
1450 $result = GetBarcodeFromItemnumber($itemnumber);
1454 sub GetBarcodeFromItemnumber {
1455 my ($itemnumber) = @_;
1456 my $dbh = C4::Context->dbh;
1459 $dbh->prepare("SELECT barcode FROM items WHERE items.itemnumber=?");
1460 $rq->execute($itemnumber);
1461 my ($result) = $rq->fetchrow;
1465 =head3 get_item_authorised_values
1467 find the types and values for all authorised values assigned to this item.
1469 parameters: itemnumber
1471 returns: a hashref malling the authorised value to the value set for this itemnumber
1473 $authorised_values = {
1479 'RESTRICTED' => undef,
1482 'branches' => 'CPL',
1483 'cn_source' => undef,
1484 'itemtypes' => 'SER',
1487 Notes: see C4::Biblio::get_biblio_authorised_values for a similar method at the biblio level.
1491 sub get_item_authorised_values {
1492 my $itemnumber = shift;
1494 # assume that these entries in the authorised_value table are item level.
1495 my $query = q(SELECT distinct authorised_value, kohafield
1496 FROM marc_subfield_structure
1497 WHERE kohafield like 'item%'
1498 AND authorised_value != '' );
1500 my $itemlevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
1501 my $iteminfo = GetItem( $itemnumber );
1502 # warn( Data::Dumper->Dump( [ $itemlevel_authorised_values ], [ 'itemlevel_authorised_values' ] ) );
1504 foreach my $this_authorised_value ( keys %$itemlevel_authorised_values ) {
1505 my $field = $itemlevel_authorised_values->{ $this_authorised_value }->{'kohafield'};
1506 $field =~ s/^items\.//;
1507 if ( exists $iteminfo->{ $field } ) {
1508 $return->{ $this_authorised_value } = $iteminfo->{ $field };
1511 # warn( Data::Dumper->Dump( [ $return ], [ 'return' ] ) );
1515 =head3 get_authorised_value_images
1517 find a list of icons that are appropriate for display based on the
1518 authorised values for a biblio.
1520 parameters: listref of authorised values, such as comes from
1521 get_item_authorised_values or
1522 from C4::Biblio::get_biblio_authorised_values
1524 returns: listref of hashrefs for each image. Each hashref looks like this:
1526 { imageurl => '/intranet-tmpl/prog/img/itemtypeimg/npl/WEB.gif',
1531 Notes: Currently, I put on the full path to the images on the staff
1532 side. This should either be configurable or not done at all. Since I
1533 have to deal with 'intranet' or 'opac' in
1534 get_biblio_authorised_values, perhaps I should be passing it in.
1538 sub get_authorised_value_images {
1539 my $authorised_values = shift;
1543 my $authorised_value_list = GetAuthorisedValues();
1544 # warn ( Data::Dumper->Dump( [ $authorised_value_list ], [ 'authorised_value_list' ] ) );
1545 foreach my $this_authorised_value ( @$authorised_value_list ) {
1546 if ( exists $authorised_values->{ $this_authorised_value->{'category'} }
1547 && $authorised_values->{ $this_authorised_value->{'category'} } eq $this_authorised_value->{'authorised_value'} ) {
1548 # warn ( Data::Dumper->Dump( [ $this_authorised_value ], [ 'this_authorised_value' ] ) );
1549 if ( defined $this_authorised_value->{'imageurl'} ) {
1550 push @imagelist, { imageurl => C4::Koha::getitemtypeimagelocation( 'intranet', $this_authorised_value->{'imageurl'} ),
1551 label => $this_authorised_value->{'lib'},
1552 category => $this_authorised_value->{'category'},
1553 value => $this_authorised_value->{'authorised_value'}, };
1558 # warn ( Data::Dumper->Dump( [ \@imagelist ], [ 'imagelist' ] ) );
1563 =head1 LIMITED USE FUNCTIONS
1565 The following functions, while part of the public API,
1566 are not exported. This is generally because they are
1567 meant to be used by only one script for a specific
1568 purpose, and should not be used in any other context
1569 without careful thought.
1575 my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1577 Returns MARC::Record of the item passed in parameter.
1578 This function is meant for use only in C<cataloguing/additem.pl>,
1579 where it is needed to support that script's MARC-like
1585 my ( $biblionumber, $itemnumber ) = @_;
1587 # GetMarcItem has been revised so that it does the following:
1588 # 1. Gets the item information from the items table.
1589 # 2. Converts it to a MARC field for storage in the bib record.
1591 # The previous behavior was:
1592 # 1. Get the bib record.
1593 # 2. Return the MARC tag corresponding to the item record.
1595 # The difference is that one treats the items row as authoritative,
1596 # while the other treats the MARC representation as authoritative
1597 # under certain circumstances.
1599 my $itemrecord = GetItem($itemnumber);
1601 # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1602 # Also, don't emit a subfield if the underlying field is blank.
1605 return Item2Marc($itemrecord,$biblionumber);
1609 my ($itemrecord,$biblionumber)=@_;
1612 defined($itemrecord->{$_}) && $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : ()
1613 } keys %{ $itemrecord }
1615 my $itemmarc = TransformKohaToMarc($mungeditem);
1616 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",GetFrameworkCode($biblionumber)||'');
1618 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1619 if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1620 foreach my $field ($itemmarc->field($itemtag)){
1621 $field->add_subfields(@$unlinked_item_subfields);
1627 =head1 PRIVATE FUNCTIONS AND VARIABLES
1629 The following functions are not meant to be called
1630 directly, but are documented in order to explain
1631 the inner workings of C<C4::Items>.
1635 =head2 %derived_columns
1637 This hash keeps track of item columns that
1638 are strictly derived from other columns in
1639 the item record and are not meant to be set
1642 Each key in the hash should be the name of a
1643 column (as named by TransformMarcToKoha). Each
1644 value should be hashref whose keys are the
1645 columns on which the derived column depends. The
1646 hashref should also contain a 'BUILDER' key
1647 that is a reference to a sub that calculates
1652 my %derived_columns = (
1653 'items.cn_sort' => {
1654 'itemcallnumber' => 1,
1655 'items.cn_source' => 1,
1656 'BUILDER' => \&_calc_items_cn_sort,
1660 =head2 _set_derived_columns_for_add
1662 _set_derived_column_for_add($item);
1664 Given an item hash representing a new item to be added,
1665 calculate any derived columns. Currently the only
1666 such column is C<items.cn_sort>.
1670 sub _set_derived_columns_for_add {
1673 foreach my $column (keys %derived_columns) {
1674 my $builder = $derived_columns{$column}->{'BUILDER'};
1675 my $source_values = {};
1676 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1677 next if $source_column eq 'BUILDER';
1678 $source_values->{$source_column} = $item->{$source_column};
1680 $builder->($item, $source_values);
1684 =head2 _set_derived_columns_for_mod
1686 _set_derived_column_for_mod($item);
1688 Given an item hash representing a new item to be modified.
1689 calculate any derived columns. Currently the only
1690 such column is C<items.cn_sort>.
1692 This routine differs from C<_set_derived_columns_for_add>
1693 in that it needs to handle partial item records. In other
1694 words, the caller of C<ModItem> may have supplied only one
1695 or two columns to be changed, so this function needs to
1696 determine whether any of the columns to be changed affect
1697 any of the derived columns. Also, if a derived column
1698 depends on more than one column, but the caller is not
1699 changing all of then, this routine retrieves the unchanged
1700 values from the database in order to ensure a correct
1705 sub _set_derived_columns_for_mod {
1708 foreach my $column (keys %derived_columns) {
1709 my $builder = $derived_columns{$column}->{'BUILDER'};
1710 my $source_values = {};
1711 my %missing_sources = ();
1712 my $must_recalc = 0;
1713 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1714 next if $source_column eq 'BUILDER';
1715 if (exists $item->{$source_column}) {
1717 $source_values->{$source_column} = $item->{$source_column};
1719 $missing_sources{$source_column} = 1;
1723 foreach my $source_column (keys %missing_sources) {
1724 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
1726 $builder->($item, $source_values);
1731 =head2 _do_column_fixes_for_mod
1733 _do_column_fixes_for_mod($item);
1735 Given an item hashref containing one or more
1736 columns to modify, fix up certain values.
1737 Specifically, set to 0 any passed value
1738 of C<notforloan>, C<damaged>, C<itemlost>, or
1739 C<wthdrawn> that is either undefined or
1740 contains the empty string.
1744 sub _do_column_fixes_for_mod {
1747 if (exists $item->{'notforloan'} and
1748 (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
1749 $item->{'notforloan'} = 0;
1751 if (exists $item->{'damaged'} and
1752 (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
1753 $item->{'damaged'} = 0;
1755 if (exists $item->{'itemlost'} and
1756 (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
1757 $item->{'itemlost'} = 0;
1759 if (exists $item->{'wthdrawn'} and
1760 (not defined $item->{'wthdrawn'} or $item->{'wthdrawn'} eq '')) {
1761 $item->{'wthdrawn'} = 0;
1763 if (exists $item->{'location'} && !exists $item->{'permanent_location'}) {
1764 $item->{'permanent_location'} = $item->{'location'};
1768 =head2 _get_single_item_column
1770 _get_single_item_column($column, $itemnumber);
1772 Retrieves the value of a single column from an C<items>
1773 row specified by C<$itemnumber>.
1777 sub _get_single_item_column {
1779 my $itemnumber = shift;
1781 my $dbh = C4::Context->dbh;
1782 my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
1783 $sth->execute($itemnumber);
1784 my ($value) = $sth->fetchrow();
1788 =head2 _calc_items_cn_sort
1790 _calc_items_cn_sort($item, $source_values);
1792 Helper routine to calculate C<items.cn_sort>.
1796 sub _calc_items_cn_sort {
1798 my $source_values = shift;
1800 $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
1803 =head2 _set_defaults_for_add
1805 _set_defaults_for_add($item_hash);
1807 Given an item hash representing an item to be added, set
1808 correct default values for columns whose default value
1809 is not handled by the DBMS. This includes the following
1816 C<items.dateaccessioned>
1838 sub _set_defaults_for_add {
1840 $item->{dateaccessioned} ||= C4::Dates->new->output('iso');
1841 $item->{$_} ||= 0 for (qw( notforloan damaged itemlost wthdrawn));
1844 =head2 _koha_new_item
1846 my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
1848 Perform the actual insert into the C<items> table.
1852 sub _koha_new_item {
1853 my ( $item, $barcode ) = @_;
1854 my $dbh=C4::Context->dbh;
1857 "INSERT INTO items SET
1859 biblioitemnumber = ?,
1861 dateaccessioned = ?,
1865 replacementprice = ?,
1866 replacementpricedate = NOW(),
1867 datelastborrowed = ?,
1868 datelastseen = NOW(),
1891 more_subfields_xml = ?,
1894 my $sth = $dbh->prepare($query);
1896 $item->{'biblionumber'},
1897 $item->{'biblioitemnumber'},
1899 $item->{'dateaccessioned'},
1900 $item->{'booksellerid'},
1901 $item->{'homebranch'},
1903 $item->{'replacementprice'},
1904 $item->{datelastborrowed},
1906 $item->{'notforloan'},
1908 $item->{'itemlost'},
1909 $item->{'wthdrawn'},
1910 $item->{'itemcallnumber'},
1911 $item->{'restricted'},
1912 $item->{'itemnotes'},
1913 $item->{'holdingbranch'},
1915 $item->{'location'},
1918 $item->{'renewals'},
1919 $item->{'reserves'},
1920 $item->{'items.cn_source'},
1921 $item->{'items.cn_sort'},
1924 $item->{'materials'},
1926 $item->{'enumchron'},
1927 $item->{'more_subfields_xml'},
1928 $item->{'copynumber'},
1930 my $itemnumber = $dbh->{'mysql_insertid'};
1931 if ( defined $sth->errstr ) {
1932 $error.="ERROR in _koha_new_item $query".$sth->errstr;
1934 return ( $itemnumber, $error );
1937 =head2 MoveItemFromBiblio
1939 MoveItemFromBiblio($itenumber, $frombiblio, $tobiblio);
1941 Moves an item from a biblio to another
1943 Returns undef if the move failed or the biblionumber of the destination record otherwise
1947 sub MoveItemFromBiblio {
1948 my ($itemnumber, $frombiblio, $tobiblio) = @_;
1949 my $dbh = C4::Context->dbh;
1950 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber = ?");
1951 $sth->execute( $tobiblio );
1952 my ( $tobiblioitem ) = $sth->fetchrow();
1953 $sth = $dbh->prepare("UPDATE items SET biblioitemnumber = ?, biblionumber = ? WHERE itemnumber = ? AND biblionumber = ?");
1954 my $return = $sth->execute($tobiblioitem, $tobiblio, $itemnumber, $frombiblio);
1958 my $frameworkcode = GetFrameworkCode($frombiblio);
1960 # Getting marc field for itemnumber
1961 my ($itemtag, $itemsubfield) = GetMarcFromKohaField('items.itemnumber', $frameworkcode);
1963 # Getting the record we want to move the item from
1964 my $record = GetMarcBiblio($frombiblio);
1966 # The item we want to move
1970 foreach my $fielditem ($record->field($itemtag)){
1971 # If it is the item we want to move
1972 if ($fielditem->subfield($itemsubfield) == $itemnumber) {
1975 # Then delete it from the record
1976 $record->delete_field($fielditem)
1980 # If we found an item (should always true, except in case of database-marcxml inconsistency)
1983 # Checking if the item we want to move is in an order
1984 my $order = GetOrderFromItemnumber($itemnumber);
1986 # Replacing the biblionumber within the order if necessary
1987 $order->{'biblionumber'} = $tobiblio;
1991 # Saving the modification
1992 ModBiblioMarc($record, $frombiblio, $frameworkcode);
1994 # Getting the record we want to move the item to
1995 $record = GetMarcBiblio($tobiblio);
1997 # Inserting the previously saved item
1998 $record->insert_fields_ordered($item);
2000 # Saving the modification
2001 ModBiblioMarc($record, $tobiblio, $frameworkcode);
2013 DelItemCheck($dbh, $biblionumber, $itemnumber);
2015 Exported function (core API) for deleting an item record in Koha if there no current issue.
2020 my ( $dbh, $biblionumber, $itemnumber ) = @_;
2023 # check that there is no issue on this item before deletion.
2024 my $sth=$dbh->prepare("select * from issues i where i.itemnumber=?");
2025 $sth->execute($itemnumber);
2027 my $onloan=$sth->fetchrow;
2030 $error = "book_on_loan"
2032 # check it doesnt have a waiting reserve
2033 $sth=$dbh->prepare("SELECT * FROM reserves WHERE (found = 'W' or found = 'T') AND itemnumber = ?");
2034 $sth->execute($itemnumber);
2035 my $reserve=$sth->fetchrow;
2037 $error = "book_reserved";
2039 DelItem($dbh, $biblionumber, $itemnumber);
2046 =head2 _koha_modify_item
2048 my ($itemnumber,$error) =_koha_modify_item( $item );
2050 Perform the actual update of the C<items> row. Note that this
2051 routine accepts a hashref specifying the columns to update.
2055 sub _koha_modify_item {
2057 my $dbh=C4::Context->dbh;
2060 my $query = "UPDATE items SET ";
2062 for my $key ( keys %$item ) {
2064 push @bind, $item->{$key};
2067 $query .= " WHERE itemnumber=?";
2068 push @bind, $item->{'itemnumber'};
2069 my $sth = C4::Context->dbh->prepare($query);
2070 $sth->execute(@bind);
2071 if ( C4::Context->dbh->errstr ) {
2072 $error.="ERROR in _koha_modify_item $query".$dbh->errstr;
2075 return ($item->{'itemnumber'},$error);
2078 =head2 _koha_delete_item
2080 _koha_delete_item( $dbh, $itemnum );
2082 Internal function to delete an item record from the koha tables
2086 sub _koha_delete_item {
2087 my ( $dbh, $itemnum ) = @_;
2089 # save the deleted item to deleteditems table
2090 my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
2091 $sth->execute($itemnum);
2092 my $data = $sth->fetchrow_hashref();
2093 my $query = "INSERT INTO deleteditems SET ";
2095 foreach my $key ( keys %$data ) {
2096 $query .= "$key = ?,";
2097 push( @bind, $data->{$key} );
2100 $sth = $dbh->prepare($query);
2101 $sth->execute(@bind);
2103 # delete from items table
2104 $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
2105 $sth->execute($itemnum);
2109 =head2 _marc_from_item_hash
2111 my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
2113 Given an item hash representing a complete item record,
2114 create a C<MARC::Record> object containing an embedded
2115 tag representing that item.
2117 The third, optional parameter C<$unlinked_item_subfields> is
2118 an arrayref of subfields (not mapped to C<items> fields per the
2119 framework) to be added to the MARC representation
2124 sub _marc_from_item_hash {
2126 my $frameworkcode = shift;
2127 my $unlinked_item_subfields;
2129 $unlinked_item_subfields = shift;
2132 # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
2133 # Also, don't emit a subfield if the underlying field is blank.
2134 my $mungeditem = { map { (defined($item->{$_}) and $item->{$_} ne '') ?
2135 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
2136 : () } keys %{ $item } };
2138 my $item_marc = MARC::Record->new();
2139 foreach my $item_field (keys %{ $mungeditem }) {
2140 my ($tag, $subfield) = GetMarcFromKohaField($item_field, $frameworkcode);
2141 next unless defined $tag and defined $subfield; # skip if not mapped to MARC field
2142 if (my $field = $item_marc->field($tag)) {
2143 $field->add_subfields($subfield => $mungeditem->{$item_field});
2145 my $add_subfields = [];
2146 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2147 $add_subfields = $unlinked_item_subfields;
2149 $item_marc->add_fields( $tag, " ", " ", $subfield => $mungeditem->{$item_field}, @$add_subfields);
2156 =head2 _add_item_field_to_biblio
2158 _add_item_field_to_biblio($item_marc, $biblionumber, $frameworkcode);
2160 Adds the fields from a MARC record containing the
2161 representation of a Koha item record to the MARC
2162 biblio record. The input C<$item_marc> record
2163 is expect to contain just one field, the embedded
2164 item information field.
2168 sub _add_item_field_to_biblio {
2169 my ($item_marc, $biblionumber, $frameworkcode) = @_;
2171 my $biblio_marc = GetMarcBiblio($biblionumber);
2172 foreach my $field ($item_marc->fields()) {
2173 $biblio_marc->append_fields($field);
2176 ModBiblioMarc($biblio_marc, $biblionumber, $frameworkcode);
2179 =head2 _replace_item_field_in_biblio
2181 &_replace_item_field_in_biblio($item_marc, $biblionumber, $itemnumber, $frameworkcode)
2183 Given a MARC::Record C<$item_marc> containing one tag with the MARC
2184 representation of the item, examine the biblio MARC
2185 for the corresponding tag for that item and
2186 replace it with the tag from C<$item_marc>.
2190 sub _replace_item_field_in_biblio {
2191 my ($ItemRecord, $biblionumber, $itemnumber, $frameworkcode) = @_;
2192 my $dbh = C4::Context->dbh;
2194 # get complete MARC record & replace the item field by the new one
2195 my $completeRecord = GetMarcBiblio($biblionumber);
2196 my ($itemtag,$itemsubfield) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
2197 my $itemField = $ItemRecord->field($itemtag);
2198 my @items = $completeRecord->field($itemtag);
2201 if ($_->subfield($itemsubfield) eq $itemnumber) {
2202 $_->replace_with($itemField);
2208 # If we haven't found the matching field,
2209 # just add it. However, this means that
2210 # there is likely a bug.
2211 $completeRecord->append_fields($itemField);
2215 ModBiblioMarc($completeRecord, $biblionumber, $frameworkcode);
2218 =head2 _repack_item_errors
2220 Add an error message hash generated by C<CheckItemPreSave>
2221 to a list of errors.
2225 sub _repack_item_errors {
2226 my $item_sequence_num = shift;
2227 my $item_ref = shift;
2228 my $error_ref = shift;
2230 my @repacked_errors = ();
2232 foreach my $error_code (sort keys %{ $error_ref }) {
2233 my $repacked_error = {};
2234 $repacked_error->{'item_sequence'} = $item_sequence_num;
2235 $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
2236 $repacked_error->{'error_code'} = $error_code;
2237 $repacked_error->{'error_information'} = $error_ref->{$error_code};
2238 push @repacked_errors, $repacked_error;
2241 return @repacked_errors;
2244 =head2 _get_unlinked_item_subfields
2246 my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
2250 sub _get_unlinked_item_subfields {
2251 my $original_item_marc = shift;
2252 my $frameworkcode = shift;
2254 my $marcstructure = GetMarcStructure(1, $frameworkcode);
2256 # assume that this record has only one field, and that that
2257 # field contains only the item information
2259 my @fields = $original_item_marc->fields();
2260 if ($#fields > -1) {
2261 my $field = $fields[0];
2262 my $tag = $field->tag();
2263 foreach my $subfield ($field->subfields()) {
2264 if (defined $subfield->[1] and
2265 $subfield->[1] ne '' and
2266 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
2267 push @$subfields, $subfield->[0] => $subfield->[1];
2274 =head2 _get_unlinked_subfields_xml
2276 my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
2280 sub _get_unlinked_subfields_xml {
2281 my $unlinked_item_subfields = shift;
2284 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2285 my $marc = MARC::Record->new();
2286 # use of tag 999 is arbitrary, and doesn't need to match the item tag
2287 # used in the framework
2288 $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
2289 $marc->encoding("UTF-8");
2290 $xml = $marc->as_xml("USMARC");
2296 =head2 _parse_unlinked_item_subfields_from_xml
2298 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2302 sub _parse_unlinked_item_subfields_from_xml {
2305 return unless defined $xml and $xml ne "";
2306 my $marc = MARC::Record->new_from_xml(StripNonXmlChars($xml),'UTF-8');
2307 my $unlinked_subfields = [];
2308 my @fields = $marc->fields();
2309 if ($#fields > -1) {
2310 foreach my $subfield ($fields[0]->subfields()) {
2311 push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2314 return $unlinked_subfields;