2 # ILS.pm: Koha ILS interface module
9 use Sys::Syslog qw(syslog);
12 use C4::SIP::ILS::Item;
13 use C4::SIP::ILS::Patron;
14 use C4::SIP::ILS::Transaction;
15 use C4::SIP::ILS::Transaction::Checkout;
16 use C4::SIP::ILS::Transaction::Checkin;
17 use C4::SIP::ILS::Transaction::FeePayment;
18 use C4::SIP::ILS::Transaction::Hold;
19 use C4::SIP::ILS::Transaction::Renew;
20 use C4::SIP::ILS::Transaction::RenewAll;
25 'magnetic media' => 1,
26 'security inhibit' => 0,
27 'offline operation' => 0,
28 "patron status request" => 1,
34 "patron information" => 1,
35 "end patron session" => 1,
37 "item information" => 1,
38 "item status update" => 0,
46 my ($class, $institution) = @_;
47 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 C4::SIP::ILS::Patron->new(@_);
63 $debug and warn "ILS: finding item";
64 return C4::SIP::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'", $whence, $id, $self->{institution}->{id});
86 # Just an FYI check, we don't expect the user to change location from that in SIPconfig.xml
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, $fee_ack) = @_;
130 my ($patron, $item, $circ);
132 $circ = C4::SIP::ILS::Transaction::Checkout->new();
134 $circ->patron($patron = C4::SIP::ILS::Patron->new( $patron_id));
135 $circ->item($item = C4::SIP::ILS::Item->new( $item_id));
137 $circ->fee_ack($fee_ack);
141 $circ->screen_msg("Invalid Patron");
142 } elsif (!$patron->charge_ok) {
143 $circ->screen_msg("Patron Blocked");
145 $circ->screen_msg("Invalid Item");
146 # holds checked inside do_checkout
147 # } elsif ($item->hold_queue && @{$item->hold_queue} && ! $item->barcode_is_borrowernumber($patron_id, $item->hold_queue->[0]->{borrowernumber})) {
148 # $circ->screen_msg("Item on Hold for Another User");
149 } elsif ($item->{patron} && !_ci_cardnumber_cmp($item->{patron},$patron_id)) {
150 $circ->screen_msg("Item checked out to another patron");
152 $circ->do_checkout();
154 $debug and warn "circ is ok";
155 # If the item is already associated with this patron, then
157 $circ->renew_ok($item->{patron} && _ci_cardnumber_cmp($item->{patron}, $patron_id));
159 $item->{patron} = $patron_id;
160 $item->{due_date} = $circ->{due};
161 push(@{$patron->{items}}, $item_id);
162 $circ->desensitize(!$item->magnetic_media);
164 syslog("LOG_DEBUG", "ILS::Checkout: patron %s has checked out %s",
165 $patron_id, join(', ', @{$patron->{items}}));
168 syslog("LOG_ERR", "ILS::Checkout Issue failed");
176 sub _ci_cardnumber_cmp {
178 # As the database is case insensitive we need to normalize two strings
179 # before comparing them
180 return ( uc($s1) eq uc($s2) );
183 # wrapper which allows above to be called for testing
185 sub test_cardnumber_compare {
186 my ($self, $str1, $str2) = @_;
187 return _ci_cardnumber_cmp($str1, $str2);
191 my ( $self, $item_id, $trans_date, $return_date, $current_loc, $item_props, $cancel, $checked_in_ok ) = @_;
192 my ( $patron, $item, $circ );
194 $circ = C4::SIP::ILS::Transaction::Checkin->new();
197 $circ->item( $item = C4::SIP::ILS::Item->new($item_id) );
200 $circ->do_checkin( $current_loc, $return_date );
204 $circ->alert_type(99);
205 $circ->screen_msg('Invalid Item');
208 # It's ok to check it in if it exists, and if it was checked out
209 # or it was not checked out but the checked_in_ok flag was set
210 $circ->ok( ( $checked_in_ok && $item ) || ( $item && $item->{patron} ) );
211 syslog("LOG_DEBUG", "C4::SIP::ILS::checkin - using checked_in_ok") if $checked_in_ok;
213 if ( !defined( $item->{patron} ) ) {
214 $circ->screen_msg("Item not checked out") unless $checked_in_ok;
215 syslog("LOG_DEBUG", "C4::SIP::ILS::checkin - item not checked out");
219 $circ->patron( $patron = C4::SIP::ILS::Patron->new( $item->{patron} ) );
220 delete $item->{patron};
221 delete $item->{due_date};
222 $patron->{items} = [ grep { $_ ne $item_id } @{ $patron->{items} } ];
231 # If the ILS caches patron information, this lets it free
233 sub end_patron_session {
234 my ($self, $patron_id) = @_;
236 # success?, screen_msg, print_line
237 return (1, 'Thank you !', '');
241 my ($self, $patron_id, $patron_pwd, $fee_amt, $fee_type,
242 $pay_type, $fee_id, $trans_id, $currency) = @_;
245 $trans = C4::SIP::ILS::Transaction::FeePayment->new();
248 $trans->transaction_id($trans_id);
250 $trans->patron($patron = C4::SIP::ILS::Patron->new($patron_id));
252 $trans->screen_msg('Invalid patron barcode.');
255 $trans->pay($patron->{borrowernumber},$fee_amt, $pay_type);
262 my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
263 $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
266 my $trans = C4::SIP::ILS::Transaction::Hold->new();
268 $patron = C4::SIP::ILS::Patron->new( $patron_id);
270 || (defined($patron_pwd) && !$patron->check_password($patron_pwd))) {
271 $trans->screen_msg("Invalid Patron.");
275 unless ($item = C4::SIP::ILS::Item->new($item_id || $title_id)) {
276 $trans->screen_msg("No such item.");
280 if ( $patron->holds_blocked_by_excessive_fees() ) {
281 $trans->screen_msg("Excessive fees blocking placement of hold.");
284 if ($item->fee and $fee_ack ne 'Y') {
285 $trans->screen_msg = "Fee required to place hold.";
290 item_id => $item->id,
291 patron_id => $patron->id,
292 expiration_date => $expiry_date,
293 pickup_location => $pickup_location,
294 hold_type => $hold_type,
298 $trans->patron($patron);
300 $trans->pickup_location($pickup_location);
303 push(@{$item->hold_queue}, $hold);
304 push(@{$patron->{hold_items}}, $hold);
310 my ($self, $patron_id, $patron_pwd, $item_id, $title_id) = @_;
311 my ($patron, $item, $hold);
313 my $trans = C4::SIP::ILS::Transaction::Hold->new();
315 $patron = C4::SIP::ILS::Patron->new( $patron_id );
317 $trans->screen_msg("Invalid patron barcode.");
319 } elsif (defined($patron_pwd) && !$patron->check_password($patron_pwd)) {
320 $trans->screen_msg('Invalid patron password.');
324 unless ($item = C4::SIP::ILS::Item->new($item_id || $title_id)) {
325 $trans->screen_msg("No such item.");
329 $trans->patron($patron);
332 unless ($trans->ok) {
333 $trans->screen_msg("Error with transaction drop_hold: " . $trans->screen_msg);
336 # Remove the hold from the patron's record first
337 $trans->ok($patron->drop_hold($item_id)); # different than the transaction drop!
339 unless ($trans->ok) {
340 # We didn't find it on the patron record
341 $trans->screen_msg("No such hold on patron record.");
345 # Now, remove it from the item record. If it was on the patron
346 # record but not on the item record, we'll treat that as success.
347 foreach my $i (0 .. scalar @{$item->hold_queue}) {
348 $hold = $item->hold_queue->[$i];
349 if ($item->barcode_is_borrowernumber($patron->id, $hold->{borrowernumber})) {
350 # found it: delete it.
351 splice @{$item->hold_queue}, $i, 1;
352 last; # ?? should we keep going, in case there are multiples
356 $trans->screen_msg("Hold Cancelled.");
362 # The patron and item id's can't be altered, but the
363 # date, location, and type can.
365 my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
366 $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
371 $trans = C4::SIP::ILS::Transaction::Hold->new();
374 $patron = C4::SIP::ILS::Patron->new( $patron_id );
376 $trans->screen_msg("Invalid patron barcode: '$patron_id'.");
380 foreach my $i (0 .. scalar @{$patron->{hold_items}}) {
381 $hold = $patron->{hold_items}[$i];
383 if ($hold->{item_id} eq $item_id) {
384 # Found it. So fix it.
385 $hold->{expiration_date} = $expiry_date if $expiry_date;
386 $hold->{pickup_location} = $pickup_location if $pickup_location;
387 $hold->{hold_type} = $hold_type if $hold_type;
388 $trans->change_hold();
390 $trans->screen_msg("Hold updated.");
391 $trans->patron($patron);
392 $trans->item(C4::SIP::ILS::Item->new( $hold->{item_id}));
397 # The same hold structure is linked into both the patron's
398 # list of hold items and into the queue of outstanding holds
399 # for the item, so we don't need to search the hold queue for
400 # the item, since it's already been updated by the patron code.
403 $trans->screen_msg("No such outstanding hold.");
410 my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
411 $no_block, $nb_due_date, $third_party,
412 $item_props, $fee_ack) = @_;
416 $trans = C4::SIP::ILS::Transaction::Renew->new();
417 $trans->patron($patron = C4::SIP::ILS::Patron->new( $patron_id ));
420 $trans->screen_msg("Invalid patron barcode.");
422 } elsif (!$patron->renew_ok) {
423 $trans->screen_msg("Renewals not allowed.");
427 # Previously: renewing a title, rather than an item (sort of)
428 # This is gross, but in a real ILS it would be better
430 # if (defined($title_id)) {
431 # foreach my $i (@{$patron->{items}}) {
432 # $item = new ILS::Item $i;
433 # last if ($title_id eq $item->title_id);
438 my $count = scalar @{$patron->{items}};
439 foreach my $i (@{$patron->{items}}) {
440 unless (defined $i->{barcode}) { # FIXME: using data instead of objects may violate the abstraction layer
441 syslog("LOG_ERR", "No barcode for item %s of %s: $item_id", $j+1, $count);
444 syslog("LOG_DEBUG", "checking item %s of %s: $item_id vs. %s", ++$j, $count, $i->{barcode});
445 if ($i->{barcode} eq $item_id) {
446 # We have it checked out
447 $item = C4::SIP::ILS::Item->new( $item_id );
455 if (!defined($item)) {
456 $trans->screen_msg("Item not checked out to " . $patron->name); # not checked out to $patron_id
460 if ($trans->renewal_ok()) {
461 $item->{due_date} = $trans->{due};
462 $trans->desensitize(0);
470 my ($self, $patron_id, $patron_pwd, $fee_ack) = @_;
471 my ($patron, $item_id);
474 $trans = C4::SIP::ILS::Transaction::RenewAll->new();
476 $trans->patron($patron = C4::SIP::ILS::Patron->new( $patron_id ));
477 if (defined $patron) {
478 syslog("LOG_DEBUG", "ILS::renew_all: patron '%s': renew_ok: %s", $patron->name, $patron->renew_ok);
480 syslog("LOG_DEBUG", "ILS::renew_all: Invalid patron id: '%s'", $patron_id);
483 if (!defined($patron)) {
484 $trans->screen_msg("Invalid patron barcode.");
486 } elsif (!$patron->renew_ok) {
487 $trans->screen_msg("Renewals not allowed.");
489 } elsif (defined($patron_pwd) && !$patron->check_password($patron_pwd)) {
490 $trans->screen_msg("Invalid patron password.");
494 $trans->do_renew_all;