2 # ILS.pm: Koha ILS interface module
9 use Sys::Syslog qw(syslog);
14 use ILS::Transaction::Checkout;
15 use ILS::Transaction::Checkin;
16 use ILS::Transaction::FeePayment;
17 use ILS::Transaction::Hold;
18 use ILS::Transaction::Renew;
19 use ILS::Transaction::RenewAll;
24 'magnetic media' => 1,
25 'security inhibit' => 0,
26 'offline operation' => 0,
27 "patron status request" => 1,
33 "patron information" => 1,
34 "end patron session" => 1,
36 "item information" => 1,
37 "item status update" => 0,
45 my ($class, $institution) = @_;
46 my $type = ref($class) || $class;
49 $debug and warn "new ILS: INSTITUTION: " . Dumper($institution);
50 syslog("LOG_DEBUG", "new ILS '%s'", $institution->{id});
51 $self->{institution} = $institution;
52 return bless $self, $type;
57 $debug and warn "ILS: finding patron";
58 return ILS::Patron->new(@_);
63 $debug and warn "ILS: finding item";
64 return ILS::Item->new(@_);
69 return $self->{institution}->{id}; # consider making this return the whole institution
74 return $self->{institution}->{id};
79 return (exists($supports{$op}) && $supports{$op});
83 my ($self, $id, $whence) = @_;
84 if ($id ne $self->{institution}->{id}) {
85 syslog("LOG_WARNING", "%s: received institution '%s', expected '%s'",
86 $whence, $id, $self->{institution}->{id});
92 # If it's defined, and matches a true sort of string, or is
93 # a non-zero number, then it's true.
94 defined($bool) or return; # false
95 ($bool =~ /true|y|yes/i) and return 1; # true
96 return ($bool =~ /^\d+$/ and $bool != 0); # true for non-zero numbers, false otherwise
101 return (exists($self->{institution}->{policy}->{checkout})
102 && to_bool($self->{institution}->{policy}->{checkout}));
106 return (exists($self->{institution}->{policy}->{checkin})
107 && to_bool($self->{institution}->{policy}->{checkin}));
109 sub status_update_ok {
111 return (exists($self->{institution}->{policy}->{status_update})
112 && to_bool($self->{institution}->{policy}->{status_update}));
116 return (exists($self->{institution}->{policy}->{offline})
117 && to_bool($self->{institution}->{policy}->{offline}));
121 # Checkout(patron_id, item_id, sc_renew):
122 # patron_id & item_id are the identifiers send by the terminal
123 # sc_renew is the renewal policy configured on the terminal
124 # returns a status opject that can be queried for the various bits
125 # of information that the protocol (SIP or NCIP) needs to generate
129 my ($self, $patron_id, $item_id, $sc_renew) = @_;
130 my ($patron, $item, $circ);
132 $circ = new ILS::Transaction::Checkout;
134 $circ->patron($patron = new ILS::Patron $patron_id);
135 $circ->item($item = new ILS::Item $item_id);
138 $circ->screen_msg("Invalid Patron");
139 } elsif (!$patron->charge_ok) {
140 $circ->screen_msg("Patron Blocked");
142 $circ->screen_msg("Invalid Item");
143 # holds checked inside do_checkout
144 # } elsif ($item->hold_queue && @{$item->hold_queue} && ! $item->barcode_is_borrowernumber($patron_id, $item->hold_queue->[0]->{borrowernumber})) {
145 # $circ->screen_msg("Item on Hold for Another User");
146 } elsif ($item->{patron} && ($item->{patron} ne $patron_id)) {
147 # I can't deal with this right now
148 $circ->screen_msg("Item checked out to another patron");
150 $circ->do_checkout();
152 $debug and warn "circ is ok";
153 # If the item is already associated with this patron, then
155 $circ->renew_ok($item->{patron} && ($item->{patron} eq $patron_id));
157 $item->{patron} = $patron_id;
158 $item->{due_date} = $circ->{due};
159 push(@{$patron->{items}}, $item_id);
160 $circ->desensitize(!$item->magnetic);
162 syslog("LOG_DEBUG", "ILS::Checkout: patron %s has checked out %s",
163 $patron_id, join(', ', @{$patron->{items}}));
166 syslog("LOG_ERR", "ILS::Checkout Issue failed");
175 my ($self, $item_id, $trans_date, $return_date,
176 $current_loc, $item_props, $cancel) = @_;
177 my ($patron, $item, $circ);
179 $circ = new ILS::Transaction::Checkin;
181 $circ->item($item = new ILS::Item $item_id);
183 $circ->do_checkin($current_loc, $return_date);
184 # It's ok to check it in if it exists, and if it was checked out
185 $circ->ok($item && $item->{patron});
188 $circ->patron($patron = new ILS::Patron $item->{patron});
189 delete $item->{patron};
190 delete $item->{due_date};
191 $patron->{items} = [ grep {$_ ne $item_id} @{$patron->{items}} ];
198 # If the ILS caches patron information, this lets it free
200 sub end_patron_session {
201 my ($self, $patron_id) = @_;
203 # success?, screen_msg, print_line
204 return (1, 'Thank you !', '');
208 my ($self, $patron_id, $patron_pwd, $fee_amt, $fee_type,
209 $pay_type, $fee_id, $trans_id, $currency) = @_;
213 # $trans = new ILS::Transaction::FeePayment;
215 $patron = new ILS::Patron $patron_id;
217 $trans->transaction_id($trans_id);
218 $trans->patron($patron);
225 my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
226 $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
229 my $trans = new ILS::Transaction::Hold;
231 $patron = new ILS::Patron $patron_id;
233 || (defined($patron_pwd) && !$patron->check_password($patron_pwd))) {
234 $trans->screen_msg("Invalid Patron.");
238 unless ($item = new ILS::Item ($item_id || $title_id)) {
239 $trans->screen_msg("No such item.");
243 if ($item->fee and $fee_ack ne 'Y') {
244 $trans->screen_msg = "Fee required to place hold.";
249 item_id => $item->id,
250 patron_id => $patron->id,
251 expiration_date => $expiry_date,
252 pickup_location => $pickup_location,
253 hold_type => $hold_type,
257 $trans->patron($patron);
259 $trans->pickup_location($pickup_location);
262 push(@{$item->hold_queue}, $hold);
263 push(@{$patron->{hold_items}}, $hold);
269 my ($self, $patron_id, $patron_pwd, $item_id, $title_id) = @_;
270 my ($patron, $item, $hold);
272 my $trans = new ILS::Transaction::Hold;
274 $patron = new ILS::Patron $patron_id;
276 $trans->screen_msg("Invalid patron barcode.");
278 } elsif (defined($patron_pwd) && !$patron->check_password($patron_pwd)) {
279 $trans->screen_msg('Invalid patron password.');
283 unless ($item = new ILS::Item ($item_id || $title_id)) {
284 $trans->screen_msg("No such item.");
288 $trans->patron($patron);
291 unless ($trans->ok) {
292 $trans->screen_msg("Error with transaction drop_hold: " . $trans->screen_msg);
295 # Remove the hold from the patron's record first
296 $trans->ok($patron->drop_hold($item_id)); # different than the transaction drop!
298 unless ($trans->ok) {
299 # We didn't find it on the patron record
300 $trans->screen_msg("No such hold on patron record.");
304 # Now, remove it from the item record. If it was on the patron
305 # record but not on the item record, we'll treat that as success.
306 foreach my $i (0 .. scalar @{$item->hold_queue}) {
307 $hold = $item->hold_queue->[$i];
308 if ($item->barcode_is_borrowernumber($patron->id, $hold->{borrowernumber})) {
309 # found it: delete it.
310 splice @{$item->hold_queue}, $i, 1;
311 last; # ?? should we keep going, in case there are multiples
315 $trans->screen_msg("Hold Cancelled.");
321 # The patron and item id's can't be altered, but the
322 # date, location, and type can.
324 my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
325 $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
330 $trans = new ILS::Transaction::Hold;
333 $patron = new ILS::Patron $patron_id;
335 $trans->screen_msg("Invalid patron barcode: '$patron_id'.");
339 foreach my $i (0 .. scalar @{$patron->{hold_items}}) {
340 $hold = $patron->{hold_items}[$i];
342 if ($hold->{item_id} eq $item_id) {
343 # Found it. So fix it.
344 $hold->{expiration_date} = $expiry_date if $expiry_date;
345 $hold->{pickup_location} = $pickup_location if $pickup_location;
346 $hold->{hold_type} = $hold_type if $hold_type;
347 $trans->change_hold();
349 $trans->screen_msg("Hold updated.");
350 $trans->patron($patron);
351 $trans->item(new ILS::Item $hold->{item_id});
356 # The same hold structure is linked into both the patron's
357 # list of hold items and into the queue of outstanding holds
358 # for the item, so we don't need to search the hold queue for
359 # the item, since it's already been updated by the patron code.
362 $trans->screen_msg("No such outstanding hold.");
369 my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
370 $no_block, $nb_due_date, $third_party,
371 $item_props, $fee_ack) = @_;
375 $trans = new ILS::Transaction::Renew;
376 $trans->patron($patron = new ILS::Patron $patron_id);
379 $trans->screen_msg("Invalid patron barcode.");
381 } elsif (!$patron->renew_ok) {
382 $trans->screen_msg("Renewals not allowed.");
386 # Previously: renewing a title, rather than an item (sort of)
387 # This is gross, but in a real ILS it would be better
389 # if (defined($title_id)) {
390 # foreach my $i (@{$patron->{items}}) {
391 # $item = new ILS::Item $i;
392 # last if ($title_id eq $item->title_id);
397 my $count = scalar @{$patron->{items}};
398 foreach my $i (@{$patron->{items}}) {
399 syslog("LOG_DEBUG", "checking item %s of %s: $item_id vs. %s", ++$j, $count, $i);
400 if ($i eq $item_id) {
401 # We have it checked out
402 $item = new ILS::Item $item_id;
410 if (!defined($item)) {
411 # It's not checked out to $patron_id
412 $trans->screen_msg("Item not checked out to " . $patron->name);
413 } elsif (!$item->available($patron_id)) {
414 $trans->screen_msg("Item unavailable due to outstanding holds");
416 $trans->renewal_ok(1);
417 $trans->desensitize(0); # It's already checked out
419 syslog("LOG_DEBUG", "done renew (%s): %s renews %s", $trans->renewal_ok(1),$patron_id,$item_id);
421 # if ($no_block eq 'Y') {
422 # $item->{due_date} = $nb_due_date;
424 # $item->{due_date} = time + (14*24*60*60); # two weeks
427 # $item->{sip_item_properties} = $item_props;
437 my ($self, $patron_id, $patron_pwd, $fee_ack) = @_;
438 my ($patron, $item_id);
441 $trans = new ILS::Transaction::RenewAll;
443 $trans->patron($patron = new ILS::Patron $patron_id);
444 if (defined $patron) {
445 syslog("LOG_DEBUG", "ILS::renew_all: patron '%s': renew_ok: %s",
446 $patron->name, $patron->renew_ok);
448 syslog("LOG_DEBUG", "ILS::renew_all: Invalid patron id: '%s'",
452 if (!defined($patron)) {
453 $trans->screen_msg("Invalid patron barcode.");
455 } elsif (!$patron->renew_ok) {
456 $trans->screen_msg("Renewals not allowed.");
458 } elsif (defined($patron_pwd) && !$patron->check_password($patron_pwd)) {
459 $trans->screen_msg("Invalid patron password.");
463 $trans->do_renew_all;