4 # A Class for hiding the ILS's concept of the item from OpenSIP
7 package C4::SIP::ILS::Item;
12 use C4::SIP::Sip qw(siplog);
16 use C4::SIP::ILS::Transaction;
17 use C4::SIP::Sip qw(add_field);
27 use Koha::Checkouts::ReturnClaims;
41 title => "Perl 5 desktop reference",
43 sip_media_type => '001',
48 title => "The deep blue alibi",
50 sip_media_type => '001',
56 reservenotes => undef,
57 reservedate => '2008-10-09',
59 rtimestamp => '2008-10-09 11:15:06',
60 biblionumber => '406',
61 borrowernumber => '756',
67 title => "Harry Potter y el cáliz de fuego",
69 sip_media_type => '001',
78 my ($class, $item_id) = @_;
79 my $type = ref($class) || $class;
80 my $item = Koha::Items->find( { barcode => barcodedecode( $item_id ) } );
82 siplog("LOG_DEBUG", "new ILS::Item('%s'): not found", $item_id);
83 warn "new ILS::Item($item_id) : No item '$item_id'.";
86 my $self = $item->unblessed;
87 $self->{_object} = $item;
88 $self->{id} = $item->barcode; # to SIP, the barcode IS the id.
89 $self->{permanent_location} = $item->homebranch;
90 $self->{collection_code} = $item->ccode;
91 $self->{call_number} = $item->itemcallnumber;
93 $self->{object} = $item;
95 my $it = $item->effective_itemtype;
96 my $itemtype = Koha::Database->new()->schema()->resultset('Itemtype')->find( $it );
97 $self->{sip_media_type} = $itemtype->sip_media_type() if $itemtype;
99 # check if its on issue and if so get the borrower
100 my $issue = Koha::Checkouts->find( { itemnumber => $item->itemnumber } );
102 $self->{due_date} = dt_from_string( $issue->date_due, 'sql' )->truncate( to => 'minute' );
103 my $patron = Koha::Patrons->find( $issue->borrowernumber );
104 $self->{borrowernumber} = $patron->borrowernumber;
106 my $biblio = Koha::Biblios->find( $self->{biblionumber} );
107 my $holds = $biblio->current_holds->unblessed;
108 $self->{hold_queue} = $holds;
109 $self->{hold_shelf} = [( grep { defined $_->{found} and $_->{found} eq 'W' } @{$self->{hold_queue}} )];
110 $self->{pending_queue} = [( grep {(! defined $_->{found}) or $_->{found} ne 'W' } @{$self->{hold_queue}} )];
111 $self->{title} = $biblio->title;
112 $self->{author} = $biblio->author;
115 siplog( "LOG_DEBUG", "new ILS::Item('%s'): found with title '%s'",
116 $item_id, $self->{title} // '' );
127 sip_item_properties => 0,
129 permanent_location => 0,
130 current_location => 0,
137 collection_code => 0,
147 # use Data::Dumper; warn "next_hold() hold_shelf: " . Dumper($self->{hold_shelf}); warn "next_hold() pending_queue: " . $self->{pending_queue};
148 foreach (@{$self->hold_shelf}) { # If this item was taken from the hold shelf, then that reserve still governs
149 next unless ($_->{itemnumber} and $_->{itemnumber} == $self->{itemnumber});
152 if (scalar @{$self->{pending_queue}}) { # Otherwise, if there is at least one hold, the first (best priority) gets it
153 return $self->{pending_queue}->[0];
158 # hold_patron_id is NOT the barcode. It's the borrowernumber.
159 # If a return triggers capture for a hold the borrowernumber is passed
160 # and saved so that other hold info can be retrieved
165 $self->{hold}->{borrowernumber} = $id;
167 if ($self->{hold} ) {
168 return $self->{hold}->{borrowernumber};
173 sub hold_patron_name {
174 my ( $self, $template ) = @_;
175 my $borrowernumber = $self->hold_patron_id() or return q{};
178 my $tt = Template->new();
180 my $patron = Koha::Patrons->find($borrowernumber);
183 $tt->process( \$template, { patron => $patron }, \$output );
187 my $holder = Koha::Patrons->find( $borrowernumber );
189 siplog("LOG_ERR", "While checking hold, failed to retrieve the patron with borrowernumber '$borrowernumber'");
192 my $email = $holder->email || '';
193 my $phone = $holder->phone || '';
194 my $extra = ($email and $phone) ? " ($email, $phone)" : # both populated, employ comma
195 ($email or $phone) ? " ($email$phone)" : # only 1 populated, we don't care which: no comma
196 "" ; # neither populated, empty string
197 my $name = $holder->firstname ? $holder->firstname . ' ' : '';
198 $name .= $holder->surname . $extra;
202 sub hold_patron_bcode {
204 my $borrowernumber = (@_ ? shift: $self->hold_patron_id()) or return q{};
205 my $holder = Koha::Patrons->find( $borrowernumber );
206 if ($holder and $holder->cardnumber ) {
207 return $holder->cardnumber;
212 sub destination_loc {
216 $self->{dest_loc} = $set_loc;
218 if ($self->{dest_loc} ) {
219 return $self->{dest_loc};
226 sub DESTROY { } # keeps AUTOLOAD from catching inherent DESTROY calls
230 my $class = ref($self) or croak "$self is not an object";
231 my $name = $AUTOLOAD;
235 unless (exists $fields{$name}) {
236 croak "Cannot access '$name' field of class '$class'";
240 $fields{$name} or croak "Field '$name' of class '$class' is READ ONLY.";
241 return $self->{$name} = shift;
243 return $self->{$name};
247 sub status_update { # FIXME: this looks unimplemented
248 my ($self, $props) = @_;
249 my $status = C4::SIP::ILS::Transaction->new();
250 $self->{sip_item_properties} = $props;
257 return $self->{title};
260 sub sip_circulation_status {
262 if ( $self->{_object}->get_transfer ) {
263 return '10'; # in transit between libraries
265 elsif ( Koha::Checkouts::ReturnClaims->search({ itemnumber => $self->{_object}->id, resolution => undef })->count ) {
266 return '11'; # claimed returned
268 elsif ( $self->{borrowernumber} ) {
269 return '04'; # charged
271 elsif ( grep { $_->{itemnumber} == $self->{itemnumber} } @{ $self->{hold_shelf} } ) {
272 return '08'; # waiting on hold shelf
275 return '03'; # available
276 } # FIXME: 01-13 enumerated in spec.
279 sub sip_security_marker {
281 return '02'; # FIXME? 00-other; 01-None; 02-Tattle-Tape Security Strip (3M); 03-Whisper Tape (3M)
285 return '01'; # FIXME? 01-09 enumerated in spec. We just use O1-other/unknown.
290 return $self->{fee} || 0;
294 return $self->{currency} || 'USD';
298 return $self->{homebranch};
302 (defined $self->{hold_queue}) or return [];
303 return $self->{hold_queue};
307 (defined $self->{pending_queue}) or return [];
308 return $self->{pending_queue};
312 (defined $self->{hold_shelf}) or return [];
313 return $self->{hold_shelf};
316 sub hold_queue_position {
317 my ($self, $patron_id) = @_;
318 ($self->{hold_queue}) or return 0;
320 foreach (@{$self->{hold_queue}}) {
322 $_->{patron_id} or next;
323 if ($self->barcode_is_borrowernumber($patron_id, $_->{borrowernumber})) {
324 return $i; # maybe should return $_->{priority}
332 return $self->{due_date} || 0;
336 return $self->{recall_date} || 0;
338 sub hold_pickup_date {
341 my $hold = Koha::Holds->find({ itemnumber => $self->{itemnumber}, found => 'W' });
343 return $hold->expirationdate || 0;
349 # This is a partial check of "availability". It is not supposed to check everything here.
350 # An item is available for a patron if it is:
351 # 1) checked out to the same patron
352 # AND no pending (i.e. non-W) hold queue
355 # AND (not on hold_shelf OR is on hold_shelf for patron)
357 # What this means is we are consciously allowing the patron to checkout (but not renew) an item that DOES
358 # have non-W holds on it, but has not been "picked" from the stacks. That is to say, the
359 # patron has retrieved the item before the librarian.
361 # We don't check if the patron is at the front of the pending queue in the first case, because
362 # they should not be able to place a hold on an item they already have.
365 my ($self, $for_patron) = @_;
366 my $count = (defined $self->{pending_queue}) ? scalar @{$self->{pending_queue}} : 0;
367 my $count2 = (defined $self->{hold_shelf} ) ? scalar @{$self->{hold_shelf} } : 0;
368 $debug and print STDERR "availability check: pending_queue size $count, hold_shelf size $count2\n";
369 if (defined($self->{borrowernumber})) {
370 ($self->{borrowernumber} eq $for_patron) or return 0;
371 return ($count ? 0 : 1);
372 } else { # not checked out
373 ($count2) and return $self->barcode_is_borrowernumber($for_patron, $self->{hold_shelf}[0]->{borrowernumber});
378 sub _barcode_to_borrowernumber {
380 return unless defined $known;
381 my $patron = Koha::Patrons->find( { cardnumber => $known } ) or return;
382 return $patron->borrowernumber
384 sub barcode_is_borrowernumber { # because hold_queue only has borrowernumber...
387 my $number = shift or return; # can't be zero
388 return unless defined $barcode; # might be 0 or 000 or 000000
389 my $converted = _barcode_to_borrowernumber($barcode);
390 return unless $converted;
391 return ($number == $converted);
395 my $hold = shift or return;
396 foreach (qw(biblionumber borrowernumber reservedate)) {
397 $hold->{$_} or return;
399 return ModReserveFill($hold);
402 =head2 build_additional_item_fields_string
404 This method builds the part of the sip message for additional item fields
405 to send in the item related message responses
409 sub build_additional_item_fields_string {
410 my ( $self, $server ) = @_;
414 if ( $server->{account}->{item_field} ) {
416 ref $server->{account}->{item_field} eq "ARRAY"
417 ? @{ $server->{account}->{item_field} }
418 : ( $server->{account}->{item_field} );
420 foreach my $f ( @fields_to_send ) {
421 my $code = $f->{code};
422 my $value = $self->{object}->$code;
423 $string .= add_field( $f->{field}, $value );