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 );
61 GetItemsByBiblioitemnumber
64 GetItemnumberFromBarcode
70 C4::Items - item management functions
74 This module contains an API for manipulating item
75 records in Koha, and is used by cataloguing, circulation,
76 acquisitions, and serials management.
78 A Koha item record is stored in two places: the
79 items table and embedded in a MARC tag in the XML
80 version of the associated bib record in C<biblioitems.marcxml>.
81 This is done to allow the item information to be readily
82 indexed (e.g., by Zebra), but means that each item
83 modification transaction must keep the items table
84 and the MARC XML in sync at all times.
86 Consequently, all code that creates, modifies, or deletes
87 item records B<must> use an appropriate function from
88 C<C4::Items>. If no existing function is suitable, it is
89 better to add one to C<C4::Items> than to use add
90 one-off SQL statements to add or modify items.
92 The items table will be considered authoritative. In other
93 words, if there is ever a discrepancy between the items
94 table and the MARC XML, the items table should be considered
97 =head1 HISTORICAL NOTE
99 Most of the functions in C<C4::Items> were originally in
100 the C<C4::Biblio> module.
102 =head1 CORE EXPORTED FUNCTIONS
104 The following functions are meant for use by users
113 $item = GetItem($itemnumber,$barcode,$serial);
117 Return item information, for a given itemnumber or barcode.
118 The return value is a hashref mapping item column
119 names to values. If C<$serial> is true, include serial publication data.
124 my ($itemnumber,$barcode, $serial) = @_;
125 my $dbh = C4::Context->dbh;
128 my $sth = $dbh->prepare("
130 WHERE itemnumber = ?");
131 $sth->execute($itemnumber);
132 $data = $sth->fetchrow_hashref;
134 my $sth = $dbh->prepare("
138 $sth->execute($barcode);
139 $data = $sth->fetchrow_hashref;
142 my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=?");
143 $ssth->execute($data->{'itemnumber'}) ;
144 ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
145 warn $data->{'serialseq'} , $data->{'publisheddate'};
147 #if we don't have an items.itype, use biblioitems.itemtype.
148 if( ! $data->{'itype'} ) {
149 my $sth = $dbh->prepare("SELECT itemtype FROM biblioitems WHERE biblionumber = ?");
150 $sth->execute($data->{'biblionumber'});
151 ($data->{'itype'}) = $sth->fetchrow_array;
156 =head2 AddItemFromMarc
160 my ($biblionumber, $biblioitemnumber, $itemnumber)
161 = AddItemFromMarc($source_item_marc, $biblionumber);
165 Given a MARC::Record object containing an embedded item
166 record and a biblionumber, create a new item record.
170 sub AddItemFromMarc {
171 my ( $source_item_marc, $biblionumber ) = @_;
172 my $dbh = C4::Context->dbh;
174 # parse item hash from MARC
175 my $frameworkcode = GetFrameworkCode( $biblionumber );
176 my $item = &TransformMarcToKoha( $dbh, $source_item_marc, $frameworkcode );
177 my $unlinked_item_subfields = _get_unlinked_item_subfields($source_item_marc, $frameworkcode);
178 return AddItem($item, $biblionumber, $dbh, $frameworkcode, $unlinked_item_subfields);
185 my ($biblionumber, $biblioitemnumber, $itemnumber)
186 = AddItem($item, $biblionumber[, $dbh, $frameworkcode, $unlinked_item_subfields]);
190 Given a hash containing item column names as keys,
191 create a new Koha item record.
193 The first two optional parameters (C<$dbh> and C<$frameworkcode>)
194 do not need to be supplied for general use; they exist
195 simply to allow them to be picked up from AddItemFromMarc.
197 The final optional parameter, C<$unlinked_item_subfields>, contains
198 an arrayref containing subfields present in the original MARC
199 representation of the item (e.g., from the item editor) that are
200 not mapped to C<items> columns directly but should instead
201 be stored in C<items.more_subfields_xml> and included in
202 the biblio items tag for display and indexing.
208 my $biblionumber = shift;
210 my $dbh = @_ ? shift : C4::Context->dbh;
211 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
212 my $unlinked_item_subfields;
214 $unlinked_item_subfields = shift
217 # needs old biblionumber and biblioitemnumber
218 $item->{'biblionumber'} = $biblionumber;
219 my $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
220 $sth->execute( $item->{'biblionumber'} );
221 ($item->{'biblioitemnumber'}) = $sth->fetchrow;
223 _set_defaults_for_add($item);
224 _set_derived_columns_for_add($item);
225 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
226 # FIXME - checks here
227 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
228 $item->{'itemnumber'} = $itemnumber;
230 # create MARC tag representing item and add to bib
231 my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
232 _add_item_field_to_biblio($new_item_marc, $item->{'biblionumber'}, $frameworkcode );
234 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
236 return ($item->{biblionumber}, $item->{biblioitemnumber}, $itemnumber);
239 =head2 AddItemBatchFromMarc
243 ($itemnumber_ref, $error_ref) = AddItemBatchFromMarc($record, $biblionumber, $biblioitemnumber, $frameworkcode);
247 Efficiently create item records from a MARC biblio record with
248 embedded item fields. This routine is suitable for batch jobs.
250 This API assumes that the bib record has already been
251 saved to the C<biblio> and C<biblioitems> tables. It does
252 not expect that C<biblioitems.marc> and C<biblioitems.marcxml>
253 are populated, but it will do so via a call to ModBibiloMarc.
255 The goal of this API is to have a similar effect to using AddBiblio
256 and AddItems in succession, but without inefficient repeated
257 parsing of the MARC XML bib record.
259 This function returns an arrayref of new itemsnumbers and an arrayref of item
260 errors encountered during the processing. Each entry in the errors
261 list is a hashref containing the following keys:
267 Sequence number of original item tag in the MARC record.
271 Item barcode, provide to assist in the construction of
272 useful error messages.
274 =item error_condition
276 Code representing the error condition. Can be 'duplicate_barcode',
277 'invalid_homebranch', or 'invalid_holdingbranch'.
279 =item error_information
281 Additional information appropriate to the error condition.
287 sub AddItemBatchFromMarc {
288 my ($record, $biblionumber, $biblioitemnumber, $frameworkcode) = @_;
290 my @itemnumbers = ();
292 my $dbh = C4::Context->dbh;
294 # loop through the item tags and start creating items
295 my @bad_item_fields = ();
296 my ($itemtag, $itemsubfield) = &GetMarcFromKohaField("items.itemnumber",'');
297 my $item_sequence_num = 0;
298 ITEMFIELD: foreach my $item_field ($record->field($itemtag)) {
299 $item_sequence_num++;
300 # we take the item field and stick it into a new
301 # MARC record -- this is required so far because (FIXME)
302 # TransformMarcToKoha requires a MARC::Record, not a MARC::Field
303 # and there is no TransformMarcFieldToKoha
304 my $temp_item_marc = MARC::Record->new();
305 $temp_item_marc->append_fields($item_field);
307 # add biblionumber and biblioitemnumber
308 my $item = TransformMarcToKoha( $dbh, $temp_item_marc, $frameworkcode, 'items' );
309 my $unlinked_item_subfields = _get_unlinked_item_subfields($temp_item_marc, $frameworkcode);
310 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
311 $item->{'biblionumber'} = $biblionumber;
312 $item->{'biblioitemnumber'} = $biblioitemnumber;
314 # check for duplicate barcode
315 my %item_errors = CheckItemPreSave($item);
317 push @errors, _repack_item_errors($item_sequence_num, $item, \%item_errors);
318 push @bad_item_fields, $item_field;
322 _set_defaults_for_add($item);
323 _set_derived_columns_for_add($item);
324 my ( $itemnumber, $error ) = _koha_new_item( $item, $item->{barcode} );
325 warn $error if $error;
326 push @itemnumbers, $itemnumber; # FIXME not checking error
327 $item->{'itemnumber'} = $itemnumber;
329 logaction("CATALOGUING", "ADD", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
331 my $new_item_marc = _marc_from_item_hash($item, $frameworkcode, $unlinked_item_subfields);
332 $item_field->replace_with($new_item_marc->field($itemtag));
335 # remove any MARC item fields for rejected items
336 foreach my $item_field (@bad_item_fields) {
337 $record->delete_field($item_field);
340 # update the MARC biblio
341 $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode );
343 return (\@itemnumbers, \@errors);
346 =head2 ModItemFromMarc
350 ModItemFromMarc($item_marc, $biblionumber, $itemnumber);
354 This function updates an item record based on a supplied
355 C<MARC::Record> object containing an embedded item field.
356 This API is meant for the use of C<additem.pl>; for
357 other purposes, C<ModItem> should be used.
361 sub ModItemFromMarc {
362 my $item_marc = shift;
363 my $biblionumber = shift;
364 my $itemnumber = shift;
366 my $dbh = C4::Context->dbh;
367 my $frameworkcode = GetFrameworkCode( $biblionumber );
368 my $item = &TransformMarcToKoha( $dbh, $item_marc, $frameworkcode );
369 my $unlinked_item_subfields = _get_unlinked_item_subfields($item_marc, $frameworkcode);
371 return ModItem($item, $biblionumber, $itemnumber, $dbh, $frameworkcode, $unlinked_item_subfields);
378 ModItem({ column => $newvalue }, $biblionumber, $itemnumber[, $original_item_marc]);
382 Change one or more columns in an item record and update
383 the MARC representation of the item.
385 The first argument is a hashref mapping from item column
386 names to the new values. The second and third arguments
387 are the biblionumber and itemnumber, respectively.
389 The fourth, optional parameter, C<$unlinked_item_subfields>, contains
390 an arrayref containing subfields present in the original MARC
391 representation of the item (e.g., from the item editor) that are
392 not mapped to C<items> columns directly but should instead
393 be stored in C<items.more_subfields_xml> and included in
394 the biblio items tag for display and indexing.
396 If one of the changed columns is used to calculate
397 the derived value of a column such as C<items.cn_sort>,
398 this routine will perform the necessary calculation
405 my $biblionumber = shift;
406 my $itemnumber = shift;
408 # if $biblionumber is undefined, get it from the current item
409 unless (defined $biblionumber) {
410 $biblionumber = _get_single_item_column('biblionumber', $itemnumber);
413 my $dbh = @_ ? shift : C4::Context->dbh;
414 my $frameworkcode = @_ ? shift : GetFrameworkCode( $biblionumber );
416 my $unlinked_item_subfields;
418 $unlinked_item_subfields = shift;
419 $item->{'more_subfields_xml'} = _get_unlinked_subfields_xml($unlinked_item_subfields);
422 $item->{'itemnumber'} = $itemnumber or return undef;
423 _set_derived_columns_for_mod($item);
424 _do_column_fixes_for_mod($item);
427 # attempt to change itemnumber
428 # attempt to change biblionumber (if we want
429 # an API to relink an item to a different bib,
430 # it should be a separate function)
433 _koha_modify_item($item);
435 # update biblio MARC XML
436 my $whole_item = GetItem($itemnumber) or die "FAILED GetItem($itemnumber)";
438 unless (defined $unlinked_item_subfields) {
439 $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'});
441 my $new_item_marc = _marc_from_item_hash($whole_item, $frameworkcode, $unlinked_item_subfields)
442 or die "FAILED _marc_from_item_hash($whole_item, $frameworkcode)";
444 _replace_item_field_in_biblio($new_item_marc, $biblionumber, $itemnumber, $frameworkcode);
445 ($new_item_marc eq '0') and die "$new_item_marc is '0', not hashref"; # logaction line would crash anyway
446 logaction("CATALOGUING", "MODIFY", $itemnumber, $new_item_marc->as_formatted) if C4::Context->preference("CataloguingLog");
449 =head2 ModItemTransfer
453 ModItemTransfer($itenumber, $frombranch, $tobranch);
457 Marks an item as being transferred from one branch
462 sub ModItemTransfer {
463 my ( $itemnumber, $frombranch, $tobranch ) = @_;
465 my $dbh = C4::Context->dbh;
467 #new entry in branchtransfers....
468 my $sth = $dbh->prepare(
469 "INSERT INTO branchtransfers (itemnumber, frombranch, datesent, tobranch)
470 VALUES (?, ?, NOW(), ?)");
471 $sth->execute($itemnumber, $frombranch, $tobranch);
473 ModItem({ holdingbranch => $tobranch }, undef, $itemnumber);
474 ModDateLastSeen($itemnumber);
478 =head2 ModDateLastSeen
482 ModDateLastSeen($itemnum);
486 Mark item as seen. Is called when an item is issued, returned or manually marked during inventory/stocktaking.
487 C<$itemnum> is the item number
491 sub ModDateLastSeen {
492 my ($itemnumber) = @_;
494 my $today = C4::Dates->new();
495 ModItem({ itemlost => 0, datelastseen => $today->output("iso") }, undef, $itemnumber);
502 DelItem($biblionumber, $itemnumber);
506 Exported function (core API) for deleting an item record in Koha.
511 my ( $dbh, $biblionumber, $itemnumber ) = @_;
513 # FIXME check the item has no current issues
515 _koha_delete_item( $dbh, $itemnumber );
517 # get the MARC record
518 my $record = GetMarcBiblio($biblionumber);
519 my $frameworkcode = GetFrameworkCode($biblionumber);
522 my $copy2deleted = $dbh->prepare("UPDATE deleteditems SET marc=? WHERE itemnumber=?");
523 $copy2deleted->execute( $record->as_usmarc(), $itemnumber );
525 #search item field code
526 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
527 my @fields = $record->field($itemtag);
529 # delete the item specified
530 foreach my $field (@fields) {
531 if ( $field->subfield($itemsubfield) eq $itemnumber ) {
532 $record->delete_field($field);
535 &ModBiblioMarc( $record, $biblionumber, $frameworkcode );
536 logaction("CATALOGUING", "DELETE", $itemnumber, "item") if C4::Context->preference("CataloguingLog");
539 =head2 CheckItemPreSave
543 my $item_ref = TransformMarcToKoha($marc, 'items');
545 my %errors = CheckItemPreSave($item_ref);
546 if (exists $errors{'duplicate_barcode'}) {
547 print "item has duplicate barcode: ", $errors{'duplicate_barcode'}, "\n";
548 } elsif (exists $errors{'invalid_homebranch'}) {
549 print "item has invalid home branch: ", $errors{'invalid_homebranch'}, "\n";
550 } elsif (exists $errors{'invalid_holdingbranch'}) {
551 print "item has invalid holding branch: ", $errors{'invalid_holdingbranch'}, "\n";
558 Given a hashref containing item fields, determine if it can be
559 inserted or updated in the database. Specifically, checks for
560 database integrity issues, and returns a hash containing any
561 of the following keys, if applicable.
565 =item duplicate_barcode
567 Barcode, if it duplicates one already found in the database.
569 =item invalid_homebranch
571 Home branch, if not defined in branches table.
573 =item invalid_holdingbranch
575 Holding branch, if not defined in branches table.
579 This function does NOT implement any policy-related checks,
580 e.g., whether current operator is allowed to save an
581 item that has a given branch code.
585 sub CheckItemPreSave {
586 my $item_ref = shift;
590 # check for duplicate barcode
591 if (exists $item_ref->{'barcode'} and defined $item_ref->{'barcode'}) {
592 my $existing_itemnumber = GetItemnumberFromBarcode($item_ref->{'barcode'});
593 if ($existing_itemnumber) {
594 if (!exists $item_ref->{'itemnumber'} # new item
595 or $item_ref->{'itemnumber'} != $existing_itemnumber) { # existing item
596 $errors{'duplicate_barcode'} = $item_ref->{'barcode'};
601 # check for valid home branch
602 if (exists $item_ref->{'homebranch'} and defined $item_ref->{'homebranch'}) {
603 my $branch_name = GetBranchName($item_ref->{'homebranch'});
604 unless (defined $branch_name) {
605 # relies on fact that branches.branchname is a non-NULL column,
606 # so GetBranchName returns undef only if branch does not exist
607 $errors{'invalid_homebranch'} = $item_ref->{'homebranch'};
611 # check for valid holding branch
612 if (exists $item_ref->{'holdingbranch'} and defined $item_ref->{'holdingbranch'}) {
613 my $branch_name = GetBranchName($item_ref->{'holdingbranch'});
614 unless (defined $branch_name) {
615 # relies on fact that branches.branchname is a non-NULL column,
616 # so GetBranchName returns undef only if branch does not exist
617 $errors{'invalid_holdingbranch'} = $item_ref->{'holdingbranch'};
625 =head1 EXPORTED SPECIAL ACCESSOR FUNCTIONS
627 The following functions provide various ways of
628 getting an item record, a set of item records, or
629 lists of authorized values for certain item fields.
631 Some of the functions in this group are candidates
632 for refactoring -- for example, some of the code
633 in C<GetItemsByBiblioitemnumber> and C<GetItemsInfo>
634 has copy-and-paste work.
642 $itemstatushash = GetItemStatus($fwkcode);
646 Returns a list of valid values for the
647 C<items.notforloan> field.
649 NOTE: does B<not> return an individual item's
652 Can be MARC dependant.
654 But basically could be can be loan or not
655 Create a status selector with the following code
657 =head3 in PERL SCRIPT
661 my $itemstatushash = getitemstatus;
663 foreach my $thisstatus (keys %$itemstatushash) {
664 my %row =(value => $thisstatus,
665 statusname => $itemstatushash->{$thisstatus}->{'statusname'},
667 push @itemstatusloop, \%row;
669 $template->param(statusloop=>\@itemstatusloop);
677 <select name="statusloop">
678 <option value="">Default</option>
679 <!-- TMPL_LOOP name="statusloop" -->
680 <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="statusname" --></option>
690 # returns a reference to a hash of references to status...
693 my $dbh = C4::Context->dbh;
695 $fwk = '' unless ($fwk);
696 my ( $tag, $subfield ) =
697 GetMarcFromKohaField( "items.notforloan", $fwk );
698 if ( $tag and $subfield ) {
701 "SELECT authorised_value
702 FROM marc_subfield_structure
708 $sth->execute( $tag, $subfield, $fwk );
709 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
712 "SELECT authorised_value,lib
713 FROM authorised_values
718 $authvalsth->execute($authorisedvaluecat);
719 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
720 $itemstatus{$authorisedvalue} = $lib;
736 $itemstatus{"1"} = "Not For Loan";
740 =head2 GetItemLocation
744 $itemlochash = GetItemLocation($fwk);
748 Returns a list of valid values for the
749 C<items.location> field.
751 NOTE: does B<not> return an individual item's
754 where fwk stands for an optional framework code.
755 Create a location selector with the following code
757 =head3 in PERL SCRIPT
761 my $itemlochash = getitemlocation;
763 foreach my $thisloc (keys %$itemlochash) {
764 my $selected = 1 if $thisbranch eq $branch;
765 my %row =(locval => $thisloc,
766 selected => $selected,
767 locname => $itemlochash->{$thisloc},
769 push @itemlocloop, \%row;
771 $template->param(itemlocationloop => \@itemlocloop);
779 <select name="location">
780 <option value="">Default</option>
781 <!-- TMPL_LOOP name="itemlocationloop" -->
782 <option value="<!-- TMPL_VAR name="locval" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="locname" --></option>
790 sub GetItemLocation {
792 # returns a reference to a hash of references to location...
795 my $dbh = C4::Context->dbh;
797 $fwk = '' unless ($fwk);
798 my ( $tag, $subfield ) =
799 GetMarcFromKohaField( "items.location", $fwk );
800 if ( $tag and $subfield ) {
803 "SELECT authorised_value
804 FROM marc_subfield_structure
809 $sth->execute( $tag, $subfield, $fwk );
810 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
813 "SELECT authorised_value,lib
814 FROM authorised_values
818 $authvalsth->execute($authorisedvaluecat);
819 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
820 $itemlocation{$authorisedvalue} = $lib;
823 return \%itemlocation;
836 $itemlocation{"1"} = "Not For Loan";
837 return \%itemlocation;
844 $items = GetLostItems( $where, $orderby );
848 This function gets a list of lost items.
854 C<$where> is a hashref. it containts a field of the items table as key
855 and the value to match as value. For example:
857 { barcode => 'abc123',
858 homebranch => 'CPL', }
860 C<$orderby> is a field of the items table by which the resultset
865 C<$items> is a reference to an array full of hashrefs with columns
866 from the "items" table as keys.
868 =item usage in the perl script:
870 my $where = { barcode => '0001548' };
871 my $items = GetLostItems( $where, "homebranch" );
872 $template->param( itemsloop => $items );
879 # Getting input args.
882 my $dbh = C4::Context->dbh;
886 FROM items, biblio, authorised_values
888 items.biblionumber = biblio.biblionumber
889 AND items.itemlost = authorised_values.authorised_value
890 AND authorised_values.category = 'LOST'
891 AND itemlost IS NOT NULL
895 my @query_parameters;
896 foreach my $key (keys %$where) {
897 $query .= " AND $key LIKE ?";
898 push @query_parameters, "%$where->{$key}%";
900 if ( defined $orderby ) {
901 $query .= ' ORDER BY ?';
902 push @query_parameters, $orderby;
905 my $sth = $dbh->prepare($query);
906 $sth->execute( @query_parameters );
908 while ( my $row = $sth->fetchrow_hashref ){
914 =head2 GetItemsForInventory
918 $itemlist = GetItemsForInventory($minlocation, $maxlocation, $location, $itemtype $datelastseen, $branch, $offset, $size);
922 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
924 The sub returns a reference to a list of hashes, each containing
925 itemnumber, author, title, barcode, item callnumber, and date last
926 seen. It is ordered by callnumber then title.
928 The required minlocation & maxlocation parameters are used to specify a range of item callnumbers
929 the datelastseen can be used to specify that you want to see items not seen since a past date only.
930 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
934 sub GetItemsForInventory {
935 my ( $minlocation, $maxlocation,$location, $itemtype, $datelastseen, $branch, $offset, $size ) = @_;
936 my $dbh = C4::Context->dbh;
938 my $query = <<'END_SQL';
939 SELECT itemnumber, barcode, itemcallnumber, title, author, biblio.biblionumber, datelastseen
941 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
942 LEFT JOIN biblioitems on items.biblionumber = biblioitems.biblionumber
943 WHERE itemcallnumber >= ?
944 AND itemcallnumber <= ?
946 my @bind_params = ( $minlocation, $maxlocation );
949 $datelastseen = format_date_in_iso($datelastseen);
950 $query .= ' AND (datelastseen < ? OR datelastseen IS NULL) ';
951 push @bind_params, $datelastseen;
955 $query.= ' AND items.location = ? ';
956 push @bind_params, $location;
960 $query.= ' AND items.homebranch = ? ';
961 push @bind_params, $branch;
965 $query.= ' AND biblioitems.itemtype = ? ';
966 push @bind_params, $itemtype;
969 $query .= ' ORDER BY itemcallnumber, title';
970 my $sth = $dbh->prepare($query);
971 $sth->execute( @bind_params );
975 while ( my $row = $sth->fetchrow_hashref ) {
976 $offset-- if ($offset);
977 $row->{datelastseen}=format_date($row->{datelastseen});
978 if ( ( !$offset ) && $size ) {
989 $count = &GetItemsCount( $biblionumber);
993 This function return count of item with $biblionumber
998 my ( $biblionumber ) = @_;
999 my $dbh = C4::Context->dbh;
1000 my $query = "SELECT count(*)
1002 WHERE biblionumber=?";
1003 my $sth = $dbh->prepare($query);
1004 $sth->execute($biblionumber);
1005 my $count = $sth->fetchrow;
1010 =head2 GetItemInfosOf
1014 GetItemInfosOf(@itemnumbers);
1020 sub GetItemInfosOf {
1021 my @itemnumbers = @_;
1026 WHERE itemnumber IN (' . join( ',', @itemnumbers ) . ')
1028 return get_infos_of( $query, 'itemnumber' );
1031 =head2 GetItemsByBiblioitemnumber
1035 GetItemsByBiblioitemnumber($biblioitemnumber);
1039 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1040 Called by C<C4::XISBN>
1044 sub GetItemsByBiblioitemnumber {
1045 my ( $bibitem ) = @_;
1046 my $dbh = C4::Context->dbh;
1047 my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1048 # Get all items attached to a biblioitem
1051 $sth->execute($bibitem) || die $sth->errstr;
1052 while ( my $data = $sth->fetchrow_hashref ) {
1053 # Foreach item, get circulation information
1054 my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1055 WHERE itemnumber = ?
1056 AND issues.borrowernumber = borrowers.borrowernumber"
1058 $sth2->execute( $data->{'itemnumber'} );
1059 if ( my $data2 = $sth2->fetchrow_hashref ) {
1060 # if item is out, set the due date and who it is out too
1061 $data->{'date_due'} = $data2->{'date_due'};
1062 $data->{'cardnumber'} = $data2->{'cardnumber'};
1063 $data->{'borrowernumber'} = $data2->{'borrowernumber'};
1066 # set date_due to blank, so in the template we check itemlost, and wthdrawn
1067 $data->{'date_due'} = '';
1070 # Find the last 3 people who borrowed this item.
1071 my $query2 = "SELECT * FROM old_issues, borrowers WHERE itemnumber = ?
1072 AND old_issues.borrowernumber = borrowers.borrowernumber
1073 ORDER BY returndate desc,timestamp desc LIMIT 3";
1074 $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1075 $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1077 while ( my $data2 = $sth2->fetchrow_hashref ) {
1078 $data->{"timestamp$i2"} = $data2->{'timestamp'};
1079 $data->{"card$i2"} = $data2->{'cardnumber'};
1080 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
1084 push(@results,$data);
1094 @results = GetItemsInfo($biblionumber, $type);
1098 Returns information about books with the given biblionumber.
1100 C<$type> may be either C<intra> or anything else. If it is not set to
1101 C<intra>, then the search will exclude lost, very overdue, and
1104 C<GetItemsInfo> returns a list of references-to-hash. Each element
1105 contains a number of keys. Most of them are table items from the
1106 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
1107 Koha database. Other keys include:
1111 =item C<$data-E<gt>{branchname}>
1113 The name (not the code) of the branch to which the book belongs.
1115 =item C<$data-E<gt>{datelastseen}>
1117 This is simply C<items.datelastseen>, except that while the date is
1118 stored in YYYY-MM-DD format in the database, here it is converted to
1119 DD/MM/YYYY format. A NULL date is returned as C<//>.
1121 =item C<$data-E<gt>{datedue}>
1123 =item C<$data-E<gt>{class}>
1125 This is the concatenation of C<biblioitems.classification>, the book's
1126 Dewey code, and C<biblioitems.subclass>.
1128 =item C<$data-E<gt>{ocount}>
1130 I think this is the number of copies of the book available.
1132 =item C<$data-E<gt>{order}>
1134 If this is set, it is set to C<One Order>.
1141 my ( $biblionumber, $type ) = @_;
1142 my $dbh = C4::Context->dbh;
1143 my $query = "SELECT *,items.notforloan as itemnotforloan
1145 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1146 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
1147 $query .= (C4::Context->preference('item-level_itypes')) ?
1148 " LEFT JOIN itemtypes on items.itype = itemtypes.itemtype "
1149 : " LEFT JOIN itemtypes on biblioitems.itemtype = itemtypes.itemtype ";
1150 $query .= "WHERE items.biblionumber = ? ORDER BY items.dateaccessioned desc" ;
1151 my $sth = $dbh->prepare($query);
1152 $sth->execute($biblionumber);
1155 my ( $date_due, $count_reserves, $serial );
1157 my $isth = $dbh->prepare(
1158 "SELECT issues.*,borrowers.cardnumber,borrowers.surname,borrowers.firstname,borrowers.branchcode as bcode
1159 FROM issues LEFT JOIN borrowers ON issues.borrowernumber=borrowers.borrowernumber
1160 WHERE itemnumber = ?"
1162 my $ssth = $dbh->prepare("SELECT serialseq,publisheddate from serialitems left join serial on serialitems.serialid=serial.serialid where serialitems.itemnumber=? ");
1163 while ( my $data = $sth->fetchrow_hashref ) {
1165 $isth->execute( $data->{'itemnumber'} );
1166 if ( my $idata = $isth->fetchrow_hashref ) {
1167 $data->{borrowernumber} = $idata->{borrowernumber};
1168 $data->{cardnumber} = $idata->{cardnumber};
1169 $data->{surname} = $idata->{surname};
1170 $data->{firstname} = $idata->{firstname};
1171 $datedue = $idata->{'date_due'};
1172 if (C4::Context->preference("IndependantBranches")){
1173 my $userenv = C4::Context->userenv;
1174 if ( ($userenv) && ( $userenv->{flags} != 1 ) ) {
1175 $data->{'NOTSAMEBRANCH'} = 1 if ($idata->{'bcode'} ne $userenv->{branch});
1179 if ( $data->{'serial'}) {
1180 $ssth->execute($data->{'itemnumber'}) ;
1181 ($data->{'serialseq'} , $data->{'publisheddate'}) = $ssth->fetchrow_array();
1184 if ( $datedue eq '' ) {
1185 my ( $restype, $reserves ) =
1186 C4::Reserves::CheckReserves( $data->{'itemnumber'} );
1188 $count_reserves = $restype;
1193 #get branch information.....
1194 my $bsth = $dbh->prepare(
1195 "SELECT * FROM branches WHERE branchcode = ?
1198 $bsth->execute( $data->{'holdingbranch'} );
1199 if ( my $bdata = $bsth->fetchrow_hashref ) {
1200 $data->{'branchname'} = $bdata->{'branchname'};
1202 $data->{'datedue'} = $datedue;
1203 $data->{'count_reserves'} = $count_reserves;
1205 # get notforloan complete status if applicable
1206 my $sthnflstatus = $dbh->prepare(
1207 'SELECT authorised_value
1208 FROM marc_subfield_structure
1209 WHERE kohafield="items.notforloan"
1213 $sthnflstatus->execute;
1214 my ($authorised_valuecode) = $sthnflstatus->fetchrow;
1215 if ($authorised_valuecode) {
1216 $sthnflstatus = $dbh->prepare(
1217 "SELECT lib FROM authorised_values
1219 AND authorised_value=?"
1221 $sthnflstatus->execute( $authorised_valuecode,
1222 $data->{itemnotforloan} );
1223 my ($lib) = $sthnflstatus->fetchrow;
1224 $data->{notforloanvalue} = $lib;
1226 $data->{itypenotforloan} = $data->{notforloan} if (C4::Context->preference('item-level_itypes'));
1228 # my stack procedures
1229 my $stackstatus = $dbh->prepare(
1230 'SELECT authorised_value
1231 FROM marc_subfield_structure
1232 WHERE kohafield="items.stack"
1235 $stackstatus->execute;
1237 ($authorised_valuecode) = $stackstatus->fetchrow;
1238 if ($authorised_valuecode) {
1239 $stackstatus = $dbh->prepare(
1241 FROM authorised_values
1243 AND authorised_value=?
1246 $stackstatus->execute( $authorised_valuecode, $data->{stack} );
1247 my ($lib) = $stackstatus->fetchrow;
1248 $data->{stack} = $lib;
1250 # Find the last 3 people who borrowed this item.
1251 my $sth2 = $dbh->prepare("SELECT * FROM old_issues,borrowers
1252 WHERE itemnumber = ?
1253 AND old_issues.borrowernumber = borrowers.borrowernumber
1255 $sth2->execute($data->{'itemnumber'});
1257 while (my $data2 = $sth2->fetchrow_hashref()) {
1258 $data->{"timestamp$ii"} = $data2->{'timestamp'} if $data2->{'timestamp'};
1259 $data->{"card$ii"} = $data2->{'cardnumber'} if $data2->{'cardnumber'};
1260 $data->{"borrower$ii"} = $data2->{'borrowernumber'} if $data2->{'borrowernumber'};
1264 $results[$i] = $data;
1269 return( sort { ($b->{'publisheddate'} || $b->{'enumchron'}) cmp ($a->{'publisheddate'} || $a->{'enumchron'}) } @results );
1275 =head2 get_itemnumbers_of
1279 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1283 Given a list of biblionumbers, return the list of corresponding itemnumbers
1284 for each biblionumber.
1286 Return a reference on a hash where keys are biblionumbers and values are
1287 references on array of itemnumbers.
1291 sub get_itemnumbers_of {
1292 my @biblionumbers = @_;
1294 my $dbh = C4::Context->dbh;
1300 WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1302 my $sth = $dbh->prepare($query);
1303 $sth->execute(@biblionumbers);
1307 while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1308 push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1311 return \%itemnumbers_of;
1314 =head2 GetItemnumberFromBarcode
1318 $result = GetItemnumberFromBarcode($barcode);
1324 sub GetItemnumberFromBarcode {
1326 my $dbh = C4::Context->dbh;
1329 $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1330 $rq->execute($barcode);
1331 my ($result) = $rq->fetchrow;
1335 =head3 get_item_authorised_values
1337 find the types and values for all authorised values assigned to this item.
1342 returns: a hashref malling the authorised value to the value set for this itemnumber
1344 $authorised_values = {
1350 'RESTRICTED' => undef,
1353 'branches' => 'CPL',
1354 'cn_source' => undef,
1355 'itemtypes' => 'SER',
1358 Notes: see C4::Biblio::get_biblio_authorised_values for a similar method at the biblio level.
1362 sub get_item_authorised_values {
1363 my $itemnumber = shift;
1365 # assume that these entries in the authorised_value table are item level.
1366 my $query = q(SELECT distinct authorised_value, kohafield
1367 FROM marc_subfield_structure
1368 WHERE kohafield like 'item%'
1369 AND authorised_value != '' );
1371 my $itemlevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
1372 my $iteminfo = GetItem( $itemnumber );
1373 # warn( Data::Dumper->Dump( [ $itemlevel_authorised_values ], [ 'itemlevel_authorised_values' ] ) );
1375 foreach my $this_authorised_value ( keys %$itemlevel_authorised_values ) {
1376 my $field = $itemlevel_authorised_values->{ $this_authorised_value }->{'kohafield'};
1377 $field =~ s/^items\.//;
1378 if ( exists $iteminfo->{ $field } ) {
1379 $return->{ $this_authorised_value } = $iteminfo->{ $field };
1382 # warn( Data::Dumper->Dump( [ $return ], [ 'return' ] ) );
1386 =head3 get_authorised_value_images
1388 find a list of icons that are appropriate for display based on the
1389 authorised values for a biblio.
1391 parameters: listref of authorised values, such as comes from
1392 get_item_ahtorised_values or
1393 from C4::Biblio::get_biblio_authorised_values
1395 returns: listref of hashrefs for each image. Each hashref looks like
1398 { imageurl => '/intranet-tmpl/prog/img/itemtypeimg/npl/WEB.gif',
1403 Notes: Currently, I put on the full path to the images on the staff
1404 side. This should either be configurable or not done at all. Since I
1405 have to deal with 'intranet' or 'opac' in
1406 get_biblio_authorised_values, perhaps I should be passing it in.
1410 sub get_authorised_value_images {
1411 my $authorised_values = shift;
1415 my $authorised_value_list = GetAuthorisedValues();
1416 # warn ( Data::Dumper->Dump( [ $authorised_value_list ], [ 'authorised_value_list' ] ) );
1417 foreach my $this_authorised_value ( @$authorised_value_list ) {
1418 if ( exists $authorised_values->{ $this_authorised_value->{'category'} }
1419 && $authorised_values->{ $this_authorised_value->{'category'} } eq $this_authorised_value->{'authorised_value'} ) {
1420 # warn ( Data::Dumper->Dump( [ $this_authorised_value ], [ 'this_authorised_value' ] ) );
1421 if ( defined $this_authorised_value->{'imageurl'} ) {
1422 push @imagelist, { imageurl => C4::Koha::getitemtypeimagesrc( 'intranet' ) . '/' . $this_authorised_value->{'imageurl'},
1423 label => $this_authorised_value->{'lib'},
1424 category => $this_authorised_value->{'category'},
1425 value => $this_authorised_value->{'authorised_value'}, };
1430 # warn ( Data::Dumper->Dump( [ \@imagelist ], [ 'imagelist' ] ) );
1435 =head1 LIMITED USE FUNCTIONS
1437 The following functions, while part of the public API,
1438 are not exported. This is generally because they are
1439 meant to be used by only one script for a specific
1440 purpose, and should not be used in any other context
1441 without careful thought.
1449 my $item_marc = GetMarcItem($biblionumber, $itemnumber);
1453 Returns MARC::Record of the item passed in parameter.
1454 This function is meant for use only in C<cataloguing/additem.pl>,
1455 where it is needed to support that script's MARC-like
1461 my ( $biblionumber, $itemnumber ) = @_;
1463 # GetMarcItem has been revised so that it does the following:
1464 # 1. Gets the item information from the items table.
1465 # 2. Converts it to a MARC field for storage in the bib record.
1467 # The previous behavior was:
1468 # 1. Get the bib record.
1469 # 2. Return the MARC tag corresponding to the item record.
1471 # The difference is that one treats the items row as authoritative,
1472 # while the other treats the MARC representation as authoritative
1473 # under certain circumstances.
1475 my $itemrecord = GetItem($itemnumber);
1477 # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1478 # Also, don't emit a subfield if the underlying field is blank.
1479 my $mungeditem = { map { $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : () } keys %{ $itemrecord } };
1480 my $itemmarc = TransformKohaToMarc($mungeditem);
1482 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($mungeditem->{'items.more_subfields_xml'});
1483 if (defined $unlinked_item_subfields and $#$unlinked_item_subfields > -1) {
1484 my @fields = $itemmarc->fields();
1485 if ($#fields > -1) {
1486 $fields[0]->add_subfields(@$unlinked_item_subfields);
1494 =head1 PRIVATE FUNCTIONS AND VARIABLES
1496 The following functions are not meant to be called
1497 directly, but are documented in order to explain
1498 the inner workings of C<C4::Items>.
1502 =head2 %derived_columns
1504 This hash keeps track of item columns that
1505 are strictly derived from other columns in
1506 the item record and are not meant to be set
1509 Each key in the hash should be the name of a
1510 column (as named by TransformMarcToKoha). Each
1511 value should be hashref whose keys are the
1512 columns on which the derived column depends. The
1513 hashref should also contain a 'BUILDER' key
1514 that is a reference to a sub that calculates
1519 my %derived_columns = (
1520 'items.cn_sort' => {
1521 'itemcallnumber' => 1,
1522 'items.cn_source' => 1,
1523 'BUILDER' => \&_calc_items_cn_sort,
1527 =head2 _set_derived_columns_for_add
1531 _set_derived_column_for_add($item);
1535 Given an item hash representing a new item to be added,
1536 calculate any derived columns. Currently the only
1537 such column is C<items.cn_sort>.
1541 sub _set_derived_columns_for_add {
1544 foreach my $column (keys %derived_columns) {
1545 my $builder = $derived_columns{$column}->{'BUILDER'};
1546 my $source_values = {};
1547 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1548 next if $source_column eq 'BUILDER';
1549 $source_values->{$source_column} = $item->{$source_column};
1551 $builder->($item, $source_values);
1555 =head2 _set_derived_columns_for_mod
1559 _set_derived_column_for_mod($item);
1563 Given an item hash representing a new item to be modified.
1564 calculate any derived columns. Currently the only
1565 such column is C<items.cn_sort>.
1567 This routine differs from C<_set_derived_columns_for_add>
1568 in that it needs to handle partial item records. In other
1569 words, the caller of C<ModItem> may have supplied only one
1570 or two columns to be changed, so this function needs to
1571 determine whether any of the columns to be changed affect
1572 any of the derived columns. Also, if a derived column
1573 depends on more than one column, but the caller is not
1574 changing all of then, this routine retrieves the unchanged
1575 values from the database in order to ensure a correct
1580 sub _set_derived_columns_for_mod {
1583 foreach my $column (keys %derived_columns) {
1584 my $builder = $derived_columns{$column}->{'BUILDER'};
1585 my $source_values = {};
1586 my %missing_sources = ();
1587 my $must_recalc = 0;
1588 foreach my $source_column (keys %{ $derived_columns{$column} }) {
1589 next if $source_column eq 'BUILDER';
1590 if (exists $item->{$source_column}) {
1592 $source_values->{$source_column} = $item->{$source_column};
1594 $missing_sources{$source_column} = 1;
1598 foreach my $source_column (keys %missing_sources) {
1599 $source_values->{$source_column} = _get_single_item_column($source_column, $item->{'itemnumber'});
1601 $builder->($item, $source_values);
1606 =head2 _do_column_fixes_for_mod
1610 _do_column_fixes_for_mod($item);
1614 Given an item hashref containing one or more
1615 columns to modify, fix up certain values.
1616 Specifically, set to 0 any passed value
1617 of C<notforloan>, C<damaged>, C<itemlost>, or
1618 C<wthdrawn> that is either undefined or
1619 contains the empty string.
1623 sub _do_column_fixes_for_mod {
1626 if (exists $item->{'notforloan'} and
1627 (not defined $item->{'notforloan'} or $item->{'notforloan'} eq '')) {
1628 $item->{'notforloan'} = 0;
1630 if (exists $item->{'damaged'} and
1631 (not defined $item->{'damaged'} or $item->{'damaged'} eq '')) {
1632 $item->{'damaged'} = 0;
1634 if (exists $item->{'itemlost'} and
1635 (not defined $item->{'itemlost'} or $item->{'itemlost'} eq '')) {
1636 $item->{'itemlost'} = 0;
1638 if (exists $item->{'wthdrawn'} and
1639 (not defined $item->{'wthdrawn'} or $item->{'wthdrawn'} eq '')) {
1640 $item->{'wthdrawn'} = 0;
1644 =head2 _get_single_item_column
1648 _get_single_item_column($column, $itemnumber);
1652 Retrieves the value of a single column from an C<items>
1653 row specified by C<$itemnumber>.
1657 sub _get_single_item_column {
1659 my $itemnumber = shift;
1661 my $dbh = C4::Context->dbh;
1662 my $sth = $dbh->prepare("SELECT $column FROM items WHERE itemnumber = ?");
1663 $sth->execute($itemnumber);
1664 my ($value) = $sth->fetchrow();
1668 =head2 _calc_items_cn_sort
1672 _calc_items_cn_sort($item, $source_values);
1676 Helper routine to calculate C<items.cn_sort>.
1680 sub _calc_items_cn_sort {
1682 my $source_values = shift;
1684 $item->{'items.cn_sort'} = GetClassSort($source_values->{'items.cn_source'}, $source_values->{'itemcallnumber'}, "");
1687 =head2 _set_defaults_for_add
1691 _set_defaults_for_add($item_hash);
1695 Given an item hash representing an item to be added, set
1696 correct default values for columns whose default value
1697 is not handled by the DBMS. This includes the following
1704 C<items.dateaccessioned>
1726 sub _set_defaults_for_add {
1729 # if dateaccessioned is provided, use it. Otherwise, set to NOW()
1730 if (!(exists $item->{'dateaccessioned'}) ||
1731 ($item->{'dateaccessioned'} eq '')) {
1732 # FIXME add check for invalid date
1733 my $today = C4::Dates->new();
1734 $item->{'dateaccessioned'} = $today->output("iso"); #TODO: check time issues
1737 # various item status fields cannot be null
1738 $item->{'notforloan'} = 0 unless exists $item->{'notforloan'} and defined $item->{'notforloan'} and $item->{'notforloan'} ne '';
1739 $item->{'damaged'} = 0 unless exists $item->{'damaged'} and defined $item->{'damaged'} and $item->{'damaged'} ne '';
1740 $item->{'itemlost'} = 0 unless exists $item->{'itemlost'} and defined $item->{'itemlost'} and $item->{'itemlost'} ne '';
1741 $item->{'wthdrawn'} = 0 unless exists $item->{'wthdrawn'} and defined $item->{'wthdrawn'} and $item->{'wthdrawn'} ne '';
1744 =head2 _koha_new_item
1748 my ($itemnumber,$error) = _koha_new_item( $item, $barcode );
1752 Perform the actual insert into the C<items> table.
1756 sub _koha_new_item {
1757 my ( $item, $barcode ) = @_;
1758 my $dbh=C4::Context->dbh;
1761 "INSERT INTO items SET
1763 biblioitemnumber = ?,
1765 dateaccessioned = ?,
1769 replacementprice = ?,
1770 replacementpricedate = NOW(),
1771 datelastborrowed = ?,
1772 datelastseen = NOW(),
1795 more_subfields_xml = ?,
1798 my $sth = $dbh->prepare($query);
1800 $item->{'biblionumber'},
1801 $item->{'biblioitemnumber'},
1803 $item->{'dateaccessioned'},
1804 $item->{'booksellerid'},
1805 $item->{'homebranch'},
1807 $item->{'replacementprice'},
1808 $item->{datelastborrowed},
1810 $item->{'notforloan'},
1812 $item->{'itemlost'},
1813 $item->{'wthdrawn'},
1814 $item->{'itemcallnumber'},
1815 $item->{'restricted'},
1816 $item->{'itemnotes'},
1817 $item->{'holdingbranch'},
1819 $item->{'location'},
1822 $item->{'renewals'},
1823 $item->{'reserves'},
1824 $item->{'items.cn_source'},
1825 $item->{'items.cn_sort'},
1828 $item->{'materials'},
1830 $item->{'enumchron'},
1831 $item->{'more_subfields_xml'},
1832 $item->{'copynumber'},
1834 my $itemnumber = $dbh->{'mysql_insertid'};
1835 if ( defined $sth->errstr ) {
1836 $error.="ERROR in _koha_new_item $query".$sth->errstr;
1839 return ( $itemnumber, $error );
1842 =head2 _koha_modify_item
1846 my ($itemnumber,$error) =_koha_modify_item( $item );
1850 Perform the actual update of the C<items> row. Note that this
1851 routine accepts a hashref specifying the columns to update.
1855 sub _koha_modify_item {
1857 my $dbh=C4::Context->dbh;
1860 my $query = "UPDATE items SET ";
1862 for my $key ( keys %$item ) {
1864 push @bind, $item->{$key};
1867 $query .= " WHERE itemnumber=?";
1868 push @bind, $item->{'itemnumber'};
1869 my $sth = C4::Context->dbh->prepare($query);
1870 $sth->execute(@bind);
1871 if ( C4::Context->dbh->errstr ) {
1872 $error.="ERROR in _koha_modify_item $query".$dbh->errstr;
1876 return ($item->{'itemnumber'},$error);
1879 =head2 _koha_delete_item
1883 _koha_delete_item( $dbh, $itemnum );
1887 Internal function to delete an item record from the koha tables
1891 sub _koha_delete_item {
1892 my ( $dbh, $itemnum ) = @_;
1894 # save the deleted item to deleteditems table
1895 my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
1896 $sth->execute($itemnum);
1897 my $data = $sth->fetchrow_hashref();
1899 my $query = "INSERT INTO deleteditems SET ";
1901 foreach my $key ( keys %$data ) {
1902 $query .= "$key = ?,";
1903 push( @bind, $data->{$key} );
1906 $sth = $dbh->prepare($query);
1907 $sth->execute(@bind);
1910 # delete from items table
1911 $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
1912 $sth->execute($itemnum);
1917 =head2 _marc_from_item_hash
1921 my $item_marc = _marc_from_item_hash($item, $frameworkcode[, $unlinked_item_subfields]);
1925 Given an item hash representing a complete item record,
1926 create a C<MARC::Record> object containing an embedded
1927 tag representing that item.
1929 The third, optional parameter C<$unlinked_item_subfields> is
1930 an arrayref of subfields (not mapped to C<items> fields per the
1931 framework) to be added to the MARC representation
1936 sub _marc_from_item_hash {
1938 my $frameworkcode = shift;
1939 my $unlinked_item_subfields;
1941 $unlinked_item_subfields = shift;
1944 # Tack on 'items.' prefix to column names so lookup from MARC frameworks will work
1945 # Also, don't emit a subfield if the underlying field is blank.
1946 my $mungeditem = { map { (defined($item->{$_}) and $item->{$_} ne '') ?
1947 (/^items\./ ? ($_ => $item->{$_}) : ("items.$_" => $item->{$_}))
1948 : () } keys %{ $item } };
1950 my $item_marc = MARC::Record->new();
1951 foreach my $item_field (keys %{ $mungeditem }) {
1952 my ($tag, $subfield) = GetMarcFromKohaField($item_field, $frameworkcode);
1953 next unless defined $tag and defined $subfield; # skip if not mapped to MARC field
1954 if (my $field = $item_marc->field($tag)) {
1955 $field->add_subfields($subfield => $mungeditem->{$item_field});
1957 my $add_subfields = [];
1958 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
1959 $add_subfields = $unlinked_item_subfields;
1961 $item_marc->add_fields( $tag, " ", " ", $subfield => $mungeditem->{$item_field}, @$add_subfields);
1968 =head2 _add_item_field_to_biblio
1972 _add_item_field_to_biblio($item_marc, $biblionumber, $frameworkcode);
1976 Adds the fields from a MARC record containing the
1977 representation of a Koha item record to the MARC
1978 biblio record. The input C<$item_marc> record
1979 is expect to contain just one field, the embedded
1980 item information field.
1984 sub _add_item_field_to_biblio {
1985 my ($item_marc, $biblionumber, $frameworkcode) = @_;
1987 my $biblio_marc = GetMarcBiblio($biblionumber);
1988 foreach my $field ($item_marc->fields()) {
1989 $biblio_marc->append_fields($field);
1992 ModBiblioMarc($biblio_marc, $biblionumber, $frameworkcode);
1995 =head2 _replace_item_field_in_biblio
1999 &_replace_item_field_in_biblio($item_marc, $biblionumber, $itemnumber, $frameworkcode)
2003 Given a MARC::Record C<$item_marc> containing one tag with the MARC
2004 representation of the item, examine the biblio MARC
2005 for the corresponding tag for that item and
2006 replace it with the tag from C<$item_marc>.
2010 sub _replace_item_field_in_biblio {
2011 my ($ItemRecord, $biblionumber, $itemnumber, $frameworkcode) = @_;
2012 my $dbh = C4::Context->dbh;
2014 # get complete MARC record & replace the item field by the new one
2015 my $completeRecord = GetMarcBiblio($biblionumber);
2016 my ($itemtag,$itemsubfield) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
2017 my $itemField = $ItemRecord->field($itemtag);
2018 my @items = $completeRecord->field($itemtag);
2021 if ($_->subfield($itemsubfield) eq $itemnumber) {
2022 $_->replace_with($itemField);
2028 # If we haven't found the matching field,
2029 # just add it. However, this means that
2030 # there is likely a bug.
2031 $completeRecord->append_fields($itemField);
2035 ModBiblioMarc($completeRecord, $biblionumber, $frameworkcode);
2038 =head2 _repack_item_errors
2040 Add an error message hash generated by C<CheckItemPreSave>
2041 to a list of errors.
2045 sub _repack_item_errors {
2046 my $item_sequence_num = shift;
2047 my $item_ref = shift;
2048 my $error_ref = shift;
2050 my @repacked_errors = ();
2052 foreach my $error_code (sort keys %{ $error_ref }) {
2053 my $repacked_error = {};
2054 $repacked_error->{'item_sequence'} = $item_sequence_num;
2055 $repacked_error->{'item_barcode'} = exists($item_ref->{'barcode'}) ? $item_ref->{'barcode'} : '';
2056 $repacked_error->{'error_code'} = $error_code;
2057 $repacked_error->{'error_information'} = $error_ref->{$error_code};
2058 push @repacked_errors, $repacked_error;
2061 return @repacked_errors;
2064 =head2 _get_unlinked_item_subfields
2068 my $unlinked_item_subfields = _get_unlinked_item_subfields($original_item_marc, $frameworkcode);
2074 sub _get_unlinked_item_subfields {
2075 my $original_item_marc = shift;
2076 my $frameworkcode = shift;
2078 my $marcstructure = GetMarcStructure(1, $frameworkcode);
2080 # assume that this record has only one field, and that that
2081 # field contains only the item information
2083 my @fields = $original_item_marc->fields();
2084 if ($#fields > -1) {
2085 my $field = $fields[0];
2086 my $tag = $field->tag();
2087 foreach my $subfield ($field->subfields()) {
2088 if (defined $subfield->[1] and
2089 $subfield->[1] ne '' and
2090 !$marcstructure->{$tag}->{$subfield->[0]}->{'kohafield'}) {
2091 push @$subfields, $subfield->[0] => $subfield->[1];
2098 =head2 _get_unlinked_subfields_xml
2102 my $unlinked_subfields_xml = _get_unlinked_subfields_xml($unlinked_item_subfields);
2108 sub _get_unlinked_subfields_xml {
2109 my $unlinked_item_subfields = shift;
2112 if (defined $unlinked_item_subfields and ref($unlinked_item_subfields) eq 'ARRAY' and $#$unlinked_item_subfields > -1) {
2113 my $marc = MARC::Record->new();
2114 # use of tag 999 is arbitrary, and doesn't need to match the item tag
2115 # used in the framework
2116 $marc->append_fields(MARC::Field->new('999', ' ', ' ', @$unlinked_item_subfields));
2117 $marc->encoding("UTF-8");
2118 $xml = $marc->as_xml("USMARC");
2124 =head2 _parse_unlinked_item_subfields_from_xml
2128 my $unlinked_item_subfields = _parse_unlinked_item_subfields_from_xml($whole_item->{'more_subfields_xml'}):
2134 sub _parse_unlinked_item_subfields_from_xml {
2137 return unless defined $xml and $xml ne "";
2138 my $marc = MARC::Record->new_from_xml(StripNonXmlChars($xml),'UTF-8');
2139 my $unlinked_subfields = [];
2140 my @fields = $marc->fields();
2141 if ($#fields > -1) {
2142 foreach my $subfield ($fields[0]->subfields()) {
2143 push @$unlinked_subfields, $subfield->[0] => $subfield->[1];
2146 return $unlinked_subfields;