4 # A Class for handing SIP messages
12 use Sys::Syslog qw(syslog);
15 use Sip::Constants qw(:all);
16 use Sip::Checksum qw(verify_cksum);
20 use C4::Auth qw(&check_api_auth);
22 use UNIVERSAL qw(can); # make sure this is *after* C4 modules.
24 use vars qw(@ISA $VERSION @EXPORT_OK);
29 @EXPORT_OK = qw(handle);
32 # Predeclare handler subroutines
33 use subs qw(handle_patron_status handle_checkout handle_checkin
34 handle_block_patron handle_sc_status handle_request_acs_resend
35 handle_login handle_patron_info handle_end_patron_session
36 handle_fee_paid handle_item_information handle_item_status_update
37 handle_patron_enable handle_hold handle_renew handle_renew_all);
40 # For the most part, Version 2.00 of the protocol just adds new
41 # variable fields, but sometimes it changes the fixed header.
43 # In general, if there's no '2.00' protocol entry for a handler, that's
44 # because 2.00 didn't extend the 1.00 version of the protocol. This will
45 # be handled by the module initialization code following the declaration,
46 # which goes through the handlers table and creates a '2.00' entry that
47 # points to the same place as the '1.00' entry. If there's a 2.00 entry
48 # but no 1.00 entry, then that means that it's a completely new service
49 # in 2.00, so 1.00 shouldn't recognize it.
52 (PATRON_STATUS_REQ) => {
53 name => "Patron Status Request",
54 handler => \&handle_patron_status,
59 fields => [(FID_INST_ID), (FID_PATRON_ID),
60 (FID_TERMINAL_PWD), (FID_PATRON_PWD)],
66 handler => \&handle_checkout,
69 template => "CCA18A18",
71 fields => [(FID_INST_ID), (FID_PATRON_ID),
72 (FID_ITEM_ID), (FID_TERMINAL_PWD)],
75 template => "CCA18A18",
77 fields => [(FID_INST_ID), (FID_PATRON_ID),
78 (FID_ITEM_ID), (FID_TERMINAL_PWD),
79 (FID_ITEM_PROPS), (FID_PATRON_PWD),
80 (FID_FEE_ACK), (FID_CANCEL)],
86 handler => \&handle_checkin,
89 template => "CA18A18",
91 fields => [(FID_CURRENT_LOCN), (FID_INST_ID),
92 (FID_ITEM_ID), (FID_TERMINAL_PWD)],
95 template => "CA18A18",
97 fields => [(FID_CURRENT_LOCN), (FID_INST_ID),
98 (FID_ITEM_ID), (FID_TERMINAL_PWD),
99 (FID_ITEM_PROPS), (FID_CANCEL)],
104 name => "Block Patron",
105 handler => \&handle_block_patron,
110 fields => [(FID_INST_ID), (FID_BLOCKED_CARD_MSG),
111 (FID_PATRON_ID), (FID_TERMINAL_PWD)],
117 handler => \&handle_sc_status,
126 (REQUEST_ACS_RESEND) => {
127 name => "Request ACS Resend",
128 handler => \&handle_request_acs_resend,
139 handler => \&handle_login,
144 fields => [(FID_LOGIN_UID), (FID_LOGIN_PWD),
145 (FID_LOCATION_CODE)],
150 name => "Patron Info",
151 handler => \&handle_patron_info,
154 template => "A3A18A10",
156 fields => [(FID_INST_ID), (FID_PATRON_ID),
157 (FID_TERMINAL_PWD), (FID_PATRON_PWD),
158 (FID_START_ITEM), (FID_END_ITEM)],
162 (END_PATRON_SESSION) => {
163 name => "End Patron Session",
164 handler => \&handle_end_patron_session,
169 fields => [(FID_INST_ID), (FID_PATRON_ID),
170 (FID_TERMINAL_PWD), (FID_PATRON_PWD)],
176 handler => \&handle_fee_paid,
179 template => "A18A2A2A3",
181 fields => [(FID_FEE_AMT), (FID_INST_ID),
182 (FID_PATRON_ID), (FID_TERMINAL_PWD),
183 (FID_PATRON_PWD), (FID_FEE_ID),
184 (FID_TRANSACTION_ID)],
188 (ITEM_INFORMATION) => {
189 name => "Item Information",
190 handler => \&handle_item_information,
195 fields => [(FID_INST_ID), (FID_ITEM_ID),
200 (ITEM_STATUS_UPDATE) => {
201 name => "Item Status Update",
202 handler => \&handle_item_status_update,
207 fields => [(FID_INST_ID), (FID_PATRON_ID),
208 (FID_ITEM_ID), (FID_TERMINAL_PWD),
214 name => "Patron Enable",
215 handler => \&handle_patron_enable,
220 fields => [(FID_INST_ID), (FID_PATRON_ID),
221 (FID_TERMINAL_PWD), (FID_PATRON_PWD)],
227 handler => \&handle_hold,
232 fields => [(FID_EXPIRATION), (FID_PICKUP_LOCN),
233 (FID_HOLD_TYPE), (FID_INST_ID),
234 (FID_PATRON_ID), (FID_PATRON_PWD),
235 (FID_ITEM_ID), (FID_TITLE_ID),
236 (FID_TERMINAL_PWD), (FID_FEE_ACK)],
242 handler => \&handle_renew,
245 template => "CCA18A18",
247 fields => [(FID_INST_ID), (FID_PATRON_ID),
248 (FID_PATRON_PWD), (FID_ITEM_ID),
249 (FID_TITLE_ID), (FID_TERMINAL_PWD),
250 (FID_ITEM_PROPS), (FID_FEE_ACK)],
256 handler => \&handle_renew_all,
261 fields => [(FID_INST_ID), (FID_PATRON_ID),
262 (FID_PATRON_PWD), (FID_TERMINAL_PWD),
270 # Now, initialize some of the missing bits of %handlers
272 foreach my $i (keys(%handlers)) {
273 if (!exists($handlers{$i}->{protocol}->{2})) {
274 $handlers{$i}->{protocol}->{2} = $handlers{$i}->{protocol}->{1};
279 my ($class, $msg, $seqno) = @_;
281 my $msgtag = substr($msg, 0, 2);
283 if ($msgtag eq LOGIN) {
284 # If the client is using the 2.00-style "Login" message
285 # to authenticate to the server, then we get the Login message
286 # _before_ the client has indicated that it supports 2.00, but
287 # it's using the 2.00 login process, so it must support 2.00.
288 $protocol_version = 2;
290 syslog("LOG_DEBUG", "Sip::MsgType::new('%s', '%s...', '%s'): seq.no '%s', protocol %s",
291 $class, substr($msg, 0, 10), $msgtag, $seqno, $protocol_version);
292 # warn "SIP PROTOCOL: $protocol_version";
293 if (!exists($handlers{$msgtag})) {
294 syslog("LOG_WARNING", "new Sip::MsgType: Skipping message of unknown type '%s' in '%s'",
297 } elsif (!exists($handlers{$msgtag}->{protocol}->{$protocol_version})) {
298 syslog("LOG_WARNING", "new Sip::MsgType: Skipping message '%s' unsupported by protocol rev. '%d'",
299 $msgtag, $protocol_version);
305 $self->{seqno} = $seqno;
306 $self->_initialize(substr($msg,2), $handlers{$msgtag});
312 my ($self, $msg, $control_block) = @_;
314 my $proto = $control_block->{protocol}->{$protocol_version};
316 $self->{name} = $control_block->{name};
317 $self->{handler} = $control_block->{handler};
319 $self->{fields} = {};
320 $self->{fixed_fields} = [];
322 chomp($msg); # These four are probably unnecessary now.
327 foreach my $field (@{$proto->{fields}}) {
328 $self->{fields}->{$field} = undef;
331 syslog("LOG_DEBUG", "Sip::MsgType::_initialize('%s', '%s', '%s', '%s', ...)",
332 $self->{name}, $msg, $proto->{template}, $proto->{template_len});
334 $self->{fixed_fields} = [ unpack($proto->{template}, $msg) ]; # see http://perldoc.perl.org/5.8.8/functions/unpack.html
336 # Skip over the fixed fields and the split the rest of
337 # the message into fields based on the delimiter and parse them
338 foreach my $field (split(quotemeta($field_delimiter), substr($msg, $proto->{template_len}))) {
339 $fn = substr($field, 0, 2);
341 if (!exists($self->{fields}->{$fn})) {
342 syslog("LOG_WARNING", "Unsupported field '%s' in %s message '%s'",
343 $fn, $self->{name}, $msg);
344 } elsif (defined($self->{fields}->{$fn})) {
345 syslog("LOG_WARNING", "Duplicate field '%s' (previous value '%s') in %s message '%s'",
346 $fn, $self->{fields}->{$fn}, $self->{name}, $msg);
348 $self->{fields}->{$fn} = substr($field, 2);
356 my ($msg, $server, $req) = @_;
357 my $config = $server->{config};
361 # What's the field delimiter for variable length fields?
362 # This can't be based on the account, since we need to know
363 # the field delimiter to parse a SIP login message
365 if (defined($server->{config}->{delimiter})) {
366 $field_delimiter = $server->{config}->{delimiter};
369 # error detection is active if this is a REQUEST_ACS_RESEND
370 # message with a checksum, or if the message is long enough
371 # and the last nine characters begin with a sequence number
373 if ($msg eq REQUEST_ACS_RESEND_CKSUM) {
375 $error_detection = 1;
376 $self = new Sip::MsgType ((REQUEST_ACS_RESEND), 0);
377 } elsif((length($msg) > 11) && (substr($msg, -9, 2) eq "AY")) {
378 $error_detection = 1;
380 if (!verify_cksum($msg)) {
381 syslog("LOG_WARNING", "Checksum failed on message '%s'", $msg);
382 # REQUEST_SC_RESEND with error detection
383 $last_response = REQUEST_SC_RESEND_CKSUM;
384 print("$last_response\r");
385 return REQUEST_ACS_RESEND;
387 # Save the sequence number, then strip off the
388 # error detection data to process the message
389 $self = new Sip::MsgType (substr($msg, 0, -9), substr($msg, -7, 1));
391 } elsif ($error_detection) {
392 # We received a non-ED message when ED is supposed to be active.
393 # Warn about this problem, then process the message anyway.
394 syslog("LOG_WARNING",
395 "Received message without error detection: '%s'", $msg);
396 $error_detection = 0;
397 $self = new Sip::MsgType ($msg, 0);
399 $self = new Sip::MsgType ($msg, 0);
402 if ((substr($msg, 0, 2) ne REQUEST_ACS_RESEND) &&
403 $req && (substr($msg, 0, 2) ne $req)) {
404 return substr($msg, 0, 2);
406 unless ($self->{handler}) {
407 syslog("LOG_WARNING", "No handler defined for '%s'", $msg);
410 return($self->{handler}->($self, $server)); # FIXME
411 # FIXME: Use of uninitialized value in subroutine entry
412 # Can't use string ("") as a subroutine ref while "strict refs" in use
420 # Patron status messages are produced in response to both
421 # "Request Patron Status" and "Block Patron"
423 # Request Patron Status requires a patron password, but
424 # Block Patron doesn't (since the patron may never have
425 # provided one before attempting some illegal action).
427 # ASSUMPTION: If the patron password field is present in the
428 # message, then it must match, otherwise incomplete patron status
429 # information will be returned to the terminal.
431 sub build_patron_status {
432 my ($patron, $lang, $fields)= @_;
433 my $patron_pwd = $fields->{(FID_PATRON_PWD)};
434 my $resp = (PATRON_STATUS_RESP);
437 $resp .= patron_status_string($patron);
438 $resp .= $lang . Sip::timestamp();
439 $resp .= add_field(FID_PERSONAL_NAME, $patron->name);
441 # while the patron ID we got from the SC is valid, let's
442 # use the one returned from the ILS, just in case...
443 $resp .= add_field(FID_PATRON_ID, $patron->id);
444 if ($protocol_version >= 2) {
445 $resp .= add_field(FID_VALID_PATRON, 'Y');
446 # Patron password is a required field.
447 $resp .= add_field(FID_VALID_PATRON_PWD, sipbool($patron->check_password($patron_pwd)));
448 $resp .= maybe_add(FID_CURRENCY, $patron->currency);
449 $resp .= maybe_add(FID_FEE_AMT, $patron->fee_amount);
452 $resp .= maybe_add(FID_SCREEN_MSG, $patron->screen_msg);
453 $resp .= maybe_add(FID_PRINT_LINE, $patron->print_line);
455 # Invalid patron id. Report that the user has no privs.,
456 # no personal name, and is invalid (if we're using 2.00)
457 $resp .= 'YYYY' . (' ' x 10) . $lang . Sip::timestamp();
458 $resp .= add_field(FID_PERSONAL_NAME, '');
460 # the patron ID is invalid, but it's a required field, so
462 $resp .= add_field(FID_PATRON_ID, $fields->{(FID_PATRON_ID)});
464 ($protocol_version >= 2) and
465 $resp .= add_field(FID_VALID_PATRON, 'N');
468 $resp .= add_field(FID_INST_ID, $fields->{(FID_INST_ID)});
472 sub handle_patron_status {
473 my ($self, $server) = @_;
474 warn "handle_patron_status server: " . Dumper(\$server);
475 my $ils = $server->{ils};
477 my $resp = (PATRON_STATUS_RESP);
478 my $account = $server->{account};
479 my ($lang, $date) = @{$self->{fixed_fields}};
480 my $fields = $self->{fields};
481 #warn Dumper($fields);
483 #warn $fields->{(FID_INST_ID)};
484 $ils->check_inst_id($fields->{(FID_INST_ID)}, "handle_patron_status");
485 $patron = $ils->find_patron($fields->{(FID_PATRON_ID)});
486 $resp = build_patron_status($patron, $lang, $fields);
487 $self->write_msg($resp);
488 return (PATRON_STATUS_REQ);
491 sub handle_checkout {
492 my ($self, $server) = @_;
493 my $account = $server->{account};
494 my $ils = $server->{ils};
495 my $inst = $ils->institution;
496 my ($sc_renewal_policy, $no_block, $trans_date, $nb_due_date);
498 my ($patron_id, $item_id, $status);
502 ($sc_renewal_policy, $no_block, $trans_date, $nb_due_date) =
503 @{$self->{fixed_fields}};
504 $fields = $self->{fields};
506 $patron_id = $fields->{(FID_PATRON_ID)};
507 $item_id = $fields->{(FID_ITEM_ID)};
510 if ($no_block eq 'Y') {
511 # Off-line transactions need to be recorded, but there's
512 # not a lot we can do about it
513 syslog("LOG_WARNING", "received no-block checkout from terminal '%s'",
516 $status = $ils->checkout_no_block($patron_id, $item_id,
518 $trans_date, $nb_due_date);
520 # Does the transaction date really matter for items that are
521 # checkout out while the terminal is online? I'm guessing 'no'
522 $status = $ils->checkout($patron_id, $item_id, $sc_renewal_policy);
525 $item = $status->item;
526 $patron = $status->patron;
529 # Item successfully checked out
531 $resp = CHECKOUT_RESP . '1';
532 $resp .= sipbool($status->renew_ok);
533 if ($ils->supports('magnetic media')) {
534 $resp .= sipbool($item->magnetic_media);
538 # We never return the obsolete 'U' value for 'desensitize'
539 $resp .= sipbool($status->desensitize);
540 $resp .= Sip::timestamp;
542 # Now for the variable fields
543 $resp .= add_field(FID_INST_ID, $inst);
544 $resp .= add_field(FID_PATRON_ID, $patron_id);
545 $resp .= add_field(FID_ITEM_ID, $item_id);
546 $resp .= add_field(FID_TITLE_ID, $item->title_id);
547 if ($item->due_date) {
548 $resp .= add_field(FID_DUE_DATE, Sip::timestamp($item->due_date));
550 $resp .= add_field(FID_DUE_DATE, q{});
553 $resp .= maybe_add(FID_SCREEN_MSG, $status->screen_msg);
554 $resp .= maybe_add(FID_PRINT_LINE, $status->print_line);
556 if ($protocol_version >= 2) {
557 if ($ils->supports('security inhibit')) {
558 $resp .= add_field(FID_SECURITY_INHIBIT,
559 $status->security_inhibit);
561 $resp .= maybe_add(FID_MEDIA_TYPE, $item->sip_media_type);
562 $resp .= maybe_add(FID_ITEM_PROPS, $item->sip_item_properties);
565 if ($status->fee_amount) {
566 $resp .= add_field(FID_FEE_AMT, $status->fee_amount);
567 $resp .= maybe_add(FID_CURRENCY, $status->sip_currency);
568 $resp .= maybe_add(FID_FEE_TYPE, $status->sip_fee_type);
569 $resp .= maybe_add(FID_TRANSACTION_ID,
570 $status->transaction_id);
576 # Checkout Response: not ok, no renewal, don't know mag. media,
578 $resp = sprintf("120NUN%s", Sip::timestamp);
579 $resp .= add_field(FID_INST_ID, $inst);
580 $resp .= add_field(FID_PATRON_ID, $patron_id);
581 $resp .= add_field(FID_ITEM_ID, $item_id);
583 # If the item is valid, provide the title, otherwise
585 $resp .= add_field(FID_TITLE_ID, $item ? $item->title_id : '');
586 # Due date is required. Since it didn't get checked out,
587 # it's not due, so leave the date blank
588 $resp .= add_field(FID_DUE_DATE, '');
590 $resp .= maybe_add(FID_SCREEN_MSG, $status->screen_msg);
591 $resp .= maybe_add(FID_PRINT_LINE, $status->print_line);
593 if ($protocol_version >= 2) {
594 # Is the patron ID valid?
595 $resp .= add_field(FID_VALID_PATRON, sipbool($patron));
597 if ($patron && exists($fields->{FID_PATRON_PWD})) {
598 # Password provided, so we can tell if it was valid or not
599 $resp .= add_field(FID_VALID_PATRON_PWD,
600 sipbool($patron->check_password($fields->{(FID_PATRON_PWD)})));
605 $self->write_msg($resp);
610 my ($self, $server) = @_;
611 my $account = $server->{account};
612 my $ils = $server->{ils};
613 my ($current_loc, $inst_id, $item_id, $terminal_pwd, $item_props, $cancel);
614 my ($patron, $item, $status);
615 my $resp = CHECKIN_RESP;
616 my ($no_block, $trans_date, $return_date) = @{$self->{fixed_fields}};
617 my $fields = $self->{fields};
619 $current_loc = $fields->{(FID_CURRENT_LOCN)};
620 $inst_id = $fields->{(FID_INST_ID)};
621 $item_id = $fields->{(FID_ITEM_ID)};
622 $item_props = $fields->{(FID_ITEM_PROPS)};
623 $cancel = $fields->{(FID_CANCEL)};
625 $ils->check_inst_id($inst_id, "handle_checkin");
627 if ($no_block eq 'Y') {
628 # Off-line transactions, ick.
629 syslog("LOG_WARNING", "received no-block checkin from terminal '%s'", $account->{id});
630 $status = $ils->checkin_no_block($item_id, $trans_date, $return_date, $item_props, $cancel);
632 $status = $ils->checkin($item_id, $trans_date, $return_date, $current_loc, $item_props, $cancel);
635 $patron = $status->patron;
636 $item = $status->item;
638 $resp .= $status->ok ? '1' : '0';
639 $resp .= $status->resensitize ? 'Y' : 'N';
640 if ($item && $ils->supports('magnetic media')) {
641 $resp .= sipbool($item->magnetic_media);
643 # item barcode is invalid or system doesn't support 'magnetic media' indicator
647 # apparently we can't trust the returns from Checkin yet (because C4::Circulation::AddReturn is faulty)
648 # So we reproduce the alert logic here.
649 if (not $status->alert) {
650 if ($item->destination_loc and $item->destination_loc ne $current_loc) {
652 $status->alert_type('04'); # no hold, just send it
655 $resp .= $status->alert ? 'Y' : 'N';
656 $resp .= Sip::timestamp;
657 $resp .= add_field(FID_INST_ID, $inst_id);
658 $resp .= add_field(FID_ITEM_ID, $item_id);
661 $resp .= add_field(FID_PERM_LOCN, $item->permanent_location);
662 $resp .= maybe_add(FID_TITLE_ID, $item->title_id);
665 if ($protocol_version >= 2) {
666 $resp .= maybe_add(FID_SORT_BIN, $status->sort_bin);
668 $resp .= add_field(FID_PATRON_ID, $patron->id);
671 $resp .= maybe_add(FID_MEDIA_TYPE, $item->sip_media_type );
672 $resp .= maybe_add(FID_ITEM_PROPS, $item->sip_item_properties);
673 $resp .= maybe_add(FID_COLLECTION_CODE, $item->collection_code );
674 $resp .= maybe_add(FID_CALL_NUMBER, $item->call_number );
675 $resp .= maybe_add(FID_DESTINATION_LOCATION, $item->destination_loc );
676 $resp .= maybe_add(FID_HOLD_PATRON_ID, $item->hold_patron_bcode );
677 $resp .= maybe_add(FID_HOLD_PATRON_NAME, $item->hold_patron_name );
678 if ($status->hold and $status->hold->{branchcode} ne $item->destination_loc) {
679 warn 'SIP hold mismatch: $status->hold->{branchcode}=' . $status->hold->{branchcode} . '; $item->destination_loc=' . $item->destination_loc;
680 # just me being paranoid.
685 $resp .= maybe_add(FID_ALERT_TYPE, $status->alert_type) if $status->alert;
686 $resp .= maybe_add(FID_SCREEN_MSG, $status->screen_msg);
687 $resp .= maybe_add(FID_PRINT_LINE, $status->print_line);
689 $self->write_msg($resp);
694 sub handle_block_patron {
695 my ($self, $server) = @_;
696 my $account = $server->{account};
697 my $ils = $server->{ils};
698 my ($card_retained, $trans_date);
699 my ($inst_id, $blocked_card_msg, $patron_id, $terminal_pwd);
700 my ($fields,$resp,$patron);
702 ($card_retained, $trans_date) = @{$self->{fixed_fields}};
703 $fields = $self->{fields};
704 $inst_id = $fields->{(FID_INST_ID)};
705 $blocked_card_msg = $fields->{(FID_BLOCKED_CARD_MSG)};
706 $patron_id = $fields->{(FID_PATRON_ID)};
707 $terminal_pwd = $fields->{(FID_TERMINAL_PWD)};
709 # Terminal passwords are different from account login
710 # passwords, but I have no idea what to do with them. So,
711 # I'll just ignore them for now.
715 $ils->check_inst_id($inst_id, "block_patron");
716 $patron = $ils->find_patron($patron_id);
718 # The correct response for a "Block Patron" message is a
719 # "Patron Status Response", so use that handler to generate
720 # the message, but then return the correct code from here.
722 # Normally, the language is provided by the "Patron Status"
723 # fixed field, but since we're not responding to one of those
724 # we'll just say, "Unspecified", as per the spec. Let the
725 # terminal default to something that, one hopes, will be
729 $patron->block($card_retained, $blocked_card_msg);
732 $resp = build_patron_status($patron, $patron->language, $fields);
733 $self->write_msg($resp);
734 return(BLOCK_PATRON);
737 sub handle_sc_status {
738 my ($self, $server) = @_;
739 ($server) or warn "handle_sc_status error: no \$server argument received.";
740 my ($status, $print_width, $sc_protocol_version) = @{$self->{fixed_fields}};
743 if ($sc_protocol_version =~ /^1\./) {
745 } elsif ($sc_protocol_version =~ /^2\./) {
748 syslog("LOG_WARNING", "Unrecognized protocol revision '%s', falling back to '1'", $sc_protocol_version);
752 if ($new_proto != $protocol_version) {
753 syslog("LOG_INFO", "Setting protocol level to $new_proto");
754 $protocol_version = $new_proto;
757 if ($status == SC_STATUS_PAPER) {
758 syslog("LOG_WARNING", "Self-Check unit '%s@%s' out of paper",
759 $self->{account}->{id}, $self->{account}->{institution});
760 } elsif ($status == SC_STATUS_SHUTDOWN) {
761 syslog("LOG_WARNING", "Self-Check unit '%s@%s' shutting down",
762 $self->{account}->{id}, $self->{account}->{institution});
765 $self->{account}->{print_width} = $print_width;
766 return (send_acs_status($self, $server) ? SC_STATUS : '');
769 sub handle_request_acs_resend {
770 my ($self, $server) = @_;
772 if (!$last_response) {
773 # We haven't sent anything yet, so respond with a
774 # REQUEST_SC_RESEND msg (p. 16)
775 $self->write_msg(REQUEST_SC_RESEND);
776 } elsif ((length($last_response) < 9)
777 || substr($last_response, -9, 2) ne 'AY') {
778 # When resending a message, we aren't supposed to include
779 # a sequence number, even if the original had one (p. 4).
780 # If the last message didn't have a sequence number, then
781 # we can just send it.
782 print("$last_response\r"); # not write_msg?
784 # Cut out the sequence number and checksum, since the old
785 # checksum is wrong for the resent message.
786 my $rebuilt = substr($last_response, 0, -9);
787 $self->write_msg($rebuilt);
790 return REQUEST_ACS_RESEND;
793 sub login_core ($$$) {
794 my $server = shift or return undef;
797 my $status = 1; # Assume it all works
798 if (!exists($server->{config}->{accounts}->{$uid})) {
799 syslog("LOG_WARNING", "MsgType::login_core: Unknown login '$uid'");
801 } elsif ($server->{config}->{accounts}->{$uid}->{password} ne $pwd) {
802 syslog("LOG_WARNING", "MsgType::login_core: Invalid password for login '$uid'");
805 # Store the active account someplace handy for everybody else to find.
806 $server->{account} = $server->{config}->{accounts}->{$uid};
807 my $inst = $server->{account}->{institution};
808 $server->{institution} = $server->{config}->{institutions}->{$inst};
809 $server->{policy} = $server->{institution}->{policy};
810 $server->{sip_username} = $uid;
811 $server->{sip_password} = $pwd;
813 my $auth_status = api_auth($uid,$pwd,$inst);
814 if (!$auth_status or $auth_status !~ /^ok$/i) {
815 syslog("LOG_WARNING", "api_auth failed for SIP terminal '%s' of '%s': %s",
816 $uid, $inst, ($auth_status||'unknown'));
819 syslog("LOG_INFO", "Successful login/auth for '%s' of '%s'", $server->{account}->{id}, $inst);
821 # initialize connection to ILS
823 my $module = $server->{config}->{institutions}->{$inst}->{implementation};
824 syslog("LOG_DEBUG", 'login_core: ' . Dumper($module));
827 syslog("LOG_ERR", "%s: Loading ILS implementation '%s' for institution '%s' failed",
828 $server->{service}, $module, $inst);
829 die("Failed to load ILS implementation '$module' for $inst");
832 # like ILS->new(), I think.
833 $server->{ils} = $module->new($server->{institution}, $server->{account});
834 if (!$server->{ils}) {
835 syslog("LOG_ERR", "%s: ILS connection to '%s' failed", $server->{service}, $inst);
836 die("Unable to connect to ILS '$inst'");
844 my ($self, $server) = @_;
845 my ($uid_algorithm, $pwd_algorithm);
849 my $status = 1; # Assume it all works
851 $fields = $self->{fields};
852 ($uid_algorithm, $pwd_algorithm) = @{$self->{fixed_fields}};
854 $uid = $fields->{(FID_LOGIN_UID)}; # Terminal ID, not patron ID.
855 $pwd = $fields->{(FID_LOGIN_PWD)}; # Terminal PWD, not patron PWD.
857 if ($uid_algorithm || $pwd_algorithm) {
858 syslog("LOG_ERR", "LOGIN: Unsupported non-zero encryption method(s): uid = $uid_algorithm, pwd = $pwd_algorithm");
861 else { $status = login_core($server,$uid,$pwd); }
863 $self->write_msg(LOGIN_RESP . $status);
864 return $status ? LOGIN : '';
868 # Build the detailed summary information for the Patron
869 # Information Response message based on the first 'Y' that appears
870 # in the 'summary' field of the Patron Information reqest. The
871 # specification says that only one 'Y' can appear in that field,
872 # and we're going to believe it.
875 my ($ils, $patron, $summary, $start, $end) = @_;
879 # Map from offsets in the "summary" field of the Patron Information
880 # message to the corresponding field and handler
883 { func => $patron->can( "hold_items"), fid => FID_HOLD_ITEMS },
884 { func => $patron->can("overdue_items"), fid => FID_OVERDUE_ITEMS },
885 { func => $patron->can("charged_items"), fid => FID_CHARGED_ITEMS },
886 { func => $patron->can( "fine_items"), fid => FID_FINE_ITEMS },
887 { func => $patron->can( "recall_items"), fid => FID_RECALL_ITEMS },
888 { func => $patron->can("unavail_holds"), fid => FID_UNAVAILABLE_HOLD_ITEMS },
891 if (($summary_type = index($summary, 'Y')) == -1) {
892 return ''; # No detailed information required
895 syslog("LOG_DEBUG", "Summary_info: index == '%d', field '%s'",
896 $summary_type, $summary_map[$summary_type]->{fid});
898 my $func = $summary_map[$summary_type]->{func};
899 my $fid = $summary_map[$summary_type]->{fid};
900 my $itemlist = &$func($patron, $start, $end);
902 syslog("LOG_DEBUG", "summary_info: list = (%s)", join(", ", @{$itemlist}));
903 foreach my $i (@{$itemlist}) {
904 $resp .= add_field($fid, $i->{barcode});
910 sub handle_patron_info {
911 my ($self, $server) = @_;
912 my $ils = $server->{ils};
913 my ($lang, $trans_date, $summary) = @{$self->{fixed_fields}};
914 my $fields = $self->{fields};
915 my ($inst_id, $patron_id, $terminal_pwd, $patron_pwd, $start, $end);
916 my ($resp, $patron, $count);
918 $inst_id = $fields->{(FID_INST_ID)};
919 $patron_id = $fields->{(FID_PATRON_ID)};
920 $terminal_pwd = $fields->{(FID_TERMINAL_PWD)};
921 $patron_pwd = $fields->{(FID_PATRON_PWD)};
922 $start = $fields->{(FID_START_ITEM)};
923 $end = $fields->{(FID_END_ITEM)};
925 $patron = $ils->find_patron($patron_id);
927 $resp = (PATRON_INFO_RESP);
929 $resp .= patron_status_string($patron);
930 $resp .= (defined($lang) and length($lang) ==3) ? $lang : $patron->language;
931 $resp .= Sip::timestamp();
933 $resp .= add_count('patron_info/hold_items',
934 scalar @{$patron->hold_items});
935 $resp .= add_count('patron_info/overdue_items',
936 scalar @{$patron->overdue_items});
937 $resp .= add_count('patron_info/charged_items',
938 scalar @{$patron->charged_items});
939 $resp .= add_count('patron_info/fine_items',
940 scalar @{$patron->fine_items});
941 $resp .= add_count('patron_info/recall_items',
942 scalar @{$patron->recall_items});
943 $resp .= add_count('patron_info/unavail_holds',
944 scalar @{$patron->unavail_holds});
946 $resp .= add_field(FID_INST_ID, ($ils->institution_id || 'SIP2'));
948 # while the patron ID we got from the SC is valid, let's
949 # use the one returned from the ILS, just in case...
950 $resp .= add_field(FID_PATRON_ID, $patron->id);
951 $resp .= add_field(FID_PERSONAL_NAME, $patron->name);
953 # TODO: add code for the fields
955 # overdue items limit
956 # charged items limit
958 $resp .= add_field(FID_VALID_PATRON, 'Y');
959 if (defined($patron_pwd)) {
960 # If patron password was provided, report whether it was right or not.
961 $resp .= add_field(FID_VALID_PATRON_PWD,
962 sipbool($patron->check_password($patron_pwd)));
965 $resp .= maybe_add(FID_CURRENCY, $patron->currency);
966 $resp .= maybe_add(FID_FEE_AMT, $patron->fee_amount);
967 $resp .= add_field(FID_FEE_LMT, $patron->fee_limit);
969 # TODO: zero or more item details for 2.0 can go here:
976 $resp .= summary_info($ils, $patron, $summary, $start, $end);
978 $resp .= maybe_add(FID_HOME_ADDR, $patron->address);
979 $resp .= maybe_add(FID_EMAIL, $patron->email_addr);
980 $resp .= maybe_add(FID_HOME_PHONE, $patron->home_phone);
982 # SIP 2.0 extensions used by Envisionware
983 # Other terminals will ignore unrecognized fields (unrecognized field identifiers)
984 $resp .= maybe_add(FID_PATRON_BIRTHDATE, $patron->birthdate);
985 $resp .= maybe_add(FID_PATRON_CLASS, $patron->ptype);
987 # Custom protocol extension to report patron internet privileges
988 $resp .= maybe_add(FID_INET_PROFILE, $patron->inet_privileges);
990 $resp .= maybe_add(FID_SCREEN_MSG, $patron->screen_msg);
991 $resp .= maybe_add(FID_PRINT_LINE, $patron->print_line);
994 # no privileges, no items associated,
995 # no personal name, and is invalid (if we're using 2.00)
996 $resp .= 'YYYY' . (' ' x 10) . $lang . Sip::timestamp();
999 $resp .= add_field(FID_INST_ID, ($ils->institution_id || 'SIP2'));
1000 # patron ID is invalid, but field is required, so just echo it back
1001 $resp .= add_field(FID_PATRON_ID, $fields->{(FID_PATRON_ID)});
1002 $resp .= add_field(FID_PERSONAL_NAME, '');
1004 if ($protocol_version >= 2) {
1005 $resp .= add_field(FID_VALID_PATRON, 'N');
1009 $self->write_msg($resp);
1010 return(PATRON_INFO);
1013 sub handle_end_patron_session {
1014 my ($self, $server) = @_;
1015 my $ils = $server->{ils};
1017 my $fields = $self->{fields};
1018 my $resp = END_SESSION_RESP;
1019 my ($status, $screen_msg, $print_line);
1021 ($trans_date) = @{$self->{fixed_fields}};
1023 $ils->check_inst_id($fields->{(FID_INST_ID)}, 'handle_end_patron_session');
1025 ($status, $screen_msg, $print_line) = $ils->end_patron_session($fields->{(FID_PATRON_ID)});
1027 $resp .= $status ? 'Y' : 'N';
1028 $resp .= Sip::timestamp();
1030 $resp .= add_field(FID_INST_ID, $server->{ils}->institution);
1031 $resp .= add_field(FID_PATRON_ID, $fields->{(FID_PATRON_ID)});
1033 $resp .= maybe_add(FID_SCREEN_MSG, $screen_msg);
1034 $resp .= maybe_add(FID_PRINT_LINE, $print_line);
1036 $self->write_msg($resp);
1038 return(END_PATRON_SESSION);
1041 sub handle_fee_paid {
1042 my ($self, $server) = @_;
1043 my $ils = $server->{ils};
1044 my ($trans_date, $fee_type, $pay_type, $currency) = $self->{fixed_fields};
1045 my $fields = $self->{fields};
1046 my ($fee_amt, $inst_id, $patron_id, $terminal_pwd, $patron_pwd);
1047 my ($fee_id, $trans_id);
1049 my $resp = FEE_PAID_RESP;
1051 $fee_amt = $fields->{(FID_FEE_AMT)};
1052 $inst_id = $fields->{(FID_INST_ID)};
1053 $patron_id = $fields->{(FID_PATRON_ID)};
1054 $patron_pwd = $fields->{(FID_PATRON_PWD)};
1055 $fee_id = $fields->{(FID_FEE_ID)};
1056 $trans_id = $fields->{(FID_TRANSACTION_ID)};
1058 $ils->check_inst_id($inst_id, "handle_fee_paid");
1060 $status = $ils->pay_fee($patron_id, $patron_pwd, $fee_amt, $fee_type,
1061 $pay_type, $fee_id, $trans_id, $currency);
1063 $resp .= ($status->ok ? 'Y' : 'N') . Sip::timestamp;
1064 $resp .= add_field(FID_INST_ID, $inst_id);
1065 $resp .= add_field(FID_PATRON_ID, $patron_id);
1066 $resp .= maybe_add(FID_TRANSACTION_ID, $status->transaction_id);
1067 $resp .= maybe_add(FID_SCREEN_MSG, $status->screen_msg);
1068 $resp .= maybe_add(FID_PRINT_LINE, $status->print_line);
1070 $self->write_msg($resp);
1075 sub handle_item_information {
1076 my ($self, $server) = @_;
1077 my $ils = $server->{ils};
1079 my $fields = $self->{fields};
1080 my $resp = ITEM_INFO_RESP;
1084 ($trans_date) = @{$self->{fixed_fields}};
1086 $ils->check_inst_id($fields->{(FID_INST_ID)}, "handle_item_information");
1088 $item = $ils->find_item($fields->{(FID_ITEM_ID)});
1090 if (!defined($item)) {
1092 # "Other" circ stat, "Other" security marker, "Unknown" fee type
1094 $resp .= Sip::timestamp;
1095 # Just echo back the invalid item id
1096 $resp .= add_field(FID_ITEM_ID, $fields->{(FID_ITEM_ID)});
1097 # title id is required, but we don't have one
1098 $resp .= add_field(FID_TITLE_ID, '');
1100 # Valid Item ID, send the good stuff
1101 $resp .= $item->sip_circulation_status;
1102 $resp .= $item->sip_security_marker;
1103 $resp .= $item->sip_fee_type;
1104 $resp .= Sip::timestamp;
1106 $resp .= add_field(FID_ITEM_ID, $item->id);
1107 $resp .= add_field(FID_TITLE_ID, $item->title_id);
1109 $resp .= maybe_add(FID_MEDIA_TYPE, $item->sip_media_type);
1110 $resp .= maybe_add(FID_PERM_LOCN, $item->permanent_location);
1111 $resp .= maybe_add(FID_CURRENT_LOCN, $item->current_location);
1112 $resp .= maybe_add(FID_ITEM_PROPS, $item->sip_item_properties);
1114 if (($i = $item->fee) != 0) {
1115 $resp .= add_field(FID_CURRENCY, $item->fee_currency);
1116 $resp .= add_field(FID_FEE_AMT, $i);
1118 $resp .= maybe_add(FID_OWNER, $item->owner);
1120 if (($i = scalar @{$item->hold_queue}) > 0) {
1121 $resp .= add_field(FID_HOLD_QUEUE_LEN, $i);
1123 if ($item->due_date) {
1124 $resp .= add_field(FID_DUE_DATE, Sip::timestamp($item->due_date));
1126 if (($i = $item->recall_date) != 0) {
1127 $resp .= add_field(FID_RECALL_DATE, Sip::timestamp($i));
1129 if (($i = $item->hold_pickup_date) != 0) {
1130 $resp .= add_field(FID_HOLD_PICKUP_DATE, Sip::timestamp($i));
1133 $resp .= maybe_add(FID_SCREEN_MSG, $item->screen_msg);
1134 $resp .= maybe_add(FID_PRINT_LINE, $item->print_line);
1137 $self->write_msg($resp);
1139 return(ITEM_INFORMATION);
1142 sub handle_item_status_update {
1143 my ($self, $server) = @_;
1144 my $ils = $server->{ils};
1145 my ($trans_date, $item_id, $terminal_pwd, $item_props);
1146 my $fields = $self->{fields};
1149 my $resp = ITEM_STATUS_UPDATE_RESP;
1151 ($trans_date) = @{$self->{fixed_fields}};
1153 $ils->check_inst_id($fields->{(FID_INST_ID)});
1155 $item_id = $fields->{(FID_ITEM_ID)};
1156 $item_props = $fields->{(FID_ITEM_PROPS)};
1158 if (!defined($item_id)) {
1159 syslog("LOG_WARNING",
1160 "handle_item_status: received message without Item ID field");
1162 $item = $ils->find_item($item_id);
1168 $resp .= Sip::timestamp;
1169 $resp .= add_field(FID_ITEM_ID, $item_id);
1173 $status = $item->status_update($item_props);
1175 $resp .= $status->ok ? '1' : '0';
1176 $resp .= Sip::timestamp;
1178 $resp .= add_field(FID_ITEM_ID, $item->id);
1179 $resp .= add_field(FID_TITLE_ID, $item->title_id);
1180 $resp .= maybe_add(FID_ITEM_PROPS, $item->sip_item_properties);
1183 $resp .= maybe_add(FID_SCREEN_MSG, $status->screen_msg);
1184 $resp .= maybe_add(FID_PRINT_LINE, $status->print_line);
1186 $self->write_msg($resp);
1188 return(ITEM_STATUS_UPDATE);
1191 sub handle_patron_enable {
1192 my ($self, $server) = @_;
1193 my $ils = $server->{ils};
1194 my $fields = $self->{fields};
1195 my ($trans_date, $patron_id, $terminal_pwd, $patron_pwd);
1196 my ($status, $patron);
1197 my $resp = PATRON_ENABLE_RESP;
1199 ($trans_date) = @{$self->{fixed_fields}};
1200 $patron_id = $fields->{(FID_PATRON_ID)};
1201 $patron_pwd = $fields->{(FID_PATRON_PWD)};
1203 syslog("LOG_DEBUG", "handle_patron_enable: patron_id: '%s', patron_pwd: '%s'",
1204 $patron_id, $patron_pwd);
1206 $patron = $ils->find_patron($patron_id);
1208 if (!defined($patron)) {
1210 $resp .= 'YYYY' . (' ' x 10) . '000' . Sip::timestamp();
1211 $resp .= add_field(FID_PATRON_ID, $patron_id);
1212 $resp .= add_field(FID_PERSONAL_NAME, '');
1213 $resp .= add_field(FID_VALID_PATRON, 'N');
1214 $resp .= add_field(FID_VALID_PATRON_PWD, 'N');
1217 if (!defined($patron_pwd) || $patron->check_password($patron_pwd)) {
1218 # Don't enable the patron if there was an invalid password
1219 $status = $patron->enable;
1221 $resp .= patron_status_string($patron);
1222 $resp .= $patron->language . Sip::timestamp();
1224 $resp .= add_field(FID_PATRON_ID, $patron->id);
1225 $resp .= add_field(FID_PERSONAL_NAME, $patron->name);
1226 if (defined($patron_pwd)) {
1227 $resp .= add_field(FID_VALID_PATRON_PWD,
1228 sipbool($patron->check_password($patron_pwd)));
1230 $resp .= add_field(FID_VALID_PATRON, 'Y');
1231 $resp .= maybe_add(FID_SCREEN_MSG, $patron->screen_msg);
1232 $resp .= maybe_add(FID_PRINT_LINE, $patron->print_line);
1235 $resp .= add_field(FID_INST_ID, $ils->institution);
1237 $self->write_msg($resp);
1239 return(PATRON_ENABLE);
1243 my ($self, $server) = @_;
1244 my $ils = $server->{ils};
1245 my ($hold_mode, $trans_date);
1246 my ($expiry_date, $pickup_locn, $hold_type, $patron_id, $patron_pwd);
1247 my ($item_id, $title_id, $fee_ack);
1248 my $fields = $self->{fields};
1250 my $resp = HOLD_RESP;
1252 ($hold_mode, $trans_date) = @{$self->{fixed_fields}};
1254 $ils->check_inst_id($fields->{(FID_INST_ID)}, "handle_hold");
1256 $patron_id = $fields->{(FID_PATRON_ID) };
1257 $expiry_date = $fields->{(FID_EXPIRATION) } || '';
1258 $pickup_locn = $fields->{(FID_PICKUP_LOCN)} || '';
1259 $hold_type = $fields->{(FID_HOLD_TYPE) } || '2'; # Any copy of title
1260 $patron_pwd = $fields->{(FID_PATRON_PWD) };
1261 $item_id = $fields->{(FID_ITEM_ID) } || '';
1262 $title_id = $fields->{(FID_TITLE_ID) } || '';
1263 $fee_ack = $fields->{(FID_FEE_ACK) } || 'N';
1265 if ($hold_mode eq '+') {
1266 $status = $ils->add_hold($patron_id, $patron_pwd, $item_id, $title_id,
1267 $expiry_date, $pickup_locn, $hold_type, $fee_ack);
1268 } elsif ($hold_mode eq '-') {
1269 $status = $ils->cancel_hold($patron_id, $patron_pwd, $item_id, $title_id);
1270 } elsif ($hold_mode eq '*') {
1271 $status = $ils->alter_hold($patron_id, $patron_pwd, $item_id, $title_id,
1272 $expiry_date, $pickup_locn, $hold_type, $fee_ack);
1274 syslog("LOG_WARNING", "handle_hold: Unrecognized hold mode '%s' from terminal '%s'",
1275 $hold_mode, $server->{account}->{id});
1276 $status = $ils->Transaction::Hold; # new?
1277 $status->screen_msg("System error. Please contact library staff.");
1280 $resp .= $status->ok;
1281 $resp .= sipbool($status->item && $status->item->available($patron_id));
1282 $resp .= Sip::timestamp;
1285 $resp .= add_field(FID_PATRON_ID, $status->patron->id);
1287 ($status->expiration_date) and
1288 $resp .= maybe_add(FID_EXPIRATION,
1289 Sip::timestamp($status->expiration_date));
1290 $resp .= maybe_add(FID_QUEUE_POS, $status->queue_position);
1291 $resp .= maybe_add(FID_PICKUP_LOCN, $status->pickup_location);
1292 $resp .= maybe_add(FID_ITEM_ID, $status->item->id);
1293 $resp .= maybe_add(FID_TITLE_ID, $status->item->title_id);
1295 # Not ok. still need required fields
1296 $resp .= add_field(FID_PATRON_ID, $patron_id);
1299 $resp .= add_field(FID_INST_ID, $ils->institution);
1300 $resp .= maybe_add(FID_SCREEN_MSG, $status->screen_msg);
1301 $resp .= maybe_add(FID_PRINT_LINE, $status->print_line);
1303 $self->write_msg($resp);
1309 my ($self, $server) = @_;
1310 my $ils = $server->{ils};
1311 my ($third_party, $no_block, $trans_date, $nb_due_date);
1312 my ($patron_id, $patron_pwd, $item_id, $title_id, $item_props, $fee_ack);
1313 my $fields = $self->{fields};
1315 my ($patron, $item);
1316 my $resp = RENEW_RESP;
1318 ($third_party, $no_block, $trans_date, $nb_due_date) =
1319 @{$self->{fixed_fields}};
1321 $ils->check_inst_id($fields->{(FID_INST_ID)}, "handle_renew");
1323 if ($no_block eq 'Y') {
1324 syslog("LOG_WARNING",
1325 "handle_renew: recieved 'no block' renewal from terminal '%s'",
1326 $server->{account}->{id});
1329 $patron_id = $fields->{(FID_PATRON_ID)};
1330 $patron_pwd = $fields->{(FID_PATRON_PWD)};
1331 $item_id = $fields->{(FID_ITEM_ID)};
1332 $title_id = $fields->{(FID_TITLE_ID)};
1333 $item_props = $fields->{(FID_ITEM_PROPS)};
1334 $fee_ack = $fields->{(FID_FEE_ACK)};
1336 $status = $ils->renew($patron_id, $patron_pwd, $item_id, $title_id,
1337 $no_block, $nb_due_date, $third_party,
1338 $item_props, $fee_ack);
1340 $patron = $status->patron;
1341 $item = $status->item;
1345 $resp .= $status->renewal_ok ? 'Y' : 'N';
1346 if ($ils->supports('magnetic media')) {
1347 $resp .= sipbool($item->magnetic_media);
1351 $resp .= sipbool($status->desensitize);
1352 $resp .= Sip::timestamp;
1353 $resp .= add_field(FID_PATRON_ID, $patron->id);
1354 $resp .= add_field(FID_ITEM_ID, $item->id);
1355 $resp .= add_field(FID_TITLE_ID, $item->title_id);
1356 $resp .= add_field(FID_DUE_DATE, Sip::timestamp($item->due_date));
1357 if ($ils->supports('security inhibit')) {
1358 $resp .= add_field(FID_SECURITY_INHIBIT,
1359 $status->security_inhibit);
1361 $resp .= add_field(FID_MEDIA_TYPE, $item->sip_media_type);
1362 $resp .= maybe_add(FID_ITEM_PROPS, $item->sip_item_properties);
1364 # renew failed for some reason
1365 # not OK, renewal not OK, Unknown media type (why bother checking?)
1367 $resp .= Sip::timestamp;
1368 # If we found the patron or the item, the return the ILS
1369 # information, otherwise echo back the infomation we received
1371 $resp .= add_field(FID_PATRON_ID, $patron ? $patron->id : $patron_id);
1372 $resp .= add_field(FID_ITEM_ID, $item ? $item->id : $item_id );
1373 $resp .= add_field(FID_TITLE_ID, $item ? $item->title_id : $title_id );
1374 $resp .= add_field(FID_DUE_DATE, '');
1377 if ($status->fee_amount) {
1378 $resp .= add_field(FID_FEE_AMT, $status->fee_amount);
1379 $resp .= maybe_add(FID_CURRENCY, $status->sip_currency);
1380 $resp .= maybe_add(FID_FEE_TYPE, $status->sip_fee_type);
1381 $resp .= maybe_add(FID_TRANSACTION_ID, $status->transaction_id);
1384 $resp .= add_field(FID_INST_ID, $ils->institution);
1385 $resp .= maybe_add(FID_SCREEN_MSG, $status->screen_msg);
1386 $resp .= maybe_add(FID_PRINT_LINE, $status->print_line);
1388 $self->write_msg($resp);
1393 sub handle_renew_all {
1394 # my ($third_party, $no_block, $nb_due_date, $fee_ack, $patron);
1396 my ($self, $server) = @_;
1397 my $ils = $server->{ils};
1398 my ($trans_date, $patron_id, $patron_pwd, $terminal_pwd, $fee_ack);
1399 my $fields = $self->{fields};
1400 my $resp = RENEW_ALL_RESP;
1402 my (@renewed, @unrenewed);
1404 $ils->check_inst_id($fields->{(FID_INST_ID)}, "handle_renew_all");
1406 ($trans_date) = @{$self->{fixed_fields}};
1408 $patron_id = $fields->{(FID_PATRON_ID)};
1409 $patron_pwd = $fields->{(FID_PATRON_PWD)};
1410 $terminal_pwd = $fields->{(FID_TERMINAL_PWD)};
1411 $fee_ack = $fields->{(FID_FEE_ACK)};
1413 $status = $ils->renew_all($patron_id, $patron_pwd, $fee_ack);
1415 $resp .= $status->ok ? '1' : '0';
1418 $resp .= add_count("renew_all/renewed_count" , 0);
1419 $resp .= add_count("renew_all/unrenewed_count", 0);
1423 @renewed = (@{$status->renewed});
1424 @unrenewed = (@{$status->unrenewed});
1425 $resp .= add_count("renew_all/renewed_count" , scalar @renewed );
1426 $resp .= add_count("renew_all/unrenewed_count", scalar @unrenewed);
1429 $resp .= Sip::timestamp;
1430 $resp .= add_field(FID_INST_ID, $ils->institution);
1432 $resp .= join('', map(add_field(FID_RENEWED_ITEMS , $_), @renewed ));
1433 $resp .= join('', map(add_field(FID_UNRENEWED_ITEMS, $_), @unrenewed));
1435 $resp .= maybe_add(FID_SCREEN_MSG, $status->screen_msg);
1436 $resp .= maybe_add(FID_PRINT_LINE, $status->print_line);
1438 $self->write_msg($resp);
1444 # send_acs_status($self, $server)
1446 # Send an ACS Status message, which is contains lots of little fields
1447 # of information gleaned from all sorts of places.
1450 my @message_type_names = (
1451 "patron status request",
1456 "request sc/acs resend",
1458 "patron information",
1459 "end patron session",
1462 "item status update",
1469 sub send_acs_status {
1470 my ($self, $server, $screen_msg, $print_line) = @_;
1471 my $msg = ACS_STATUS;
1472 ($server) or die "send_acs_status error: no \$server argument received";
1473 my $account = $server->{account} or die "send_acs_status error: no 'account' in \$server object:\n" . Dumper($server);
1474 my $policy = $server->{policy} or die "send_acs_status error: no 'policy' in \$server object:\n" . Dumper($server);
1475 my $ils = $server->{ils} or die "send_acs_status error: no 'ils' in \$server object:\n" . Dumper($server);
1476 my ($online_status, $checkin_ok, $checkout_ok, $ACS_renewal_policy);
1477 my ($status_update_ok, $offline_ok, $timeout, $retries);
1479 $online_status = 'Y';
1480 $checkout_ok = sipbool($ils->checkout_ok);
1481 $checkin_ok = sipbool($ils->checkin_ok);
1482 $ACS_renewal_policy = sipbool($policy->{renewal});
1483 $status_update_ok = sipbool($ils->status_update_ok);
1484 $offline_ok = sipbool($ils->offline_ok);
1485 $timeout = sprintf("%03d", $policy->{timeout});
1486 $retries = sprintf("%03d", $policy->{retries});
1488 if (length($timeout) != 3) {
1489 syslog("LOG_ERR", "handle_acs_status: timeout field wrong size: '%s'",
1494 if (length($retries) != 3) {
1495 syslog("LOG_ERR", "handle_acs_status: retries field wrong size: '%s'",
1500 $msg .= "$online_status$checkin_ok$checkout_ok$ACS_renewal_policy";
1501 $msg .= "$status_update_ok$offline_ok$timeout$retries";
1502 $msg .= Sip::timestamp();
1504 if ($protocol_version == 1) {
1506 } elsif ($protocol_version == 2) {
1510 'Bad setting for $protocol_version, "%s" in send_acs_status',
1516 $msg .= add_field(FID_INST_ID, $account->{institution});
1518 if ($protocol_version >= 2) {
1519 # Supported messages: we do it all
1520 my $supported_msgs = '';
1522 foreach my $msg_name (@message_type_names) {
1523 if ($msg_name eq 'request sc/acs resend') {
1524 $supported_msgs .= Sip::sipbool(1);
1526 $supported_msgs .= Sip::sipbool($ils->supports($msg_name));
1529 if (length($supported_msgs) < 16) {
1530 syslog("LOG_ERR", 'send_acs_status: supported messages "%s" too short', $supported_msgs);
1532 $msg .= add_field(FID_SUPPORTED_MSGS, $supported_msgs);
1535 $msg .= maybe_add(FID_SCREEN_MSG, $screen_msg);
1537 if (defined($account->{print_width}) && defined($print_line)
1538 && $account->{print_width} < length($print_line)) {
1539 syslog("LOG_WARNING", "send_acs_status: print line '%s' too long. Truncating",
1541 $print_line = substr($print_line, 0, $account->{print_width});
1544 $msg .= maybe_add(FID_PRINT_LINE, $print_line);
1546 # Do we want to tell the terminal its location?
1548 $self->write_msg($msg);
1553 # build_patron_status: create the 14-char patron status
1554 # string for the Patron Status message
1556 sub patron_status_string {
1560 syslog("LOG_DEBUG", "patron_status_string: %s charge_ok: %s", $patron->id, $patron->charge_ok);
1561 $patron_status = sprintf(
1562 '%s%s%s%s%s%s%s%s%s%s%s%s%s%s',
1563 denied($patron->charge_ok),
1564 denied($patron->renew_ok),
1565 denied($patron->recall_ok),
1566 denied($patron->hold_ok),
1567 boolspace($patron->card_lost),
1568 boolspace($patron->too_many_charged),
1569 boolspace($patron->too_many_overdue),
1570 boolspace($patron->too_many_renewal),
1571 boolspace($patron->too_many_claim_return),
1572 boolspace($patron->too_many_lost),
1573 boolspace($patron->excessive_fines),
1574 boolspace($patron->excessive_fees),
1575 boolspace($patron->recall_overdue),
1576 boolspace($patron->too_many_billed)
1578 return $patron_status;
1582 my ($username,$password, $branch) = @_;
1583 $ENV{REMOTE_USER} = $username;
1584 my $query = CGI->new();
1585 $query->param(userid => $username);
1586 $query->param(password => $password);
1588 $query->param(branch => $branch);
1590 my ($status, $cookie, $sessionID) = check_api_auth($query, {circulate=>1}, 'intranet');