4 # A Class for hiding the ILS's concept of the item from OpenSIP
7 package C4::SIP::ILS::Item;
12 use Sys::Syslog qw(syslog);
15 use C4::SIP::ILS::Transaction;
26 our $VERSION = 3.07.00.049;
34 title => "Perl 5 desktop reference",
36 sip_media_type => '001',
41 title => "The deep blue alibi",
43 sip_media_type => '001',
49 reservenotes => undef,
50 reservedate => '2008-10-09',
52 rtimestamp => '2008-10-09 11:15:06',
53 biblionumber => '406',
54 borrowernumber => '756',
60 title => "Harry Potter y el cáliz de fuego",
62 sip_media_type => '001',
70 defined $a->{priority} or return -1;
71 defined $b->{priority} or return 1;
72 return $a->{priority} <=> $b->{priority};
76 my ($class, $item_id) = @_;
77 my $type = ref($class) || $class;
79 my $itemnumber = GetItemnumberFromBarcode($item_id);
80 my $item = GetBiblioFromItemNumber($itemnumber); # actually biblio.*, biblioitems.* AND items.* (overkill)
82 syslog("LOG_DEBUG", "new ILS::Item('%s'): not found", $item_id);
83 warn "new ILS::Item($item_id) : No item '$item_id'.";
86 $item->{ 'itemnumber' } = $itemnumber;
87 $item->{ 'id' } = $item->{barcode}; # to SIP, the barcode IS the id.
88 $item->{permanent_location}= $item->{homebranch};
89 $item->{'collection_code'} = $item->{ccode};
90 $item->{ 'call_number' } = $item->{itemcallnumber};
92 my $it = C4::Context->preference('item-level_itypes') ? $item->{itype} : $item->{itemtype};
93 my $itemtype = Koha::Database->new()->schema()->resultset('Itemtype')->find( $it );
94 $item->{sip_media_type} = $itemtype->sip_media_type() if $itemtype;
96 # check if its on issue and if so get the borrower
97 my $issue = GetItemIssue($item->{'itemnumber'});
99 $item->{due_date} = $issue->{date_due};
101 my $borrower = GetMember(borrowernumber=>$issue->{'borrowernumber'});
102 $item->{patron} = $borrower->{'cardnumber'};
103 my $reserves = GetReservesFromBiblionumber({ biblionumber => $item->{biblionumber} });
104 $item->{hold_queue} = [ sort priority_sort @$reserves ];
105 $item->{hold_shelf} = [( grep { defined $_->{found} and $_->{found} eq 'W' } @{$item->{hold_queue}} )];
106 $item->{pending_queue} = [( grep {(! defined $_->{found}) or $_->{found} ne 'W' } @{$item->{hold_queue}} )];
110 syslog("LOG_DEBUG", "new ILS::Item('%s'): found with title '%s'",
111 $item_id, $self->{title});
122 sip_item_properties => 0,
124 permanent_location => 0,
125 current_location => 0,
132 collection_code => 0,
142 # use Data::Dumper; warn "next_hold() hold_shelf: " . Dumper($self->{hold_shelf}); warn "next_hold() pending_queue: " . $self->{pending_queue};
143 foreach (@{$self->hold_shelf}) { # If this item was taken from the hold shelf, then that reserve still governs
144 next unless ($_->{itemnumber} and $_->{itemnumber} == $self->{itemnumber});
147 if (scalar @{$self->{pending_queue}}) { # Otherwise, if there is at least one hold, the first (best priority) gets it
148 return $self->{pending_queue}->[0];
153 # hold_patron_id is NOT the barcode. It's the borrowernumber.
154 # If a return triggers capture for a hold the borrowernumber is passed
155 # and saved so that other hold info can be retrieved
160 $self->{hold}->{borrowernumber} = $id;
162 if ($self->{hold} ) {
163 return $self->{hold}->{borrowernumber};
168 sub hold_patron_name {
170 my $borrowernumber = (@_ ? shift: $self->hold_patron_id()) or return;
171 my $holder = GetMember(borrowernumber=>$borrowernumber);
173 syslog("LOG_ERR", "While checking hold, GetMember failed for borrowernumber '$borrowernumber'");
176 my $email = $holder->{email} || '';
177 my $phone = $holder->{phone} || '';
178 my $extra = ($email and $phone) ? " ($email, $phone)" : # both populated, employ comma
179 ($email or $phone) ? " ($email$phone)" : # only 1 populated, we don't care which: no comma
180 "" ; # neither populated, empty string
181 my $name = $holder->{firstname} ? $holder->{firstname} . ' ' : '';
182 $name .= $holder->{surname} . $extra;
186 sub hold_patron_bcode {
188 my $borrowernumber = (@_ ? shift: $self->hold_patron_id()) or return;
189 my $holder = GetMember(borrowernumber => $borrowernumber);
191 if ($holder->{cardnumber}) {
192 return $holder->{cardnumber};
198 sub destination_loc {
202 $self->{dest_loc} = $set_loc;
204 if ($self->{dest_loc} ) {
205 return $self->{dest_loc};
212 sub DESTROY { } # keeps AUTOLOAD from catching inherent DESTROY calls
216 my $class = ref($self) or croak "$self is not an object";
217 my $name = $AUTOLOAD;
221 unless (exists $fields{$name}) {
222 croak "Cannot access '$name' field of class '$class'";
226 $fields{$name} or croak "Field '$name' of class '$class' is READ ONLY.";
227 return $self->{$name} = shift;
229 return $self->{$name};
233 sub status_update { # FIXME: this looks unimplemented
234 my ($self, $props) = @_;
235 my $status = C4::SIP::ILS::Transaction->new();
236 $self->{sip_item_properties} = $props;
243 return $self->{title};
246 sub sip_circulation_status {
248 if ($self->{patron}) {
249 return '04'; # charged
250 } elsif (scalar @{$self->{hold_queue}}) {
251 return '08'; # waiting on hold shelf
253 return '03'; # available
254 } # FIXME: 01-13 enumerated in spec.
257 sub sip_security_marker {
259 return '02'; # FIXME? 00-other; 01-None; 02-Tattle-Tape Security Strip (3M); 03-Whisper Tape (3M)
263 return '01'; # FIXME? 01-09 enumerated in spec. We just use O1-other/unknown.
268 return $self->{fee} || 0;
272 return $self->{currency} || 'USD';
276 return $self->{homebranch};
280 (defined $self->{hold_queue}) or return [];
281 return $self->{hold_queue};
285 (defined $self->{pending_queue}) or return [];
286 return $self->{pending_queue};
290 (defined $self->{hold_shelf}) or return [];
291 return $self->{hold_shelf};
294 sub hold_queue_position {
295 my ($self, $patron_id) = @_;
296 ($self->{hold_queue}) or return 0;
298 foreach (@{$self->{hold_queue}}) {
300 $_->{patron_id} or next;
301 if ($self->barcode_is_borrowernumber($patron_id, $_->{borrowernumber})) {
302 return $i; # maybe should return $_->{priority}
310 return $self->{due_date} || 0;
314 return $self->{recall_date} || 0;
316 sub hold_pickup_date {
318 return $self->{hold_pickup_date} || 0;
321 # This is a partial check of "availability". It is not supposed to check everything here.
322 # An item is available for a patron if it is:
323 # 1) checked out to the same patron
324 # AND no pending (i.e. non-W) hold queue
327 # AND (not on hold_shelf OR is on hold_shelf for patron)
329 # What this means is we are consciously allowing the patron to checkout (but not renew) an item that DOES
330 # have non-W holds on it, but has not been "picked" from the stacks. That is to say, the
331 # patron has retrieved the item before the librarian.
333 # We don't check if the patron is at the front of the pending queue in the first case, because
334 # they should not be able to place a hold on an item they already have.
337 my ($self, $for_patron) = @_;
338 my $count = (defined $self->{pending_queue}) ? scalar @{$self->{pending_queue}} : 0;
339 my $count2 = (defined $self->{hold_shelf} ) ? scalar @{$self->{hold_shelf} } : 0;
340 $debug and print STDERR "availability check: pending_queue size $count, hold_shelf size $count2\n";
341 if (defined($self->{patron_id})) {
342 ($self->{patron_id} eq $for_patron) or return 0;
343 return ($count ? 0 : 1);
344 } else { # not checked out
345 ($count2) and return $self->barcode_is_borrowernumber($for_patron, $self->{hold_shelf}[0]->{borrowernumber});
350 sub _barcode_to_borrowernumber {
352 return unless defined $known;
353 my $member = GetMember(cardnumber=>$known) or return;
354 return $member->{borrowernumber};
356 sub barcode_is_borrowernumber { # because hold_queue only has borrowernumber...
359 my $number = shift or return; # can't be zero
360 return unless defined $barcode; # might be 0 or 000 or 000000
361 my $converted = _barcode_to_borrowernumber($barcode);
362 return unless $converted;
363 return ($number == $converted);
367 my $hold = shift or return;
368 foreach (qw(biblionumber borrowernumber reservedate)) {
369 $hold->{$_} or return;
371 return ModReserveFill($hold);