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 with
17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
18 # Suite 330, Boston, MA 02111-1307 USA
25 use C4::Dates qw/format_date format_date_in_iso/;
33 use vars qw($VERSION @ISA @EXPORT);
39 @ISA = qw( Exporter );
62 GetItemsByBiblioitemnumber
65 GetItemnumberFromBarcode
71 C4::Items - item management functions
75 This module contains an API for manipulating item
76 records in Koha, and is used by cataloguing, circulation,
77 acquisitions, and serials management.
79 A Koha item record is stored in two places: the
80 items table and embedded in a MARC tag in the XML
81 version of the associated bib record in C<biblioitems.marcxml>.
82 This is done to allow the item information to be readily
83 indexed (e.g., by Zebra), but means that each item
84 modification transaction must keep the items table
85 and the MARC XML in sync at all times.
87 Consequently, all code that creates, modifies, or deletes
88 item records B<must> use an appropriate function from
89 C<C4::Items>. If no existing function is suitable, it is
90 better to add one to C<C4::Items> than to use add
91 one-off SQL statements to add or modify items.
93 The items table will be considered authoritative. In other
94 words, if there is ever a discrepancy between the items
95 table and the MARC XML, the items table should be considered
98 =head1 HISTORICAL NOTE
100 Most of the functions in C<C4::Items> were originally in
101 the C<C4::Biblio> module.
103 =head1 CORE EXPORTED FUNCTIONS
105 The following functions are meant for use by users
114 $item = GetItem($itemnumber,$barcode,$serial);
118 Return item information, for a given itemnumber or barcode.
119 The return value is a hashref mapping item column
120 names to values. If C<$serial> is true, include serial publication data.
125 my ($itemnumber,$barcode, $serial) = @_;
126 my $dbh = C4::Context->dbh;
129 my $sth = $dbh->prepare("
131 WHERE itemnumber = ?");
132 $sth->execute($itemnumber);
133 $data = $sth->fetchrow_hashref;
135 my $sth = $dbh->prepare("
139 $sth->execute($barcode);
140 $data = $sth->fetchrow_hashref;
143 my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=?");
144 $ssth->execute($data->{'itemnumber'}) ;
145 ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
146 warn $data->{'serialseq'} , $data->{'publisheddate'};
148 #if we don't have an items.itype, use biblioitems.itemtype.
149 if( ! $data->{'itype'} ) {
150 my $sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
151 $sth->execute($data->{'biblionumber'});
152 ($data->{'itype'}) = $sth->fetchrow_array;
157 =head2 AddItemFromMarc
161 my ($biblionumber, $biblioitemnumber, $itemnumber)
162 = AddItemFromMarc($source_item_marc, $biblionumber);
166 Given a MARC::Record object containing an embedded item
167 record and a biblionumber, create a new item record.
171 sub AddItemFromMarc {
172 my ( $source_item_marc, $biblionumber ) = @_;
173 my $dbh = C4::Context->dbh;
175 # parse item hash from MARC
176 my $frameworkcode = GetFrameworkCode( $biblionumber );
177 my $item = &TransformMarcToKoha( $dbh, $source_item_marc, $frameworkcode );
178 my $unlinked_item_subfields = _get_unlinked_item_subfields($source_item_marc, $frameworkcode);
179 return AddItem($item, $biblionumber, $dbh, $frameworkcode, $unlinked_item_subfields);
186 my ($biblionumber, $biblioitemnumber, $itemnumber)
187 = AddItem($item, $biblionumber[, $dbh, $frameworkcode, $unlinked_item_subfields]);
191 Given a hash containing item column names as keys,
192 create a new Koha item record.
194 The first two optional parameters (C<$dbh> and C<$frameworkcode>)
195 do not need to be supplied for general use; they exist
196 simply to allow them to be picked up from AddItemFromMarc.
198 The final optional parameter, C<$unlinked_item_subfields>, contains
199 an arrayref containing subfields present in the original MARC
200 representation of the item (e.g., from the item editor) that are
201 not mapped to C<items> columns directly but should instead
202 be stored in C<items.more_subfields_xml> and included in
203 the biblio items tag for display and indexing.
209 my $biblionumber = shift;
211 my $dbh = @_ ? shift : C4::Context->dbh;
212 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
213 my $unlinked_item_subfields;
215 $unlinked_item_subfields = shift
218 # needs old biblionumber and biblioitemnumber
219 $item->{'biblionumber'} = $biblionumber;
220 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
221 $sth->execute( $item->{'biblionumber'} );
222 ($item->{'biblioitemnumber'}) = $sth->fetchrow;
224 _set_defaults_for_add($item);
225 _set_derived_columns_for_add($item);
226 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
227 # FIXME - checks here
228 unless ( $item->{itype} ) { # default to biblioitem.itemtype if no itype
229 my $itype_sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
230 $itype_sth->execute( $item->{'biblionumber'} );
231 ( $item->{'itype'} ) = $itype_sth->fetchrow_array;
234 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
235 $item->{'itemnumber'} = $itemnumber;
237 # create MARC tag representing item and add to bib
238 my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
239 _add_item_field_to_biblio($new_item_marc, $item->{'biblionumber'}, $frameworkcode );
241 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
243 return ($item->{biblionumber}, $item->{biblioitemnumber}, $itemnumber);
246 =head2 AddItemBatchFromMarc
250 ($itemnumber_ref, $error_ref) = AddItemBatchFromMarc($record, $biblionumber, $biblioitemnumber, $frameworkcode);
254 Efficiently create item records from a MARC biblio record with
255 embedded item fields. This routine is suitable for batch jobs.
257 This API assumes that the bib record has already been
258 saved to the C<biblio> and C<biblioitems> tables. It does
259 not expect that C<biblioitems.marc> and C<biblioitems.marcxml>
260 are populated, but it will do so via a call to ModBibiloMarc.
262 The goal of this API is to have a similar effect to using AddBiblio
263 and AddItems in succession, but without inefficient repeated
264 parsing of the MARC XML bib record.
266 This function returns an arrayref of new itemsnumbers and an arrayref of item
267 errors encountered during the processing. Each entry in the errors
268 list is a hashref containing the following keys:
274 Sequence number of original item tag in the MARC record.
278 Item barcode, provide to assist in the construction of
279 useful error messages.
281 =item error_condition
283 Code representing the error condition. Can be 'duplicate_barcode',
284 'invalid_homebranch', or 'invalid_holdingbranch'.
286 =item error_information
288 Additional information appropriate to the error condition.
294 sub AddItemBatchFromMarc {
295 my ($record, $biblionumber, $biblioitemnumber, $frameworkcode) = @_;
297 my @itemnumbers = ();
299 my $dbh = C4::Context->dbh;
301 # loop through the item tags and start creating items
302 my @bad_item_fields = ();
303 my ($itemtag, $itemsubfield) = &GetMarcFromKohaField("items.itemnumber",'');
304 my $item_sequence_num = 0;
305 ITEMFIELD: foreach my $item_field ($record->field($itemtag)) {
306 $item_sequence_num++;
307 # we take the item field and stick it into a new
308 # MARC record -- this is required so far because (FIXME)
309 # TransformMarcToKoha requires a MARC::Record, not a MARC::Field
310 # and there is no TransformMarcFieldToKoha
311 my $temp_item_marc = MARC::Record->new();
312 $temp_item_marc->append_fields($item_field);
314 # add biblionumber and biblioitemnumber
315 my $item = TransformMarcToKoha( $dbh, $temp_item_marc, $frameworkcode, 'items' );
316 my $unlinked_item_subfields = _get_unlinked_item_subfields($temp_item_marc, $frameworkcode);
317 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
318 $item->{'biblionumber'} = $biblionumber;
319 $item->{'biblioitemnumber'} = $biblioitemnumber;
321 # check for duplicate barcode
322 my %item_errors = CheckItemPreSave($item);
324 push @errors, _repack_item_errors($item_sequence_num, $item, \%item_errors);
325 push @bad_item_fields, $item_field;
329 _set_defaults_for_add($item);
330 _set_derived_columns_for_add($item);
331 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
332 warn $error if $error;
333 push @itemnumbers, $itemnumber; # FIXME not checking error
334 $item->{'itemnumber'} = $itemnumber;
336 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
338 my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
339 $item_field->replace_with($new_item_marc->field($itemtag));
342 # remove any MARC item fields for rejected items
343 foreach my $item_field (@bad_item_fields) {
344 $record->delete_field($item_field);
347 # update the MARC biblio
348 $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode );
350 return (\@itemnumbers, \@errors);
353 =head2 ModItemFromMarc
357 ModItemFromMarc($item_marc, $biblionumber, $itemnumber);
361 This function updates an item record based on a supplied
362 C<MARC::Record> object containing an embedded item field.
363 This API is meant for the use of C<additem.pl>; for
364 other purposes, C<ModItem> should be used.
366 This function uses the hash %default_values_for_mod_from_marc,
367 which contains default values for item fields to
368 apply when modifying an item. This is needed beccause
369 if an item field's value is cleared, TransformMarcToKoha
370 does not include the column in the
371 hash that's passed to ModItem, which without
372 use of this hash makes it impossible to clear
373 an item field's value. See bug 2466.
375 Note that only columns that can be directly
376 changed from the cataloging and serials
377 item editors are included in this hash.
381 my %default_values_for_mod_from_marc = (
383 booksellerid => undef,
385 'items.cn_source' => undef,
388 dateaccessioned => undef,
390 holdingbranch => undef,
392 itemcallnumber => undef,
401 replacementprice => undef,
402 replacementpricedate => undef,
409 sub ModItemFromMarc {
410 my $item_marc = shift;
411 my $biblionumber = shift;
412 my $itemnumber = shift;
414 my $dbh = C4::Context->dbh;
415 my $frameworkcode = GetFrameworkCode( $biblionumber );
416 my $item = &TransformMarcToKoha( $dbh, $item_marc, $frameworkcode );
417 foreach my $item_field (keys %default_values_for_mod_from_marc) {
418 $item->{$item_field} = $default_values_for_mod_from_marc{$item_field} unless exists $item->{$item_field};
420 my $unlinked_item_subfields = _get_unlinked_item_subfields($item_marc, $frameworkcode);
422 return ModItem($item, $biblionumber, $itemnumber, $dbh, $frameworkcode, $unlinked_item_subfields);
429 ModItem({ column => $newvalue }, $biblionumber, $itemnumber[, $original_item_marc]);
433 Change one or more columns in an item record and update
434 the MARC representation of the item.
436 The first argument is a hashref mapping from item column
437 names to the new values. The second and third arguments
438 are the biblionumber and itemnumber, respectively.
440 The fourth, optional parameter, C<$unlinked_item_subfields>, contains
441 an arrayref containing subfields present in the original MARC
442 representation of the item (e.g., from the item editor) that are
443 not mapped to C<items> columns directly but should instead
444 be stored in C<items.more_subfields_xml> and included in
445 the biblio items tag for display and indexing.
447 If one of the changed columns is used to calculate
448 the derived value of a column such as C<items.cn_sort>,
449 this routine will perform the necessary calculation
456 my $biblionumber = shift;
457 my $itemnumber = shift;
459 # if $biblionumber is undefined, get it from the current item
460 unless (defined $biblionumber) {
461 $biblionumber = _get_single_item_column('biblionumber', $itemnumber);
464 my $dbh = @_ ? shift : C4::Context->dbh;
465 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
467 my $unlinked_item_subfields;
469 $unlinked_item_subfields = shift;
470 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
473 $item->{'itemnumber'} = $itemnumber or return undef;
474 _set_derived_columns_for_mod($item);
475 _do_column_fixes_for_mod($item);
478 # attempt to change itemnumber
479 # attempt to change biblionumber (if we want
480 # an API to relink an item to a different bib,
481 # it should be a separate function)
484 _koha_modify_item($item);
486 # update biblio MARC XML
487 my $whole_item = GetItem($itemnumber) or die "FAILED GetItem($itemnumber)";
489 unless (defined $unlinked_item_subfields) {
490 $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'});
492 my $new_item_marc = _marc_from_item_hash($whole_item, $frameworkcode, $unlinked_item_subfields)
493 or die "FAILED _marc_from_item_hash($whole_item, $frameworkcode)";
495 _replace_item_field_in_biblio($new_item_marc, $biblionumber, $itemnumber, $frameworkcode);
496 ($new_item_marc eq '0') and die "$new_item_marc is '0', not hashref"; # logaction line would crash anyway
497 logaction("CATALOGUING", "MODIFY", $itemnumber, $new_item_marc->as_formatted) if C4::Context->preference("CataloguingLog");
500 =head2 ModItemTransfer
504 ModItemTransfer($itenumber, $frombranch, $tobranch);
508 Marks an item as being transferred from one branch
513 sub ModItemTransfer {
514 my ( $itemnumber, $frombranch, $tobranch ) = @_;
516 my $dbh = C4::Context->dbh;
518 #new entry in branchtransfers....
519 my $sth = $dbh->prepare(
520 "INSERT INTO branchtransfers (itemnumber, frombranch, datesent, tobranch)
521 VALUES (?, ?, NOW(), ?)");
522 $sth->execute($itemnumber, $frombranch, $tobranch);
524 ModItem({ holdingbranch => $tobranch }, undef, $itemnumber);
525 ModDateLastSeen($itemnumber);
529 =head2 ModDateLastSeen
533 ModDateLastSeen($itemnum);
537 Mark item as seen. Is called when an item is issued, returned or manually marked during inventory/stocktaking.
538 C<$itemnum> is the item number
542 sub ModDateLastSeen {
543 my ($itemnumber) = @_;
545 my $today = C4::Dates->new();
546 ModItem({ itemlost => 0, datelastseen => $today->output("iso") }, undef, $itemnumber);
553 DelItem($biblionumber, $itemnumber);
557 Exported function (core API) for deleting an item record in Koha.
562 my ( $dbh, $biblionumber, $itemnumber ) = @_;
564 # FIXME check the item has no current issues
566 _koha_delete_item( $dbh, $itemnumber );
568 # get the MARC record
569 my $record = GetMarcBiblio($biblionumber);
570 my $frameworkcode = GetFrameworkCode($biblionumber);
573 my $copy2deleted = $dbh->prepare("UPDATE deleteditems SET marc=? WHERE itemnumber=?");
574 $copy2deleted->execute( $record->as_usmarc(), $itemnumber );
576 #search item field code
577 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
578 my @fields = $record->field($itemtag);
580 # delete the item specified
581 foreach my $field (@fields) {
582 if ( $field->subfield($itemsubfield) eq $itemnumber ) {
583 $record->delete_field($field);
586 &ModBiblioMarc( $record, $biblionumber, $frameworkcode );
587 logaction("CATALOGUING", "DELETE", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
594 DelItemCheck($dbh, $biblionumber, $itemnumber);
598 Exported function (core API) for deleting an item record in Koha if there no current issue.
603 my ( $dbh, $biblionumber, $itemnumber ) = @_;
606 # check that there is no issue on this item before deletion.
607 my $sth=$dbh->prepare("select * from issues i where i.itemnumber=?");
608 $sth->execute($itemnumber);
610 my $onloan=$sth->fetchrow;
614 $error = "book_on_loan"
616 # check it doesnt have a waiting reserve
617 $sth=$dbh->prepare("SELECT * FROM reserves WHERE found = 'W' AND itemnumber = ?");
618 $sth->execute($itemnumber);
619 my $reserve=$sth->fetchrow;
622 $error = "book_reserved";
624 DelItem($dbh, $biblionumber, $itemnumber);
631 =head2 CheckItemPreSave
635 my $item_ref = TransformMarcToKoha($marc, 'items');
637 my %errors = CheckItemPreSave($item_ref);
638 if (exists $errors{'duplicate_barcode'}) {
639 print "item has duplicate barcode: ", $errors{'duplicate_barcode'}, "\n";
640 } elsif (exists $errors{'invalid_homebranch'}) {
641 print "item has invalid home branch: ", $errors{'invalid_homebranch'}, "\n";
642 } elsif (exists $errors{'invalid_holdingbranch'}) {
643 print "item has invalid holding branch: ", $errors{'invalid_holdingbranch'}, "\n";
650 Given a hashref containing item fields, determine if it can be
651 inserted or updated in the database. Specifically, checks for
652 database integrity issues, and returns a hash containing any
653 of the following keys, if applicable.
657 =item duplicate_barcode
659 Barcode, if it duplicates one already found in the database.
661 =item invalid_homebranch
663 Home branch, if not defined in branches table.
665 =item invalid_holdingbranch
667 Holding branch, if not defined in branches table.
671 This function does NOT implement any policy-related checks,
672 e.g., whether current operator is allowed to save an
673 item that has a given branch code.
677 sub CheckItemPreSave {
678 my $item_ref = shift;
682 # check for duplicate barcode
683 if (exists $item_ref->{'barcode'} and defined $item_ref->{'barcode'}) {
684 my $existing_itemnumber = GetItemnumberFromBarcode($item_ref->{'barcode'});
685 if ($existing_itemnumber) {
686 if (!exists $item_ref->{'itemnumber'} # new item
687 or $item_ref->{'itemnumber'} != $existing_itemnumber) { # existing item
688 $errors{'duplicate_barcode'} = $item_ref->{'barcode'};
693 # check for valid home branch
694 if (exists $item_ref->{'homebranch'} and defined $item_ref->{'homebranch'}) {
695 my $branch_name = GetBranchName($item_ref->{'homebranch'});
696 unless (defined $branch_name) {
697 # relies on fact that branches.branchname is a non-NULL column,
698 # so GetBranchName returns undef only if branch does not exist
699 $errors{'invalid_homebranch'} = $item_ref->{'homebranch'};
703 # check for valid holding branch
704 if (exists $item_ref->{'holdingbranch'} and defined $item_ref->{'holdingbranch'}) {
705 my $branch_name = GetBranchName($item_ref->{'holdingbranch'});
706 unless (defined $branch_name) {
707 # relies on fact that branches.branchname is a non-NULL column,
708 # so GetBranchName returns undef only if branch does not exist
709 $errors{'invalid_holdingbranch'} = $item_ref->{'holdingbranch'};
717 =head1 EXPORTED SPECIAL ACCESSOR FUNCTIONS
719 The following functions provide various ways of
720 getting an item record, a set of item records, or
721 lists of authorized values for certain item fields.
723 Some of the functions in this group are candidates
724 for refactoring -- for example, some of the code
725 in C<GetItemsByBiblioitemnumber> and C<GetItemsInfo>
726 has copy-and-paste work.
734 $itemstatushash = GetItemStatus($fwkcode);
738 Returns a list of valid values for the
739 C<items.notforloan> field.
741 NOTE: does B<not> return an individual item's
744 Can be MARC dependant.
746 But basically could be can be loan or not
747 Create a status selector with the following code
749 =head3 in PERL SCRIPT
753 my $itemstatushash = getitemstatus;
755 foreach my $thisstatus (keys %$itemstatushash) {
756 my %row =(value => $thisstatus,
757 statusname => $itemstatushash->{$thisstatus}->{'statusname'},
759 push @itemstatusloop, \%row;
761 $template->param(statusloop=>\@itemstatusloop);
769 <select name="statusloop">
770 <option value="">Default</option>
771 <!-- TMPL_LOOP name="statusloop" -->
772 <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="statusname" --></option>
782 # returns a reference to a hash of references to status...
785 my $dbh = C4::Context->dbh;
787 $fwk = '' unless ($fwk);
788 my ( $tag, $subfield ) =
789 GetMarcFromKohaField( "items.notforloan", $fwk );
790 if ( $tag and $subfield ) {
793 "SELECT authorised_value
794 FROM marc_subfield_structure
800 $sth->execute( $tag, $subfield, $fwk );
801 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
804 "SELECT authorised_value,lib
805 FROM authorised_values
810 $authvalsth->execute($authorisedvaluecat);
811 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
812 $itemstatus{$authorisedvalue} = $lib;
828 $itemstatus{"1"} = "Not For Loan";
832 =head2 GetItemLocation
836 $itemlochash = GetItemLocation($fwk);
840 Returns a list of valid values for the
841 C<items.location> field.
843 NOTE: does B<not> return an individual item's
846 where fwk stands for an optional framework code.
847 Create a location selector with the following code
849 =head3 in PERL SCRIPT
853 my $itemlochash = getitemlocation;
855 foreach my $thisloc (keys %$itemlochash) {
856 my $selected = 1 if $thisbranch eq $branch;
857 my %row =(locval => $thisloc,
858 selected => $selected,
859 locname => $itemlochash->{$thisloc},
861 push @itemlocloop, \%row;
863 $template->param(itemlocationloop => \@itemlocloop);
871 <select name="location">
872 <option value="">Default</option>
873 <!-- TMPL_LOOP name="itemlocationloop" -->
874 <option value="<!-- TMPL_VAR name="locval" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="locname" --></option>
882 sub GetItemLocation {
884 # returns a reference to a hash of references to location...
887 my $dbh = C4::Context->dbh;
889 $fwk = '' unless ($fwk);
890 my ( $tag, $subfield ) =
891 GetMarcFromKohaField( "items.location", $fwk );
892 if ( $tag and $subfield ) {
895 "SELECT authorised_value
896 FROM marc_subfield_structure
901 $sth->execute( $tag, $subfield, $fwk );
902 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
905 "SELECT authorised_value,lib
906 FROM authorised_values
910 $authvalsth->execute($authorisedvaluecat);
911 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
912 $itemlocation{$authorisedvalue} = $lib;
915 return \%itemlocation;
928 $itemlocation{"1"} = "Not For Loan";
929 return \%itemlocation;
936 $items = GetLostItems( $where, $orderby );
940 This function gets a list of lost items.
946 C<$where> is a hashref. it containts a field of the items table as key
947 and the value to match as value. For example:
949 { barcode => 'abc123',
950 homebranch => 'CPL', }
952 C<$orderby> is a field of the items table by which the resultset
957 C<$items> is a reference to an array full of hashrefs with columns
958 from the "items" table as keys.
960 =item usage in the perl script:
962 my $where = { barcode => '0001548' };
963 my $items = GetLostItems( $where, "homebranch" );
964 $template->param( itemsloop => $items );
971 # Getting input args.
974 my $dbh = C4::Context->dbh;
979 LEFT JOIN biblio ON (items.biblionumber = biblio.biblionumber)
980 LEFT JOIN biblioitems ON (items.biblionumber = biblioitems.biblionumber)
981 LEFT JOIN authorised_values ON (items.itemlost = authorised_values.authorised_value)
983 authorised_values.category = 'LOST'
984 AND itemlost IS NOT NULL
987 my @query_parameters;
988 foreach my $key (keys %$where) {
989 $query .= " AND $key LIKE ?";
990 push @query_parameters, "%$where->{$key}%";
992 my @ordervalues = qw/title author homebranch itype barcode price replacementprice lib datelastseen location/;
994 if ( defined $orderby && grep($orderby, @ordervalues)) {
995 $query .= ' ORDER BY '.$orderby;
998 my $sth = $dbh->prepare($query);
999 $sth->execute( @query_parameters );
1001 while ( my $row = $sth->fetchrow_hashref ){
1007 =head2 GetItemsForInventory
1011 $itemlist = GetItemsForInventory($minlocation, $maxlocation, $location, $itemtype $datelastseen, $branch, $offset, $size);
1015 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
1017 The sub returns a reference to a list of hashes, each containing
1018 itemnumber, author, title, barcode, item callnumber, and date last
1019 seen. It is ordered by callnumber then title.
1021 The required minlocation & maxlocation parameters are used to specify a range of item callnumbers
1022 the datelastseen can be used to specify that you want to see items not seen since a past date only.
1023 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
1027 sub GetItemsForInventory {
1028 my ( $minlocation, $maxlocation,$location, $itemtype, $ignoreissued, $datelastseen, $branch, $offset, $size ) = @_;
1029 my $dbh = C4::Context->dbh;
1030 my ( @bind_params, @where_strings );
1032 my $query = <<'END_SQL';
1033 SELECT items.itemnumber, barcode, itemcallnumber, title, author, biblio.biblionumber, datelastseen
1035 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
1036 LEFT JOIN biblioitems on items.biblionumber = biblioitems.biblionumber
1040 push @where_strings, 'itemcallnumber >= ?';
1041 push @bind_params, $minlocation;
1045 push @where_strings, 'itemcallnumber <= ?';
1046 push @bind_params, $maxlocation;
1049 if ($datelastseen) {
1050 $datelastseen = format_date_in_iso($datelastseen);
1051 push @where_strings, '(datelastseen < ? OR datelastseen IS NULL)';
1052 push @bind_params, $datelastseen;
1056 push @where_strings, 'items.location = ?';
1057 push @bind_params, $location;
1061 push @where_strings, 'items.homebranch = ?';
1062 push @bind_params, $branch;
1066 push @where_strings, 'biblioitems.itemtype = ?';
1067 push @bind_params, $itemtype;
1069 if ( $ignoreissued) {
1070 $query .= "LEFT JOIN issues ON items.itemnumber = issues.itemnumber ";
1071 push @where_strings, 'issues.date_due IS NULL';
1074 if ( @where_strings ) {
1076 $query .= join ' AND ', @where_strings;
1078 $query .= ' ORDER BY itemcallnumber, title';
1079 my $sth = $dbh->prepare($query);
1080 $sth->execute( @bind_params );
1084 while ( my $row = $sth->fetchrow_hashref ) {
1085 $offset-- if ($offset);
1086 $row->{datelastseen}=format_date($row->{datelastseen});
1087 if ( ( !$offset ) && $size ) {
1088 push @results, $row;
1095 =head2 GetItemsCount
1098 $count = &GetItemsCount( $biblionumber);
1102 This function return count of item with $biblionumber
1107 my ( $biblionumber ) = @_;
1108 my $dbh = C4::Context->dbh;
1109 my $query = "SELECT count(*)
1111 WHERE biblionumber=?";
1112 my $sth = $dbh->prepare($query);
1113 $sth->execute($biblionumber);
1114 my $count = $sth->fetchrow;
1119 =head2 GetItemInfosOf
1123 GetItemInfosOf(@itemnumbers);
1129 sub GetItemInfosOf {
1130 my @itemnumbers = @_;
1135 WHERE itemnumber IN (' . join( ',', @itemnumbers ) . ')
1137 return get_infos_of( $query, 'itemnumber' );
1140 =head2 GetItemsByBiblioitemnumber
1144 GetItemsByBiblioitemnumber($biblioitemnumber);
1148 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1149 Called by C<C4::XISBN>
1153 sub GetItemsByBiblioitemnumber {
1154 my ( $bibitem ) = @_;
1155 my $dbh = C4::Context->dbh;
1156 my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1157 # Get all items attached to a biblioitem
1160 $sth->execute($bibitem) || die $sth->errstr;
1161 while ( my $data = $sth->fetchrow_hashref ) {
1162 # Foreach item, get circulation information
1163 my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1164 WHERE itemnumber = ?
1165 AND issues.borrowernumber = borrowers.borrowernumber"
1167 $sth2->execute( $data->{'itemnumber'} );
1168 if ( my $data2 = $sth2->fetchrow_hashref ) {
1169 # if item is out, set the due date and who it is out too
1170 $data->{'date_due'} = $data2->{'date_due'};
1171 $data->{'cardnumber'} = $data2->{'cardnumber'};
1172 $data->{'borrowernumber'} = $data2->{'borrowernumber'};
1175 # set date_due to blank, so in the template we check itemlost, and wthdrawn
1176 $data->{'date_due'} = '';
1179 # Find the last 3 people who borrowed this item.
1180 my $query2 = "SELECT * FROM old_issues, borrowers WHERE itemnumber = ?
1181 AND old_issues.borrowernumber = borrowers.borrowernumber
1182 ORDER BY returndate desc,timestamp desc LIMIT 3";
1183 $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1184 $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1186 while ( my $data2 = $sth2->fetchrow_hashref ) {
1187 $data->{"timestamp$i2"} = $data2->{'timestamp'};
1188 $data->{"card$i2"} = $data2->{'cardnumber'};
1189 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
1193 push(@results,$data);
1203 @results = GetItemsInfo($biblionumber, $type);
1207 Returns information about books with the given biblionumber.
1209 C<$type> may be either C<intra> or anything else. If it is not set to
1210 C<intra>, then the search will exclude lost, very overdue, and
1213 C<GetItemsInfo> returns a list of references-to-hash. Each element
1214 contains a number of keys. Most of them are table items from the
1215 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
1216 Koha database. Other keys include:
1220 =item C<$data-E<gt>{branchname}>
1222 The name (not the code) of the branch to which the book belongs.
1224 =item C<$data-E<gt>{datelastseen}>
1226 This is simply C<items.datelastseen>, except that while the date is
1227 stored in YYYY-MM-DD format in the database, here it is converted to
1228 DD/MM/YYYY format. A NULL date is returned as C<//>.
1230 =item C<$data-E<gt>{datedue}>
1232 =item C<$data-E<gt>{class}>
1234 This is the concatenation of C<biblioitems.classification>, the book's
1235 Dewey code, and C<biblioitems.subclass>.
1237 =item C<$data-E<gt>{ocount}>
1239 I think this is the number of copies of the book available.
1241 =item C<$data-E<gt>{order}>
1243 If this is set, it is set to C<One Order>.
1250 my ( $biblionumber, $type ) = @_;
1251 my $dbh = C4::Context->dbh;
1252 # note biblioitems.* must be avoided to prevent large marc and marcxml fields from killing performance.
1258 biblioitems.itemtype,
1261 biblioitems.publicationyear,
1262 biblioitems.publishercode,
1263 biblioitems.volumedate,
1264 biblioitems.volumedesc,
1267 items.notforloan as itemnotforloan,
1268 itemtypes.description
1270 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1271 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1272 LEFT JOIN itemtypes ON itemtypes.itemtype = "
1273 . (C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype');
1274 $query .= " WHERE items.biblionumber = ? ORDER BY items.dateaccessioned desc" ;
1275 my $sth = $dbh->prepare($query);
1276 $sth->execute($biblionumber);
1281 my $isth = $dbh->prepare(
1282 "SELECT issues.*,borrowers.cardnumber,borrowers.surname,borrowers.firstname,borrowers.branchcode as bcode
1283 FROM issues LEFT JOIN borrowers ON issues.borrowernumber=borrowers.borrowernumber
1284 WHERE itemnumber = ?"
1286 my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=? ");
1287 while ( my $data = $sth->fetchrow_hashref ) {
1290 $isth->execute( $data->{'itemnumber'} );
1291 if ( my $idata = $isth->fetchrow_hashref ) {
1293 if (C4::Context->preference("IndependantBranches")){
1294 my $userenv = C4::Context->userenv;
1295 if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
1296 $data->{'NOTSAMEBRANCH'} = 1 if ($idata->{'bcode'} ne $userenv->{branch});
1300 if ( $data->{'serial'}) {
1301 $ssth->execute($data->{'itemnumber'}) ;
1302 ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
1305 if ( $datedue eq '' ) {
1306 my ( $restype, $reserves ) =
1307 C4::Reserves::CheckReserves( $data->{'itemnumber'} );
1308 # Previous conditional check with if ($restype) is not needed because a true
1309 # result for one item will result in subsequent items defaulting to this true
1311 $count_reserves = $restype;
1315 #get branch information.....
1316 my $bsth = $dbh->prepare(
1317 "SELECT * FROM branches WHERE branchcode = ?
1320 $bsth->execute( $data->{'holdingbranch'} );
1321 if ( my $bdata = $bsth->fetchrow_hashref ) {
1322 $data->{'branchname'} = $bdata->{'branchname'};
1324 $data->{'datedue'} = $datedue;
1325 $data->{'count_reserves'} = $count_reserves;
1327 # get notforloan complete status if applicable
1328 my $sthnflstatus = $dbh->prepare(
1329 'SELECT authorised_value
1330 FROM marc_subfield_structure
1331 WHERE kohafield="items.notforloan"
1335 $sthnflstatus->execute;
1336 my ($authorised_valuecode) = $sthnflstatus->fetchrow;
1337 if ($authorised_valuecode) {
1338 $sthnflstatus = $dbh->prepare(
1339 "SELECT lib FROM authorised_values
1341 AND authorised_value=?"
1343 $sthnflstatus->execute( $authorised_valuecode,
1344 $data->{itemnotforloan} );
1345 my ($lib) = $sthnflstatus->fetchrow;
1346 $data->{notforloanvalue} = $lib;
1348 $data->{itypenotforloan} = $data->{notforloan} if (C4::Context->preference('item-level_itypes'));
1350 # my stack procedures
1351 my $stackstatus = $dbh->prepare(
1352 'SELECT authorised_value
1353 FROM marc_subfield_structure
1354 WHERE kohafield="items.stack"
1357 $stackstatus->execute;
1359 ($authorised_valuecode) = $stackstatus->fetchrow;
1360 if ($authorised_valuecode) {
1361 $stackstatus = $dbh->prepare(
1363 FROM authorised_values
1365 AND authorised_value=?
1368 $stackstatus->execute( $authorised_valuecode, $data->{stack} );
1369 my ($lib) = $stackstatus->fetchrow;
1370 $data->{stack} = $lib;
1372 # Find the last 3 people who borrowed this item.
1373 my $sth2 = $dbh->prepare("SELECT * FROM old_issues,borrowers
1374 WHERE itemnumber = ?
1375 AND old_issues.borrowernumber = borrowers.borrowernumber
1376 ORDER BY returndate DESC
1378 $sth2->execute($data->{'itemnumber'});
1380 while (my $data2 = $sth2->fetchrow_hashref()) {
1381 $data->{"timestamp$ii"} = $data2->{'timestamp'} if $data2->{'timestamp'};
1382 $data->{"card$ii"} = $data2->{'cardnumber'} if $data2->{'cardnumber'};
1383 $data->{"borrower$ii"} = $data2->{'borrowernumber'} if $data2->{'borrowernumber'};
1387 $results[$i] = $data;
1391 return( sort { ($b->{'publisheddate'} || $b->{'enumchron'}) cmp ($a->{'publisheddate'} || $a->{'enumchron'}) } @results );
1397 =head2 get_itemnumbers_of
1401 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1405 Given a list of biblionumbers, return the list of corresponding itemnumbers
1406 for each biblionumber.
1408 Return a reference on a hash where keys are biblionumbers and values are
1409 references on array of itemnumbers.
1413 sub get_itemnumbers_of {
1414 my @biblionumbers = @_;
1416 my $dbh = C4::Context->dbh;
1422 WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1424 my $sth = $dbh->prepare($query);
1425 $sth->execute(@biblionumbers);
1429 while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1430 push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1433 return \%itemnumbers_of;
1436 =head2 GetItemnumberFromBarcode
1440 $result = GetItemnumberFromBarcode($barcode);
1446 sub GetItemnumberFromBarcode {
1448 my $dbh = C4::Context->dbh;
1451 $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1452 $rq->execute($barcode);
1453 my ($result) = $rq->fetchrow;
1457 =head3 get_item_authorised_values
1459 find the types and values for all authorised values assigned to this item.
1464 returns: a hashref malling the authorised value to the value set for this itemnumber
1466 $authorised_values = {
1472 'RESTRICTED' => undef,
1475 'branches' => 'CPL',
1476 'cn_source' => undef,
1477 'itemtypes' => 'SER',
1480 Notes: see C4::Biblio::get_biblio_authorised_values for a similar method at the biblio level.
1484 sub get_item_authorised_values {
1485 my $itemnumber = shift;
1487 # assume that these entries in the authorised_value table are item level.
1488 my $query = q(SELECT distinct authorised_value, kohafield
1489 FROM marc_subfield_structure
1490 WHERE kohafield like 'item%'
1491 AND authorised_value != '' );
1493 my $itemlevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
1494 my $iteminfo = GetItem( $itemnumber );
1495 # warn( Data::Dumper->Dump( [ $itemlevel_authorised_values ], [ 'itemlevel_authorised_values' ] ) );
1497 foreach my $this_authorised_value ( keys %$itemlevel_authorised_values ) {
1498 my $field = $itemlevel_authorised_values->{ $this_authorised_value }->{'kohafield'};
1499 $field =~ s/^items\.//;
1500 if ( exists $iteminfo->{ $field } ) {
1501 $return->{ $this_authorised_value } = $iteminfo->{ $field };
1504 # warn( Data::Dumper->Dump( [ $return ], [ 'return' ] ) );
1508 =head3 get_authorised_value_images
1510 find a list of icons that are appropriate for display based on the
1511 authorised values for a biblio.
1513 parameters: listref of authorised values, such as comes from
1514 get_item_ahtorised_values or
1515 from C4::Biblio::get_biblio_authorised_values
1517 returns: listref of hashrefs for each image. Each hashref looks like
1520 { imageurl => '/intranet-tmpl/prog/img/itemtypeimg/npl/WEB.gif',
1525 Notes: Currently, I put on the full path to the images on the staff
1526 side. This should either be configurable or not done at all. Since I
1527 have to deal with 'intranet' or 'opac' in
1528 get_biblio_authorised_values, perhaps I should be passing it in.
1532 sub get_authorised_value_images {
1533 my $authorised_values = shift;
1537 my $authorised_value_list = GetAuthorisedValues();
1538 # warn ( Data::Dumper->Dump( [ $authorised_value_list ], [ 'authorised_value_list' ] ) );
1539 foreach my $this_authorised_value ( @$authorised_value_list ) {
1540 if ( exists $authorised_values->{ $this_authorised_value->{'category'} }
1541 && $authorised_values->{ $this_authorised_value->{'category'} } eq $this_authorised_value->{'authorised_value'} ) {
1542 # warn ( Data::Dumper->Dump( [ $this_authorised_value ], [ 'this_authorised_value' ] ) );
1543 if ( defined $this_authorised_value->{'imageurl'} ) {
1544 push @imagelist, { imageurl => C4::Koha::getitemtypeimagelocation( 'intranet', $this_authorised_value->{'imageurl'} ),
1545 label => $this_authorised_value->{'lib'},
1546 category => $this_authorised_value->{'category'},
1547 value => $this_authorised_value->{'authorised_value'}, };
1552 # warn ( Data::Dumper->Dump( [ \@imagelist ], [ 'imagelist' ] ) );
1557 =head1 LIMITED USE FUNCTIONS
1559 The following functions, while part of the public API,
1560 are not exported. This is generally because they are
1561 meant to be used by only one script for a specific
1562 purpose, and should not be used in any other context
1563 without careful thought.
1571 my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1575 Returns MARC::Record of the item passed in parameter.
1576 This function is meant for use only in C<cataloguing/additem.pl>,
1577 where it is needed to support that script's MARC-like
1583 my ( $biblionumber, $itemnumber ) = @_;
1585 # GetMarcItem has been revised so that it does the following:
1586 # 1. Gets the item information from the items table.
1587 # 2. Converts it to a MARC field for storage in the bib record.
1589 # The previous behavior was:
1590 # 1. Get the bib record.
1591 # 2. Return the MARC tag corresponding to the item record.
1593 # The difference is that one treats the items row as authoritative,
1594 # while the other treats the MARC representation as authoritative
1595 # under certain circumstances.
1597 my $itemrecord = GetItem($itemnumber);
1599 # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1600 # Also, don't emit a subfield if the underlying field is blank.
1603 defined($itemrecord->{$_}) && $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : ()
1604 } keys %{ $itemrecord }
1606 my $itemmarc = TransformKohaToMarc($mungeditem);
1608 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1609 if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1610 my @fields = $itemmarc->fields();
1611 if ($#fields > -1) {
1612 $fields[0]->add_subfields(@$unlinked_item_subfields);
1620 =head1 PRIVATE FUNCTIONS AND VARIABLES
1622 The following functions are not meant to be called
1623 directly, but are documented in order to explain
1624 the inner workings of C<C4::Items>.
1628 =head2 %derived_columns
1630 This hash keeps track of item columns that
1631 are strictly derived from other columns in
1632 the item record and are not meant to be set
1635 Each key in the hash should be the name of a
1636 column (as named by TransformMarcToKoha). Each
1637 value should be hashref whose keys are the
1638 columns on which the derived column depends. The
1639 hashref should also contain a 'BUILDER' key
1640 that is a reference to a sub that calculates
1645 my %derived_columns = (
1646 'items.cn_sort' => {
1647 'itemcallnumber' => 1,
1648 'items.cn_source' => 1,
1649 'BUILDER' => \&_calc_items_cn_sort,
1653 =head2 _set_derived_columns_for_add
1657 _set_derived_column_for_add($item);
1661 Given an item hash representing a new item to be added,
1662 calculate any derived columns. Currently the only
1663 such column is C<items.cn_sort>.
1667 sub _set_derived_columns_for_add {
1670 foreach my $column (keys %derived_columns) {
1671 my $builder = $derived_columns{$column}->{'BUILDER'};
1672 my $source_values = {};
1673 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1674 next if $source_column eq 'BUILDER';
1675 $source_values->{$source_column} = $item->{$source_column};
1677 $builder->($item, $source_values);
1681 =head2 _set_derived_columns_for_mod
1685 _set_derived_column_for_mod($item);
1689 Given an item hash representing a new item to be modified.
1690 calculate any derived columns. Currently the only
1691 such column is C<items.cn_sort>.
1693 This routine differs from C<_set_derived_columns_for_add>
1694 in that it needs to handle partial item records. In other
1695 words, the caller of C<ModItem> may have supplied only one
1696 or two columns to be changed, so this function needs to
1697 determine whether any of the columns to be changed affect
1698 any of the derived columns. Also, if a derived column
1699 depends on more than one column, but the caller is not
1700 changing all of then, this routine retrieves the unchanged
1701 values from the database in order to ensure a correct
1706 sub _set_derived_columns_for_mod {
1709 foreach my $column (keys %derived_columns) {
1710 my $builder = $derived_columns{$column}->{'BUILDER'};
1711 my $source_values = {};
1712 my %missing_sources = ();
1713 my $must_recalc = 0;
1714 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1715 next if $source_column eq 'BUILDER';
1716 if (exists $item->{$source_column}) {
1718 $source_values->{$source_column} = $item->{$source_column};
1720 $missing_sources{$source_column} = 1;
1724 foreach my $source_column (keys %missing_sources) {
1725 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
1727 $builder->($item, $source_values);
1732 =head2 _do_column_fixes_for_mod
1736 _do_column_fixes_for_mod($item);
1740 Given an item hashref containing one or more
1741 columns to modify, fix up certain values.
1742 Specifically, set to 0 any passed value
1743 of C<notforloan>, C<damaged>, C<itemlost>, or
1744 C<wthdrawn> that is either undefined or
1745 contains the empty string.
1749 sub _do_column_fixes_for_mod {
1752 if (exists $item->{'notforloan'} and
1753 (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
1754 $item->{'notforloan'} = 0;
1756 if (exists $item->{'damaged'} and
1757 (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
1758 $item->{'damaged'} = 0;
1760 if (exists $item->{'itemlost'} and
1761 (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
1762 $item->{'itemlost'} = 0;
1764 if (exists $item->{'wthdrawn'} and
1765 (not defined $item->{'wthdrawn'} or $item->{'wthdrawn'} eq '')) {
1766 $item->{'wthdrawn'} = 0;
1770 =head2 _get_single_item_column
1774 _get_single_item_column($column, $itemnumber);
1778 Retrieves the value of a single column from an C<items>
1779 row specified by C<$itemnumber>.
1783 sub _get_single_item_column {
1785 my $itemnumber = shift;
1787 my $dbh = C4::Context->dbh;
1788 my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
1789 $sth->execute($itemnumber);
1790 my ($value) = $sth->fetchrow();
1794 =head2 _calc_items_cn_sort
1798 _calc_items_cn_sort($item, $source_values);
1802 Helper routine to calculate C<items.cn_sort>.
1806 sub _calc_items_cn_sort {
1808 my $source_values = shift;
1810 $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
1813 =head2 _set_defaults_for_add
1817 _set_defaults_for_add($item_hash);
1821 Given an item hash representing an item to be added, set
1822 correct default values for columns whose default value
1823 is not handled by the DBMS. This includes the following
1830 C<items.dateaccessioned>
1852 sub _set_defaults_for_add {
1854 $item->{dateaccessioned} ||= C4::Dates->new->output('iso');
1855 $item->{$_} ||= 0 for (qw( notforloan damaged itemlost wthdrawn));
1858 =head2 _koha_new_item
1862 my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
1866 Perform the actual insert into the C<items> table.
1870 sub _koha_new_item {
1871 my ( $item, $barcode ) = @_;
1872 my $dbh=C4::Context->dbh;
1875 "INSERT INTO items SET
1877 biblioitemnumber = ?,
1879 dateaccessioned = ?,
1883 replacementprice = ?,
1884 replacementpricedate = NOW(),
1885 datelastborrowed = ?,
1886 datelastseen = NOW(),
1909 more_subfields_xml = ?,
1912 my $sth = $dbh->prepare($query);
1914 $item->{'biblionumber'},
1915 $item->{'biblioitemnumber'},
1917 $item->{'dateaccessioned'},
1918 $item->{'booksellerid'},
1919 $item->{'homebranch'},
1921 $item->{'replacementprice'},
1922 $item->{datelastborrowed},
1924 $item->{'notforloan'},
1926 $item->{'itemlost'},
1927 $item->{'wthdrawn'},
1928 $item->{'itemcallnumber'},
1929 $item->{'restricted'},
1930 $item->{'itemnotes'},
1931 $item->{'holdingbranch'},
1933 $item->{'location'},
1936 $item->{'renewals'},
1937 $item->{'reserves'},
1938 $item->{'items.cn_source'},
1939 $item->{'items.cn_sort'},
1942 $item->{'materials'},
1944 $item->{'enumchron'},
1945 $item->{'more_subfields_xml'},
1946 $item->{'copynumber'},
1948 my $itemnumber = $dbh->{'mysql_insertid'};
1949 if ( defined $sth->errstr ) {
1950 $error.="ERROR in _koha_new_item $query".$sth->errstr;
1953 return ( $itemnumber, $error );
1956 =head2 _koha_modify_item
1960 my ($itemnumber,$error) =_koha_modify_item( $item );
1964 Perform the actual update of the C<items> row. Note that this
1965 routine accepts a hashref specifying the columns to update.
1969 sub _koha_modify_item {
1971 my $dbh=C4::Context->dbh;
1974 my $query = "UPDATE items SET ";
1976 for my $key ( keys %$item ) {
1978 push @bind, $item->{$key};
1981 $query .= " WHERE itemnumber=?";
1982 push @bind, $item->{'itemnumber'};
1983 my $sth = C4::Context->dbh->prepare($query);
1984 $sth->execute(@bind);
1985 if ( C4::Context->dbh->errstr ) {
1986 $error.="ERROR in _koha_modify_item $query".$dbh->errstr;
1990 return ($item->{'itemnumber'},$error);
1993 =head2 _koha_delete_item
1997 _koha_delete_item( $dbh, $itemnum );
2001 Internal function to delete an item record from the koha tables
2005 sub _koha_delete_item {
2006 my ( $dbh, $itemnum ) = @_;
2008 # save the deleted item to deleteditems table
2009 my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
2010 $sth->execute($itemnum);
2011 my $data = $sth->fetchrow_hashref();
2013 my $query = "INSERT INTO deleteditems SET ";
2015 foreach my $key ( keys %$data ) {
2016 $query .= "$key = ?,";
2017 push( @bind, $data->{$key} );
2020 $sth = $dbh->prepare($query);
2021 $sth->execute(@bind);
2024 # delete from items table
2025 $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
2026 $sth->execute($itemnum);
2031 =head2 _marc_from_item_hash
2035 my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
2039 Given an item hash representing a complete item record,
2040 create a C<MARC::Record> object containing an embedded
2041 tag representing that item.
2043 The third, optional parameter C<$unlinked_item_subfields> is
2044 an arrayref of subfields (not mapped to C<items> fields per the
2045 framework) to be added to the MARC representation
2050 sub _marc_from_item_hash {
2052 my $frameworkcode = shift;
2053 my $unlinked_item_subfields;
2055 $unlinked_item_subfields = shift;
2058 # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
2059 # Also, don't emit a subfield if the underlying field is blank.
2060 my $mungeditem = { map { (defined($item->{$_}) and $item->{$_} ne '') ?
2061 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
2062 : () } keys %{ $item } };
2064 my $item_marc = MARC::Record->new();
2065 foreach my $item_field (keys %{ $mungeditem }) {
2066 my ($tag, $subfield) = GetMarcFromKohaField($item_field, $frameworkcode);
2067 next unless defined $tag and defined $subfield; # skip if not mapped to MARC field
2068 if (my $field = $item_marc->field($tag)) {
2069 $field->add_subfields($subfield => $mungeditem->{$item_field});
2071 my $add_subfields = [];
2072 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2073 $add_subfields = $unlinked_item_subfields;
2075 $item_marc->add_fields( $tag, " ", " ", $subfield => $mungeditem->{$item_field}, @$add_subfields);
2082 =head2 _add_item_field_to_biblio
2086 _add_item_field_to_biblio($item_marc, $biblionumber, $frameworkcode);
2090 Adds the fields from a MARC record containing the
2091 representation of a Koha item record to the MARC
2092 biblio record. The input C<$item_marc> record
2093 is expect to contain just one field, the embedded
2094 item information field.
2098 sub _add_item_field_to_biblio {
2099 my ($item_marc, $biblionumber, $frameworkcode) = @_;
2101 my $biblio_marc = GetMarcBiblio($biblionumber);
2102 foreach my $field ($item_marc->fields()) {
2103 $biblio_marc->append_fields($field);
2106 ModBiblioMarc($biblio_marc, $biblionumber, $frameworkcode);
2109 =head2 _replace_item_field_in_biblio
2113 &_replace_item_field_in_biblio($item_marc, $biblionumber, $itemnumber, $frameworkcode)
2117 Given a MARC::Record C<$item_marc> containing one tag with the MARC
2118 representation of the item, examine the biblio MARC
2119 for the corresponding tag for that item and
2120 replace it with the tag from C<$item_marc>.
2124 sub _replace_item_field_in_biblio {
2125 my ($ItemRecord, $biblionumber, $itemnumber, $frameworkcode) = @_;
2126 my $dbh = C4::Context->dbh;
2128 # get complete MARC record & replace the item field by the new one
2129 my $completeRecord = GetMarcBiblio($biblionumber);
2130 my ($itemtag,$itemsubfield) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
2131 my $itemField = $ItemRecord->field($itemtag);
2132 my @items = $completeRecord->field($itemtag);
2135 if ($_->subfield($itemsubfield) eq $itemnumber) {
2136 $_->replace_with($itemField);
2142 # If we haven't found the matching field,
2143 # just add it. However, this means that
2144 # there is likely a bug.
2145 $completeRecord->append_fields($itemField);
2149 ModBiblioMarc($completeRecord, $biblionumber, $frameworkcode);
2152 =head2 _repack_item_errors
2154 Add an error message hash generated by C<CheckItemPreSave>
2155 to a list of errors.
2159 sub _repack_item_errors {
2160 my $item_sequence_num = shift;
2161 my $item_ref = shift;
2162 my $error_ref = shift;
2164 my @repacked_errors = ();
2166 foreach my $error_code (sort keys %{ $error_ref }) {
2167 my $repacked_error = {};
2168 $repacked_error->{'item_sequence'} = $item_sequence_num;
2169 $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
2170 $repacked_error->{'error_code'} = $error_code;
2171 $repacked_error->{'error_information'} = $error_ref->{$error_code};
2172 push @repacked_errors, $repacked_error;
2175 return @repacked_errors;
2178 =head2 _get_unlinked_item_subfields
2182 my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
2188 sub _get_unlinked_item_subfields {
2189 my $original_item_marc = shift;
2190 my $frameworkcode = shift;
2192 my $marcstructure = GetMarcStructure(1, $frameworkcode);
2194 # assume that this record has only one field, and that that
2195 # field contains only the item information
2197 my @fields = $original_item_marc->fields();
2198 if ($#fields > -1) {
2199 my $field = $fields[0];
2200 my $tag = $field->tag();
2201 foreach my $subfield ($field->subfields()) {
2202 if (defined $subfield->[1] and
2203 $subfield->[1] ne '' and
2204 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
2205 push @$subfields, $subfield->[0] => $subfield->[1];
2212 =head2 _get_unlinked_subfields_xml
2216 my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
2222 sub _get_unlinked_subfields_xml {
2223 my $unlinked_item_subfields = shift;
2226 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2227 my $marc = MARC::Record->new();
2228 # use of tag 999 is arbitrary, and doesn't need to match the item tag
2229 # used in the framework
2230 $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
2231 $marc->encoding("UTF-8");
2232 $xml = $marc->as_xml("USMARC");
2238 =head2 _parse_unlinked_item_subfields_from_xml
2242 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2248 sub _parse_unlinked_item_subfields_from_xml {
2251 return unless defined $xml and $xml ne "";
2252 my $marc = MARC::Record->new_from_xml(StripNonXmlChars($xml),'UTF-8');
2253 my $unlinked_subfields = [];
2254 my @fields = $marc->fields();
2255 if ($#fields > -1) {
2256 foreach my $subfield ($fields[0]->subfields()) {
2257 push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2260 return $unlinked_subfields;