4 # A Class for handing SIP messages
7 package C4::SIP::Sip::MsgType;
12 use Sys::Syslog qw(syslog);
14 use C4::SIP::Sip qw(:all);
15 use C4::SIP::Sip::Constants qw(:all);
16 use C4::SIP::Sip::Checksum qw(verify_cksum);
20 use C4::Auth qw(&check_api_auth);
24 use vars qw(@ISA $VERSION @EXPORT_OK);
26 use constant INVALID_CARD => 'Invalid cardnumber';
27 use constant INVALID_PW => 'Invalid password';
30 $VERSION = 3.07.00.049;
32 @EXPORT_OK = qw(handle login_core);
35 # Predeclare handler subroutines
36 use subs qw(handle_patron_status handle_checkout handle_checkin
37 handle_block_patron handle_sc_status handle_request_acs_resend
38 handle_login handle_patron_info handle_end_patron_session
39 handle_fee_paid handle_item_information handle_item_status_update
40 handle_patron_enable handle_hold handle_renew handle_renew_all);
43 # For the most part, Version 2.00 of the protocol just adds new
44 # variable fields, but sometimes it changes the fixed header.
46 # In general, if there's no '2.00' protocol entry for a handler, that's
47 # because 2.00 didn't extend the 1.00 version of the protocol. This will
48 # be handled by the module initialization code following the declaration,
49 # which goes through the handlers table and creates a '2.00' entry that
50 # points to the same place as the '1.00' entry. If there's a 2.00 entry
51 # but no 1.00 entry, then that means that it's a completely new service
52 # in 2.00, so 1.00 shouldn't recognize it.
55 (PATRON_STATUS_REQ) => {
56 name => "Patron Status Request",
57 handler => \&handle_patron_status,
62 fields => [ (FID_INST_ID), (FID_PATRON_ID), (FID_TERMINAL_PWD), (FID_PATRON_PWD) ],
68 handler => \&handle_checkout,
71 template => "CCA18A18",
73 fields => [ (FID_INST_ID), (FID_PATRON_ID), (FID_ITEM_ID), (FID_TERMINAL_PWD) ],
76 template => "CCA18A18",
78 fields => [ (FID_INST_ID), (FID_PATRON_ID), (FID_ITEM_ID), (FID_TERMINAL_PWD), (FID_ITEM_PROPS), (FID_PATRON_PWD), (FID_FEE_ACK), (FID_CANCEL) ],
84 handler => \&handle_checkin,
87 template => "CA18A18",
89 fields => [ (FID_CURRENT_LOCN), (FID_INST_ID), (FID_ITEM_ID), (FID_TERMINAL_PWD) ],
92 template => "CA18A18",
94 fields => [ (FID_CURRENT_LOCN), (FID_INST_ID), (FID_ITEM_ID), (FID_TERMINAL_PWD), (FID_ITEM_PROPS), (FID_CANCEL) ],
99 name => "Block Patron",
100 handler => \&handle_block_patron,
105 fields => [ (FID_INST_ID), (FID_BLOCKED_CARD_MSG), (FID_PATRON_ID), (FID_TERMINAL_PWD) ],
111 handler => \&handle_sc_status,
120 (REQUEST_ACS_RESEND) => {
121 name => "Request ACS Resend",
122 handler => \&handle_request_acs_resend,
133 handler => \&handle_login,
138 fields => [ (FID_LOGIN_UID), (FID_LOGIN_PWD), (FID_LOCATION_CODE) ],
143 name => "Patron Info",
144 handler => \&handle_patron_info,
147 template => "A3A18A10",
149 fields => [ (FID_INST_ID), (FID_PATRON_ID), (FID_TERMINAL_PWD), (FID_PATRON_PWD), (FID_START_ITEM), (FID_END_ITEM) ],
153 (END_PATRON_SESSION) => {
154 name => "End Patron Session",
155 handler => \&handle_end_patron_session,
160 fields => [ (FID_INST_ID), (FID_PATRON_ID), (FID_TERMINAL_PWD), (FID_PATRON_PWD) ],
166 handler => \&handle_fee_paid,
169 template => "A18A2A2A3",
171 fields => [ (FID_FEE_AMT), (FID_INST_ID), (FID_PATRON_ID), (FID_TERMINAL_PWD), (FID_PATRON_PWD), (FID_FEE_ID), (FID_TRANSACTION_ID) ],
175 (ITEM_INFORMATION) => {
176 name => "Item Information",
177 handler => \&handle_item_information,
182 fields => [ (FID_INST_ID), (FID_ITEM_ID), (FID_TERMINAL_PWD) ],
186 (ITEM_STATUS_UPDATE) => {
187 name => "Item Status Update",
188 handler => \&handle_item_status_update,
193 fields => [ (FID_INST_ID), (FID_PATRON_ID), (FID_ITEM_ID), (FID_TERMINAL_PWD), (FID_ITEM_PROPS) ],
198 name => "Patron Enable",
199 handler => \&handle_patron_enable,
204 fields => [ (FID_INST_ID), (FID_PATRON_ID), (FID_TERMINAL_PWD), (FID_PATRON_PWD) ],
210 handler => \&handle_hold,
216 (FID_EXPIRATION), (FID_PICKUP_LOCN), (FID_HOLD_TYPE), (FID_INST_ID), (FID_PATRON_ID), (FID_PATRON_PWD),
217 (FID_ITEM_ID), (FID_TITLE_ID), (FID_TERMINAL_PWD), (FID_FEE_ACK)
224 handler => \&handle_renew,
227 template => "CCA18A18",
229 fields => [ (FID_INST_ID), (FID_PATRON_ID), (FID_PATRON_PWD), (FID_ITEM_ID), (FID_TITLE_ID), (FID_TERMINAL_PWD), (FID_ITEM_PROPS), (FID_FEE_ACK) ],
235 handler => \&handle_renew_all,
240 fields => [ (FID_INST_ID), (FID_PATRON_ID), (FID_PATRON_PWD), (FID_TERMINAL_PWD), (FID_FEE_ACK) ],
247 # Now, initialize some of the missing bits of %handlers
249 foreach my $i ( keys(%handlers) ) {
250 if ( !exists( $handlers{$i}->{protocol}->{2} ) ) {
251 $handlers{$i}->{protocol}->{2} = $handlers{$i}->{protocol}->{1};
256 my ( $class, $msg, $seqno ) = @_;
258 my $msgtag = substr( $msg, 0, 2 );
260 if ( $msgtag eq LOGIN ) {
262 # If the client is using the 2.00-style "Login" message
263 # to authenticate to the server, then we get the Login message
264 # _before_ the client has indicated that it supports 2.00, but
265 # it's using the 2.00 login process, so it must support 2.00.
266 $protocol_version = 2;
268 syslog( "LOG_DEBUG", "Sip::MsgType::new('%s', '%s...', '%s'): seq.no '%s', protocol %s", $class, substr( $msg, 0, 10 ), $msgtag, $seqno, $protocol_version );
270 # warn "SIP PROTOCOL: $protocol_version";
271 if ( !exists( $handlers{$msgtag} ) ) {
272 syslog( "LOG_WARNING", "new Sip::MsgType: Skipping message of unknown type '%s' in '%s'", $msgtag, $msg );
274 } elsif ( !exists( $handlers{$msgtag}->{protocol}->{$protocol_version} ) ) {
275 syslog( "LOG_WARNING", "new Sip::MsgType: Skipping message '%s' unsupported by protocol rev. '%d'", $msgtag, $protocol_version );
281 $self->{seqno} = $seqno;
282 $self->_initialize( substr( $msg, 2 ), $handlers{$msgtag} );
288 my ( $self, $msg, $control_block ) = @_;
290 my $proto = $control_block->{protocol}->{$protocol_version};
292 $self->{name} = $control_block->{name};
293 $self->{handler} = $control_block->{handler};
295 $self->{fields} = {};
296 $self->{fixed_fields} = [];
298 chomp($msg); # These four are probably unnecessary now.
303 foreach my $field ( @{ $proto->{fields} } ) {
304 $self->{fields}->{$field} = undef;
307 syslog( "LOG_DEBUG", "Sip::MsgType::_initialize('%s', '%s', '%s', '%s', ...)", $self->{name}, $msg, $proto->{template}, $proto->{template_len} );
309 $self->{fixed_fields} = [ unpack( $proto->{template}, $msg ) ]; # see http://perldoc.perl.org/5.8.8/functions/unpack.html
311 # Skip over the fixed fields and the split the rest of
312 # the message into fields based on the delimiter and parse them
313 foreach my $field ( split( quotemeta($field_delimiter), substr( $msg, $proto->{template_len} ) ) ) {
314 $fn = substr( $field, 0, 2 );
316 if ( !exists( $self->{fields}->{$fn} ) ) {
317 syslog( "LOG_WARNING", "Unsupported field '%s' in %s message '%s'", $fn, $self->{name}, $msg );
318 } elsif ( defined( $self->{fields}->{$fn} ) ) {
319 syslog( "LOG_WARNING", "Duplicate field '%s' (previous value '%s') in %s message '%s'", $fn, $self->{fields}->{$fn}, $self->{name}, $msg );
321 $self->{fields}->{$fn} = substr( $field, 2 );
329 my ( $msg, $server, $req ) = @_;
330 my $config = $server->{config};
334 # What's the field delimiter for variable length fields?
335 # This can't be based on the account, since we need to know
336 # the field delimiter to parse a SIP login message
338 if ( defined( $server->{config}->{delimiter} ) ) {
339 $field_delimiter = $server->{config}->{delimiter};
342 # error detection is active if this is a REQUEST_ACS_RESEND
343 # message with a checksum, or if the message is long enough
344 # and the last nine characters begin with a sequence number
346 if ( $msg eq REQUEST_ACS_RESEND_CKSUM ) {
349 $error_detection = 1;
350 $self = C4::SIP::Sip::MsgType->new( (REQUEST_ACS_RESEND), 0 );
351 } elsif ( ( length($msg) > 11 ) && ( substr( $msg, -9, 2 ) eq "AY" ) ) {
352 $error_detection = 1;
354 if ( !verify_cksum($msg) ) {
355 syslog( "LOG_WARNING", "Checksum failed on message '%s'", $msg );
357 # REQUEST_SC_RESEND with error detection
358 $last_response = REQUEST_SC_RESEND_CKSUM;
359 print("$last_response\r");
360 return REQUEST_ACS_RESEND;
363 # Save the sequence number, then strip off the
364 # error detection data to process the message
365 $self = C4::SIP::Sip::MsgType->new( substr( $msg, 0, -9 ), substr( $msg, -7, 1 ) );
367 } elsif ($error_detection) {
369 # We received a non-ED message when ED is supposed to be active.
370 # Warn about this problem, then process the message anyway.
371 syslog( "LOG_WARNING", "Received message without error detection: '%s'", $msg );
372 $error_detection = 0;
373 $self = C4::SIP::Sip::MsgType->new( $msg, 0 );
375 $self = C4::SIP::Sip::MsgType->new( $msg, 0 );
378 if ( ( substr( $msg, 0, 2 ) ne REQUEST_ACS_RESEND )
380 && ( substr( $msg, 0, 2 ) ne $req ) ) {
381 return substr( $msg, 0, 2 );
383 unless ( $self->{handler} ) {
384 syslog( "LOG_WARNING", "No handler defined for '%s'", $msg );
385 $last_response = REQUEST_SC_RESEND;
386 print("$last_response\r");
387 return REQUEST_ACS_RESEND;
389 return ( $self->{handler}->( $self, $server ) ); # FIXME
390 # FIXME: Use of uninitialized value in subroutine entry
391 # Can't use string ("") as a subroutine ref while "strict refs" in use
399 # Patron status messages are produced in response to both
400 # "Request Patron Status" and "Block Patron"
402 # Request Patron Status requires a patron password, but
403 # Block Patron doesn't (since the patron may never have
404 # provided one before attempting some illegal action).
406 # ASSUMPTION: If the patron password field is present in the
407 # message, then it must match, otherwise incomplete patron status
408 # information will be returned to the terminal.
410 sub build_patron_status {
411 my ( $patron, $lang, $fields, $server ) = @_;
413 my $patron_pwd = $fields->{ (FID_PATRON_PWD) };
414 my $resp = (PATRON_STATUS_RESP);
419 $password_rc = $patron->check_password($patron_pwd);
422 $resp .= patron_status_string($patron);
423 $resp .= $lang . timestamp();
424 $resp .= add_field( FID_PERSONAL_NAME, $patron->name );
426 # while the patron ID we got from the SC is valid, let's
427 # use the one returned from the ILS, just in case...
428 $resp .= add_field( FID_PATRON_ID, $patron->id );
430 if ( $protocol_version >= 2 ) {
431 $resp .= add_field( FID_VALID_PATRON, 'Y' );
433 # Patron password is a required field.
434 $resp .= add_field( FID_VALID_PATRON_PWD, sipbool($password_rc) );
435 $resp .= maybe_add( FID_CURRENCY, $patron->currency );
436 $resp .= maybe_add( FID_FEE_AMT, $patron->fee_amount );
439 my $msg = $patron->screen_msg;
440 $msg .= ' -- '. INVALID_PW if $patron_pwd && !$password_rc;
441 $resp .= maybe_add( FID_SCREEN_MSG, $msg, $server );
443 $resp .= maybe_add( FID_SCREEN_MSG, $patron->{branchcode}, $server )
444 if ( $server->{account}->{send_patron_home_library_in_af} );
445 $resp .= maybe_add( FID_PRINT_LINE, $patron->print_line );
448 # Invalid patron (cardnumber)
449 # Report that the user has no privs.
451 # no personal name, and is invalid (if we're using 2.00)
452 $resp .= 'YYYY' . ( ' ' x 10 ) . $lang . timestamp();
453 $resp .= add_field( FID_PERSONAL_NAME, '' );
455 # the patron ID is invalid, but it's a required field, so
457 $resp .= add_field( FID_PATRON_ID, $fields->{ (FID_PATRON_ID) } );
459 ( $protocol_version >= 2 )
460 and $resp .= add_field( FID_VALID_PATRON, 'N' );
462 $resp .= maybe_add( FID_SCREEN_MSG, INVALID_CARD, $server );
465 $resp .= add_field( FID_INST_ID, $fields->{ (FID_INST_ID) } );
469 sub handle_patron_status {
470 my ( $self, $server ) = @_;
471 warn "handle_patron_status server: " . Dumper( \$server );
472 my $ils = $server->{ils};
474 my $resp = (PATRON_STATUS_RESP);
475 my $account = $server->{account};
476 my ( $lang, $date ) = @{ $self->{fixed_fields} };
477 my $fields = $self->{fields};
479 #warn Dumper($fields);
481 #warn $fields->{(FID_INST_ID)};
482 $ils->check_inst_id( $fields->{ (FID_INST_ID) }, "handle_patron_status" );
483 $patron = $ils->find_patron( $fields->{ (FID_PATRON_ID) } );
484 $resp = build_patron_status( $patron, $lang, $fields, $server );
485 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
486 return (PATRON_STATUS_REQ);
489 sub handle_checkout {
490 my ( $self, $server ) = @_;
491 my $account = $server->{account};
492 my $ils = $server->{ils};
493 my $inst = $ils->institution;
494 my ( $sc_renewal_policy, $no_block, $trans_date, $nb_due_date );
496 my ( $patron_id, $item_id, $status );
497 my ( $item, $patron );
500 ( $sc_renewal_policy, $no_block, $trans_date, $nb_due_date ) = @{ $self->{fixed_fields} };
501 $fields = $self->{fields};
503 $patron_id = $fields->{ (FID_PATRON_ID) };
504 $item_id = $fields->{ (FID_ITEM_ID) };
505 my $fee_ack = $fields->{ (FID_FEE_ACK) };
507 if ( $no_block eq 'Y' ) {
509 # Off-line transactions need to be recorded, but there's
510 # not a lot we can do about it
511 syslog( "LOG_WARNING", "received no-block checkout from terminal '%s'", $account->{id} );
513 $status = $ils->checkout_no_block( $patron_id, $item_id, $sc_renewal_policy, $trans_date, $nb_due_date );
516 # Does the transaction date really matter for items that are
517 # checkout out while the terminal is online? I'm guessing 'no'
518 $status = $ils->checkout( $patron_id, $item_id, $sc_renewal_policy, $fee_ack );
521 $item = $status->item;
522 $patron = $status->patron;
526 # Item successfully checked out
528 $resp = CHECKOUT_RESP . '1';
529 $resp .= sipbool( $status->renew_ok );
530 if ( $ils->supports('magnetic media') ) {
531 $resp .= sipbool( $item->magnetic_media );
536 # We never return the obsolete 'U' value for 'desensitize'
537 $resp .= sipbool( $status->desensitize );
540 # Now for the variable fields
541 $resp .= add_field( FID_INST_ID, $inst );
542 $resp .= add_field( FID_PATRON_ID, $patron_id );
543 $resp .= add_field( FID_ITEM_ID, $item_id );
544 $resp .= add_field( FID_TITLE_ID, $item->title_id );
545 if ( $item->due_date ) {
546 $resp .= add_field( FID_DUE_DATE, timestamp( $item->due_date ) );
548 $resp .= add_field( FID_DUE_DATE, q{} );
551 $resp .= maybe_add( FID_SCREEN_MSG, $status->screen_msg, $server );
552 $resp .= maybe_add( FID_PRINT_LINE, $status->print_line );
554 if ( $protocol_version >= 2 ) {
555 if ( $ils->supports('security inhibit') ) {
556 $resp .= add_field( FID_SECURITY_INHIBIT, $status->security_inhibit );
558 $resp .= maybe_add( FID_MEDIA_TYPE, $item->sip_media_type );
559 $resp .= maybe_add( FID_ITEM_PROPS, $item->sip_item_properties );
567 # Checkout Response: not ok, no renewal, don't know mag. media,
569 $resp = sprintf( "120NUN%s", timestamp );
570 $resp .= add_field( FID_INST_ID, $inst );
571 $resp .= add_field( FID_PATRON_ID, $patron_id );
572 $resp .= add_field( FID_ITEM_ID, $item_id );
574 # If the item is valid, provide the title, otherwise
576 $resp .= add_field( FID_TITLE_ID, $item ? $item->title_id : '' );
578 # Due date is required. Since it didn't get checked out,
579 # it's not due, so leave the date blank
580 $resp .= add_field( FID_DUE_DATE, '' );
582 $resp .= maybe_add( FID_SCREEN_MSG, $status->screen_msg, $server );
583 $resp .= maybe_add( FID_PRINT_LINE, $status->print_line );
585 if ( $protocol_version >= 2 ) {
587 # Is the patron ID valid?
588 $resp .= add_field( FID_VALID_PATRON, sipbool($patron) );
590 if ( $patron && exists( $fields->{FID_PATRON_PWD} ) ) {
592 # Password provided, so we can tell if it was valid or not
593 $resp .= add_field( FID_VALID_PATRON_PWD, sipbool( $patron->check_password( $fields->{ (FID_PATRON_PWD) } ) ) );
598 if ( $protocol_version >= 2 ) {
600 # Financials : return irrespective of ok status
601 if ( $status->fee_amount ) {
602 $resp .= add_field( FID_FEE_AMT, $status->fee_amount );
603 $resp .= maybe_add( FID_CURRENCY, $status->sip_currency );
604 $resp .= maybe_add( FID_FEE_TYPE, $status->sip_fee_type );
605 $resp .= maybe_add( FID_TRANSACTION_ID, $status->transaction_id );
609 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
614 my ( $self, $server ) = @_;
615 my $account = $server->{account};
616 my $ils = $server->{ils};
617 my $my_branch = $ils->institution;
618 my ( $current_loc, $inst_id, $item_id, $terminal_pwd, $item_props, $cancel );
619 my ( $patron, $item, $status );
620 my $resp = CHECKIN_RESP;
621 my ( $no_block, $trans_date, $return_date ) = @{ $self->{fixed_fields} };
622 my $fields = $self->{fields};
624 $current_loc = $fields->{ (FID_CURRENT_LOCN) };
625 $inst_id = $fields->{ (FID_INST_ID) };
626 $item_id = $fields->{ (FID_ITEM_ID) };
627 $item_props = $fields->{ (FID_ITEM_PROPS) };
628 $cancel = $fields->{ (FID_CANCEL) };
630 $my_branch = $current_loc; # most scm do not set $current_loc
633 $ils->check_inst_id( $inst_id, "handle_checkin" );
635 if ( $no_block eq 'Y' ) {
637 # Off-line transactions, ick.
638 syslog( "LOG_WARNING", "received no-block checkin from terminal '%s'", $account->{id} );
639 $status = $ils->checkin_no_block( $item_id, $trans_date, $return_date, $item_props, $cancel );
641 $status = $ils->checkin( $item_id, $trans_date, $return_date, $my_branch, $item_props, $cancel, $account->{checked_in_ok} );
644 $patron = $status->patron;
645 $item = $status->item;
647 $resp .= $status->ok ? '1' : '0';
648 $resp .= $status->resensitize ? 'Y' : 'N';
649 if ( $item && $ils->supports('magnetic media') ) {
650 $resp .= sipbool( $item->magnetic_media );
653 # item barcode is invalid or system doesn't support 'magnetic media' indicator
657 # apparently we can't trust the returns from Checkin yet (because C4::Circulation::AddReturn is faulty)
658 # So we reproduce the alert logic here.
659 if ( not $status->alert ) {
660 if ( $item->destination_loc and $item->destination_loc ne $my_branch ) {
662 $status->alert_type('04'); # no hold, just send it
665 $resp .= $status->alert ? 'Y' : 'N';
667 $resp .= add_field( FID_INST_ID, $inst_id );
668 $resp .= add_field( FID_ITEM_ID, $item_id );
671 $resp .= add_field( FID_PERM_LOCN, $item->permanent_location );
672 $resp .= maybe_add( FID_TITLE_ID, $item->title_id );
675 if ( $protocol_version >= 2 ) {
676 $resp .= maybe_add( FID_SORT_BIN, $status->sort_bin );
678 $resp .= add_field( FID_PATRON_ID, $patron->id );
681 $resp .= maybe_add( FID_MEDIA_TYPE, $item->sip_media_type );
682 $resp .= maybe_add( FID_ITEM_PROPS, $item->sip_item_properties );
683 $resp .= maybe_add( FID_COLLECTION_CODE, $item->collection_code );
684 $resp .= maybe_add( FID_CALL_NUMBER, $item->call_number );
685 $resp .= maybe_add( FID_DESTINATION_LOCATION, $item->destination_loc );
686 $resp .= maybe_add( FID_HOLD_PATRON_ID, $item->hold_patron_bcode );
687 $resp .= maybe_add( FID_HOLD_PATRON_NAME, $item->hold_patron_name );
688 if ( $status->hold and $status->hold->{branchcode} ne $item->destination_loc ) {
689 warn 'SIP hold mismatch: $status->hold->{branchcode}=' . $status->hold->{branchcode} . '; $item->destination_loc=' . $item->destination_loc;
691 # just me being paranoid.
696 $resp .= maybe_add( FID_ALERT_TYPE, $status->alert_type ) if $status->alert;
697 $resp .= maybe_add( FID_SCREEN_MSG, $status->screen_msg, $server );
698 $resp .= maybe_add( FID_PRINT_LINE, $status->print_line );
700 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
705 sub handle_block_patron {
706 my ( $self, $server ) = @_;
707 my $account = $server->{account};
708 my $ils = $server->{ils};
709 my ( $card_retained, $trans_date );
710 my ( $inst_id, $blocked_card_msg, $patron_id, $terminal_pwd );
711 my ( $fields, $resp, $patron );
713 ( $card_retained, $trans_date ) = @{ $self->{fixed_fields} };
714 $fields = $self->{fields};
715 $inst_id = $fields->{ (FID_INST_ID) };
716 $blocked_card_msg = $fields->{ (FID_BLOCKED_CARD_MSG) };
717 $patron_id = $fields->{ (FID_PATRON_ID) };
718 $terminal_pwd = $fields->{ (FID_TERMINAL_PWD) };
720 # Terminal passwords are different from account login
721 # passwords, but I have no idea what to do with them. So,
722 # I'll just ignore them for now.
726 $ils->check_inst_id( $inst_id, "block_patron" );
727 $patron = $ils->find_patron($patron_id);
729 # The correct response for a "Block Patron" message is a
730 # "Patron Status Response", so use that handler to generate
731 # the message, but then return the correct code from here.
733 # Normally, the language is provided by the "Patron Status"
734 # fixed field, but since we're not responding to one of those
735 # we'll just say, "Unspecified", as per the spec. Let the
736 # terminal default to something that, one hopes, will be
741 $patron->block( $card_retained, $blocked_card_msg );
744 $resp = build_patron_status( $patron, $patron->language, $fields, $server );
745 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
746 return (BLOCK_PATRON);
749 sub handle_sc_status {
750 my ( $self, $server ) = @_;
751 ($server) or warn "handle_sc_status error: no \$server argument received.";
752 my ( $status, $print_width, $sc_protocol_version ) = @{ $self->{fixed_fields} };
755 if ( $sc_protocol_version =~ /^1\./ ) {
757 } elsif ( $sc_protocol_version =~ /^2\./ ) {
760 syslog( "LOG_WARNING", "Unrecognized protocol revision '%s', falling back to '1'", $sc_protocol_version );
764 if ( $new_proto != $protocol_version ) {
765 syslog( "LOG_INFO", "Setting protocol level to $new_proto" );
766 $protocol_version = $new_proto;
769 if ( $status == SC_STATUS_PAPER ) {
770 syslog( "LOG_WARNING", "Self-Check unit '%s@%s' out of paper", $self->{account}->{id}, $self->{account}->{institution} );
771 } elsif ( $status == SC_STATUS_SHUTDOWN ) {
772 syslog( "LOG_WARNING", "Self-Check unit '%s@%s' shutting down", $self->{account}->{id}, $self->{account}->{institution} );
775 $self->{account}->{print_width} = $print_width;
776 return ( send_acs_status( $self, $server ) ? SC_STATUS : '' );
779 sub handle_request_acs_resend {
780 my ( $self, $server ) = @_;
782 if ( !$last_response ) {
784 # We haven't sent anything yet, so respond with a
785 # REQUEST_SC_RESEND msg (p. 16)
786 $self->write_msg( REQUEST_SC_RESEND, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
787 } elsif ( ( length($last_response) < 9 )
788 || substr( $last_response, -9, 2 ) ne 'AY' ) {
790 # When resending a message, we aren't supposed to include
791 # a sequence number, even if the original had one (p. 4).
792 # If the last message didn't have a sequence number, then
793 # we can just send it.
794 print("$last_response\r"); # not write_msg?
797 # Cut out the sequence number and checksum, since the old
798 # checksum is wrong for the resent message.
799 my $rebuilt = substr( $last_response, 0, -9 );
800 $self->write_msg( $rebuilt, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
803 return REQUEST_ACS_RESEND;
807 my $server = shift or return;
810 my $status = 1; # Assume it all works
811 if ( !exists( $server->{config}->{accounts}->{$uid} ) ) {
812 syslog( "LOG_WARNING", "MsgType::login_core: Unknown login '$uid'" );
814 } elsif ( $server->{config}->{accounts}->{$uid}->{password} ne $pwd ) {
815 syslog( "LOG_WARNING", "MsgType::login_core: Invalid password for login '$uid'" );
819 # Store the active account someplace handy for everybody else to find.
820 $server->{account} = $server->{config}->{accounts}->{$uid};
821 my $inst = $server->{account}->{institution};
822 $server->{institution} = $server->{config}->{institutions}->{$inst};
823 $server->{policy} = $server->{institution}->{policy};
824 $server->{sip_username} = $uid;
825 $server->{sip_password} = $pwd;
827 my $auth_status = api_auth( $uid, $pwd, $inst );
828 if ( !$auth_status or $auth_status !~ /^ok$/i ) {
829 syslog( "LOG_WARNING", "api_auth failed for SIP terminal '%s' of '%s': %s", $uid, $inst, ( $auth_status || 'unknown' ) );
832 syslog( "LOG_INFO", "Successful login/auth for '%s' of '%s'", $server->{account}->{id}, $inst );
835 # initialize connection to ILS
837 my $module = $server->{config}->{institutions}->{$inst}->{implementation};
838 syslog( "LOG_DEBUG", 'login_core: ' . Dumper($module) );
840 # Suspect this is always ILS but so we don't break any eccentic install (for now)
841 if ( $module eq 'ILS' ) {
842 $module = 'C4::SIP::ILS';
846 syslog( "LOG_ERR", "%s: Loading ILS implementation '%s' for institution '%s' failed", $server->{service}, $module, $inst );
847 die("Failed to load ILS implementation '$module' for $inst");
850 # like ILS->new(), I think.
851 $server->{ils} = $module->new( $server->{institution}, $server->{account} );
852 if ( !$server->{ils} ) {
853 syslog( "LOG_ERR", "%s: ILS connection to '%s' failed", $server->{service}, $inst );
854 die("Unable to connect to ILS '$inst'");
862 my ( $self, $server ) = @_;
863 my ( $uid_algorithm, $pwd_algorithm );
867 my $status = 1; # Assume it all works
869 $fields = $self->{fields};
870 ( $uid_algorithm, $pwd_algorithm ) = @{ $self->{fixed_fields} };
872 $uid = $fields->{ (FID_LOGIN_UID) }; # Terminal ID, not patron ID.
873 $pwd = $fields->{ (FID_LOGIN_PWD) }; # Terminal PWD, not patron PWD.
875 if ( $uid_algorithm || $pwd_algorithm ) {
876 syslog( "LOG_ERR", "LOGIN: Unsupported non-zero encryption method(s): uid = $uid_algorithm, pwd = $pwd_algorithm" );
879 $status = login_core( $server, $uid, $pwd );
882 $self->write_msg( LOGIN_RESP . $status, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
883 return $status ? LOGIN : '';
887 # Build the detailed summary information for the Patron
888 # Information Response message based on the first 'Y' that appears
889 # in the 'summary' field of the Patron Information request. The
890 # specification says that only one 'Y' can appear in that field,
891 # and we're going to believe it.
894 my ( $ils, $patron, $summary, $start, $end ) = @_;
899 # Map from offsets in the "summary" field of the Patron Information
900 # message to the corresponding field and handler
903 { func => $patron->can("hold_items"), fid => FID_HOLD_ITEMS },
904 { func => $patron->can("overdue_items"), fid => FID_OVERDUE_ITEMS },
905 { func => $patron->can("charged_items"), fid => FID_CHARGED_ITEMS },
906 { func => $patron->can("fine_items"), fid => FID_FINE_ITEMS },
907 { func => $patron->can("recall_items"), fid => FID_RECALL_ITEMS },
908 { func => $patron->can("unavail_holds"), fid => FID_UNAVAILABLE_HOLD_ITEMS },
911 if ( ( $summary_type = index( $summary, 'Y' ) ) == -1 ) {
912 return ''; # No detailed information required
915 syslog( "LOG_DEBUG", "Summary_info: index == '%d', field '%s'", $summary_type, $summary_map[$summary_type]->{fid} );
917 my $func = $summary_map[$summary_type]->{func};
918 my $fid = $summary_map[$summary_type]->{fid};
919 my $itemlist = &$func( $patron, $start, $end );
921 syslog( "LOG_DEBUG", "summary_info: list = (%s)", join( ", ", @{$itemlist} ) );
922 foreach my $i ( @{$itemlist} ) {
923 $resp .= add_field( $fid, $i->{barcode} );
929 sub handle_patron_info {
930 my ( $self, $server ) = @_;
931 my $ils = $server->{ils};
932 my ( $lang, $trans_date, $summary ) = @{ $self->{fixed_fields} };
933 my $fields = $self->{fields};
934 my ( $inst_id, $patron_id, $terminal_pwd, $patron_pwd, $start, $end );
935 my ( $resp, $patron );
937 $inst_id = $fields->{ (FID_INST_ID) };
938 $patron_id = $fields->{ (FID_PATRON_ID) };
939 $terminal_pwd = $fields->{ (FID_TERMINAL_PWD) };
940 $patron_pwd = $fields->{ (FID_PATRON_PWD) };
941 $start = $fields->{ (FID_START_ITEM) };
942 $end = $fields->{ (FID_END_ITEM) };
944 $patron = $ils->find_patron($patron_id);
946 $resp = (PATRON_INFO_RESP);
948 $resp .= patron_status_string($patron);
949 $resp .= ( defined($lang) and length($lang) == 3 ) ? $lang : $patron->language;
950 $resp .= timestamp();
952 $resp .= add_count( 'patron_info/hold_items', scalar @{ $patron->hold_items } );
953 $resp .= add_count( 'patron_info/overdue_items', scalar @{ $patron->overdue_items } );
954 $resp .= add_count( 'patron_info/charged_items', scalar @{ $patron->charged_items } );
955 $resp .= add_count( 'patron_info/fine_items', scalar @{ $patron->fine_items } );
956 $resp .= add_count( 'patron_info/recall_items', scalar @{ $patron->recall_items } );
957 $resp .= add_count( 'patron_info/unavail_holds', scalar @{ $patron->unavail_holds } );
959 $resp .= add_field( FID_INST_ID, ( $ils->institution_id || 'SIP2' ) );
961 # while the patron ID we got from the SC is valid, let's
962 # use the one returned from the ILS, just in case...
963 $resp .= add_field( FID_PATRON_ID, $patron->id );
964 $resp .= add_field( FID_PERSONAL_NAME, $patron->name );
966 # TODO: add code for the fields
968 # overdue items limit
969 # charged items limit
971 $resp .= add_field( FID_VALID_PATRON, 'Y' );
973 if ( defined($patron_pwd) ) {
975 # If patron password was provided, report whether it was right or not.
976 $password_rc = $patron->check_password($patron_pwd);
977 $resp .= add_field( FID_VALID_PATRON_PWD, sipbool( $password_rc ) );
980 $resp .= maybe_add( FID_CURRENCY, $patron->currency );
981 $resp .= maybe_add( FID_FEE_AMT, $patron->fee_amount );
982 $resp .= add_field( FID_FEE_LMT, $patron->fee_limit );
984 # TODO: zero or more item details for 2.0 can go here:
991 $resp .= summary_info( $ils, $patron, $summary, $start, $end );
993 $resp .= maybe_add( FID_HOME_ADDR, $patron->address );
994 $resp .= maybe_add( FID_EMAIL, $patron->email_addr );
995 $resp .= maybe_add( FID_HOME_PHONE, $patron->home_phone );
997 # SIP 2.0 extensions used by Envisionware
998 # Other terminals will ignore unrecognized fields (unrecognized field identifiers)
999 $resp .= maybe_add( FID_PATRON_BIRTHDATE, $patron->birthdate );
1000 $resp .= maybe_add( FID_PATRON_CLASS, $patron->ptype );
1002 # Custom protocol extension to report patron internet privileges
1003 $resp .= maybe_add( FID_INET_PROFILE, $patron->inet_privileges );
1005 my $msg = $patron->screen_msg;
1006 if( defined( $patron_pwd ) && !$password_rc ) {
1007 $msg .= ' -- ' . INVALID_PW;
1009 if ( $server->{account}->{send_patron_home_library_in_af} ) {
1010 $msg .= ' -- ' . $patron->{branchcode};
1012 $resp .= maybe_add( FID_SCREEN_MSG, $msg, $server );
1013 $resp .= maybe_add( FID_PRINT_LINE, $patron->print_line );
1016 # Invalid patron ID:
1017 # no privileges, no items associated,
1018 # no personal name, and is invalid (if we're using 2.00)
1019 $resp .= 'YYYY' . ( ' ' x 10 ) . $lang . timestamp();
1020 $resp .= '0000' x 6;
1022 $resp .= add_field( FID_INST_ID, ( $ils->institution_id || 'SIP2' ) );
1024 # patron ID is invalid, but field is required, so just echo it back
1025 $resp .= add_field( FID_PATRON_ID, $fields->{ (FID_PATRON_ID) } );
1026 $resp .= add_field( FID_PERSONAL_NAME, '' );
1028 if ( $protocol_version >= 2 ) {
1029 $resp .= add_field( FID_VALID_PATRON, 'N' );
1031 $resp .= maybe_add( FID_SCREEN_MSG, INVALID_CARD, $server );
1034 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1035 return (PATRON_INFO);
1038 sub handle_end_patron_session {
1039 my ( $self, $server ) = @_;
1040 my $ils = $server->{ils};
1042 my $fields = $self->{fields};
1043 my $resp = END_SESSION_RESP;
1044 my ( $status, $screen_msg, $print_line );
1046 ($trans_date) = @{ $self->{fixed_fields} };
1048 $ils->check_inst_id( $fields->{ (FID_INST_ID) }, 'handle_end_patron_session' );
1050 ( $status, $screen_msg, $print_line ) = $ils->end_patron_session( $fields->{ (FID_PATRON_ID) } );
1052 $resp .= $status ? 'Y' : 'N';
1053 $resp .= timestamp();
1055 $resp .= add_field( FID_INST_ID, $server->{ils}->institution );
1056 $resp .= add_field( FID_PATRON_ID, $fields->{ (FID_PATRON_ID) } );
1058 $resp .= maybe_add( FID_SCREEN_MSG, $screen_msg, $server );
1059 $resp .= maybe_add( FID_PRINT_LINE, $print_line );
1061 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1063 return (END_PATRON_SESSION);
1066 sub handle_fee_paid {
1067 my ( $self, $server ) = @_;
1068 my $ils = $server->{ils};
1069 my ( $trans_date, $fee_type, $pay_type, $currency ) = @{ $self->{fixed_fields} };
1070 my $fields = $self->{fields};
1071 my ( $fee_amt, $inst_id, $patron_id, $terminal_pwd, $patron_pwd );
1072 my ( $fee_id, $trans_id );
1074 my $resp = FEE_PAID_RESP;
1076 $fee_amt = $fields->{ (FID_FEE_AMT) };
1077 $inst_id = $fields->{ (FID_INST_ID) };
1078 $patron_id = $fields->{ (FID_PATRON_ID) };
1079 $patron_pwd = $fields->{ (FID_PATRON_PWD) };
1080 $fee_id = $fields->{ (FID_FEE_ID) };
1081 $trans_id = $fields->{ (FID_TRANSACTION_ID) };
1083 $ils->check_inst_id( $inst_id, "handle_fee_paid" );
1085 $status = $ils->pay_fee( $patron_id, $patron_pwd, $fee_amt, $fee_type, $pay_type, $fee_id, $trans_id, $currency );
1087 $resp .= ( $status->ok ? 'Y' : 'N' ) . timestamp;
1088 $resp .= add_field( FID_INST_ID, $inst_id );
1089 $resp .= add_field( FID_PATRON_ID, $patron_id );
1090 $resp .= maybe_add( FID_TRANSACTION_ID, $status->transaction_id );
1091 $resp .= maybe_add( FID_SCREEN_MSG, $status->screen_msg, $server );
1092 $resp .= maybe_add( FID_PRINT_LINE, $status->print_line );
1094 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1099 sub handle_item_information {
1100 my ( $self, $server ) = @_;
1101 my $ils = $server->{ils};
1103 my $fields = $self->{fields};
1104 my $resp = ITEM_INFO_RESP;
1108 ($trans_date) = @{ $self->{fixed_fields} };
1110 $ils->check_inst_id( $fields->{ (FID_INST_ID) }, "handle_item_information" );
1112 $item = $ils->find_item( $fields->{ (FID_ITEM_ID) } );
1114 if ( !defined($item) ) {
1117 # "Other" circ stat, "Other" security marker, "Unknown" fee type
1121 # Just echo back the invalid item id
1122 $resp .= add_field( FID_ITEM_ID, $fields->{ (FID_ITEM_ID) } );
1124 # title id is required, but we don't have one
1125 $resp .= add_field( FID_TITLE_ID, '' );
1128 # Valid Item ID, send the good stuff
1129 $resp .= $item->sip_circulation_status;
1130 $resp .= $item->sip_security_marker;
1131 $resp .= $item->sip_fee_type;
1134 $resp .= add_field( FID_ITEM_ID, $item->id );
1135 $resp .= add_field( FID_TITLE_ID, $item->title_id );
1137 $resp .= maybe_add( FID_MEDIA_TYPE, $item->sip_media_type );
1138 $resp .= maybe_add( FID_PERM_LOCN, $item->permanent_location );
1139 $resp .= maybe_add( FID_CURRENT_LOCN, $item->current_location );
1140 $resp .= maybe_add( FID_ITEM_PROPS, $item->sip_item_properties );
1142 if ( ( $i = $item->fee ) != 0 ) {
1143 $resp .= add_field( FID_CURRENCY, $item->fee_currency );
1144 $resp .= add_field( FID_FEE_AMT, $i );
1146 $resp .= maybe_add( FID_OWNER, $item->owner );
1148 if ( ( $i = scalar @{ $item->hold_queue } ) > 0 ) {
1149 $resp .= add_field( FID_HOLD_QUEUE_LEN, $i );
1151 if ( $item->due_date ) {
1152 $resp .= add_field( FID_DUE_DATE, timestamp( $item->due_date ) );
1154 if ( ( $i = $item->recall_date ) != 0 ) {
1155 $resp .= add_field( FID_RECALL_DATE, timestamp($i) );
1157 if ( ( $i = $item->hold_pickup_date ) != 0 ) {
1158 $resp .= add_field( FID_HOLD_PICKUP_DATE, timestamp($i) );
1161 $resp .= maybe_add( FID_SCREEN_MSG, $item->screen_msg, $server );
1162 $resp .= maybe_add( FID_PRINT_LINE, $item->print_line );
1165 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1167 return (ITEM_INFORMATION);
1170 sub handle_item_status_update {
1171 my ( $self, $server ) = @_;
1172 my $ils = $server->{ils};
1173 my ( $trans_date, $item_id, $terminal_pwd, $item_props );
1174 my $fields = $self->{fields};
1177 my $resp = ITEM_STATUS_UPDATE_RESP;
1179 ($trans_date) = @{ $self->{fixed_fields} };
1181 $ils->check_inst_id( $fields->{ (FID_INST_ID) } );
1183 $item_id = $fields->{ (FID_ITEM_ID) };
1184 $item_props = $fields->{ (FID_ITEM_PROPS) };
1186 if ( !defined($item_id) ) {
1187 syslog( "LOG_WARNING", "handle_item_status: received message without Item ID field" );
1189 $item = $ils->find_item($item_id);
1197 $resp .= add_field( FID_ITEM_ID, $item_id );
1202 $status = $item->status_update($item_props);
1204 $resp .= $status->ok ? '1' : '0';
1207 $resp .= add_field( FID_ITEM_ID, $item->id );
1208 $resp .= add_field( FID_TITLE_ID, $item->title_id );
1209 $resp .= maybe_add( FID_ITEM_PROPS, $item->sip_item_properties );
1212 $resp .= maybe_add( FID_SCREEN_MSG, $status->screen_msg, $server );
1213 $resp .= maybe_add( FID_PRINT_LINE, $status->print_line );
1215 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1217 return (ITEM_STATUS_UPDATE);
1220 sub handle_patron_enable {
1221 my ( $self, $server ) = @_;
1222 my $ils = $server->{ils};
1223 my $fields = $self->{fields};
1224 my ( $trans_date, $patron_id, $terminal_pwd, $patron_pwd );
1225 my ( $status, $patron );
1226 my $resp = PATRON_ENABLE_RESP;
1228 ($trans_date) = @{ $self->{fixed_fields} };
1229 $patron_id = $fields->{ (FID_PATRON_ID) };
1230 $patron_pwd = $fields->{ (FID_PATRON_PWD) };
1232 syslog( "LOG_DEBUG", "handle_patron_enable: patron_id: '%s', patron_pwd: '%s'", $patron_id, $patron_pwd );
1234 $patron = $ils->find_patron($patron_id);
1236 if ( !defined($patron) ) {
1239 $resp .= 'YYYY' . ( ' ' x 10 ) . '000' . timestamp();
1240 $resp .= add_field( FID_PATRON_ID, $patron_id );
1241 $resp .= add_field( FID_PERSONAL_NAME, '' );
1242 $resp .= add_field( FID_VALID_PATRON, 'N' );
1243 $resp .= add_field( FID_VALID_PATRON_PWD, 'N' );
1247 if ( !defined($patron_pwd) || $patron->check_password($patron_pwd) ) {
1249 # Don't enable the patron if there was an invalid password
1250 $status = $patron->enable;
1252 $resp .= patron_status_string($patron);
1253 $resp .= $patron->language . timestamp();
1255 $resp .= add_field( FID_PATRON_ID, $patron->id );
1256 $resp .= add_field( FID_PERSONAL_NAME, $patron->name );
1257 if ( defined($patron_pwd) ) {
1258 $resp .= add_field( FID_VALID_PATRON_PWD, sipbool( $patron->check_password($patron_pwd) ) );
1260 $resp .= add_field( FID_VALID_PATRON, 'Y' );
1261 $resp .= maybe_add( FID_SCREEN_MSG, $patron->screen_msg, $server );
1262 $resp .= maybe_add( FID_PRINT_LINE, $patron->print_line );
1265 $resp .= add_field( FID_INST_ID, $ils->institution );
1267 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1269 return (PATRON_ENABLE);
1273 my ( $self, $server ) = @_;
1274 my $ils = $server->{ils};
1275 my ( $hold_mode, $trans_date );
1276 my ( $expiry_date, $pickup_locn, $hold_type, $patron_id, $patron_pwd );
1277 my ( $item_id, $title_id, $fee_ack );
1278 my $fields = $self->{fields};
1280 my $resp = HOLD_RESP;
1282 ( $hold_mode, $trans_date ) = @{ $self->{fixed_fields} };
1284 $ils->check_inst_id( $fields->{ (FID_INST_ID) }, "handle_hold" );
1286 $patron_id = $fields->{ (FID_PATRON_ID) };
1287 $expiry_date = $fields->{ (FID_EXPIRATION) } || '';
1288 $pickup_locn = $fields->{ (FID_PICKUP_LOCN) } || '';
1289 $hold_type = $fields->{ (FID_HOLD_TYPE) } || '2'; # Any copy of title
1290 $patron_pwd = $fields->{ (FID_PATRON_PWD) };
1291 $item_id = $fields->{ (FID_ITEM_ID) } || '';
1292 $title_id = $fields->{ (FID_TITLE_ID) } || '';
1293 $fee_ack = $fields->{ (FID_FEE_ACK) } || 'N';
1295 if ( $hold_mode eq '+' ) {
1296 $status = $ils->add_hold( $patron_id, $patron_pwd, $item_id, $title_id, $expiry_date, $pickup_locn, $hold_type, $fee_ack );
1297 } elsif ( $hold_mode eq '-' ) {
1298 $status = $ils->cancel_hold( $patron_id, $patron_pwd, $item_id, $title_id );
1299 } elsif ( $hold_mode eq '*' ) {
1300 $status = $ils->alter_hold( $patron_id, $patron_pwd, $item_id, $title_id, $expiry_date, $pickup_locn, $hold_type, $fee_ack );
1302 syslog( "LOG_WARNING", "handle_hold: Unrecognized hold mode '%s' from terminal '%s'", $hold_mode, $server->{account}->{id} );
1303 $status = $ils->Transaction::Hold; # new?
1304 $status->screen_msg("System error. Please contact library staff.");
1307 $resp .= $status->ok;
1308 $resp .= sipbool( $status->item && $status->item->available($patron_id) );
1311 if ( $status->ok ) {
1312 $resp .= add_field( FID_PATRON_ID, $status->patron->id );
1314 ( $status->expiration_date )
1315 and $resp .= maybe_add( FID_EXPIRATION, timestamp( $status->expiration_date ) );
1316 $resp .= maybe_add( FID_QUEUE_POS, $status->queue_position );
1317 $resp .= maybe_add( FID_PICKUP_LOCN, $status->pickup_location );
1318 $resp .= maybe_add( FID_ITEM_ID, $status->item->id );
1319 $resp .= maybe_add( FID_TITLE_ID, $status->item->title_id );
1322 # Not ok. still need required fields
1323 $resp .= add_field( FID_PATRON_ID, $patron_id );
1326 $resp .= add_field( FID_INST_ID, $ils->institution );
1327 $resp .= maybe_add( FID_SCREEN_MSG, $status->screen_msg, $server );
1328 $resp .= maybe_add( FID_PRINT_LINE, $status->print_line );
1330 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1336 my ( $self, $server ) = @_;
1337 my $ils = $server->{ils};
1338 my ( $third_party, $no_block, $trans_date, $nb_due_date );
1339 my ( $patron_id, $patron_pwd, $item_id, $title_id, $item_props, $fee_ack );
1340 my $fields = $self->{fields};
1342 my ( $patron, $item );
1343 my $resp = RENEW_RESP;
1345 ( $third_party, $no_block, $trans_date, $nb_due_date ) = @{ $self->{fixed_fields} };
1347 $ils->check_inst_id( $fields->{ (FID_INST_ID) }, "handle_renew" );
1349 if ( $no_block eq 'Y' ) {
1350 syslog( "LOG_WARNING", "handle_renew: received 'no block' renewal from terminal '%s'", $server->{account}->{id} );
1353 $patron_id = $fields->{ (FID_PATRON_ID) };
1354 $patron_pwd = $fields->{ (FID_PATRON_PWD) };
1355 $item_id = $fields->{ (FID_ITEM_ID) };
1356 $title_id = $fields->{ (FID_TITLE_ID) };
1357 $item_props = $fields->{ (FID_ITEM_PROPS) };
1358 $fee_ack = $fields->{ (FID_FEE_ACK) };
1360 $status = $ils->renew( $patron_id, $patron_pwd, $item_id, $title_id, $no_block, $nb_due_date, $third_party, $item_props, $fee_ack );
1362 $patron = $status->patron;
1363 $item = $status->item;
1365 if ( $status->renewal_ok ) {
1367 $resp .= $status->renewal_ok ? 'Y' : 'N';
1368 if ( $ils->supports('magnetic media') ) {
1369 $resp .= sipbool( $item->magnetic_media );
1373 $resp .= sipbool( $status->desensitize );
1375 $resp .= add_field( FID_PATRON_ID, $patron->id );
1376 $resp .= add_field( FID_ITEM_ID, $item->id );
1377 $resp .= add_field( FID_TITLE_ID, $item->title_id );
1378 if ( $item->due_date ) {
1379 $resp .= add_field( FID_DUE_DATE, timestamp( $item->due_date ) );
1381 $resp .= add_field( FID_DUE_DATE, q{} );
1383 if ( $ils->supports('security inhibit') ) {
1384 $resp .= add_field( FID_SECURITY_INHIBIT, $status->security_inhibit );
1386 $resp .= add_field( FID_MEDIA_TYPE, $item->sip_media_type );
1387 $resp .= maybe_add( FID_ITEM_PROPS, $item->sip_item_properties );
1390 # renew failed for some reason
1391 # not OK, renewal not OK, Unknown media type (why bother checking?)
1395 # If we found the patron or the item, the return the ILS
1396 # information, otherwise echo back the information we received
1398 $resp .= add_field( FID_PATRON_ID, $patron ? $patron->id : $patron_id );
1399 $resp .= add_field( FID_ITEM_ID, $item ? $item->id : $item_id );
1400 $resp .= add_field( FID_TITLE_ID, $item ? $item->title_id : $title_id );
1401 $resp .= add_field( FID_DUE_DATE, '' );
1404 if ( $status->fee_amount ) {
1405 $resp .= add_field( FID_FEE_AMT, $status->fee_amount );
1406 $resp .= maybe_add( FID_CURRENCY, $status->sip_currency );
1407 $resp .= maybe_add( FID_FEE_TYPE, $status->sip_fee_type );
1408 $resp .= maybe_add( FID_TRANSACTION_ID, $status->transaction_id );
1411 $resp .= add_field( FID_INST_ID, $ils->institution );
1412 $resp .= maybe_add( FID_SCREEN_MSG, $status->screen_msg, $server );
1413 $resp .= maybe_add( FID_PRINT_LINE, $status->print_line );
1415 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1420 sub handle_renew_all {
1422 # my ($third_party, $no_block, $nb_due_date, $fee_ack, $patron);
1424 my ( $self, $server ) = @_;
1425 my $ils = $server->{ils};
1426 my ( $trans_date, $patron_id, $patron_pwd, $terminal_pwd, $fee_ack );
1427 my $fields = $self->{fields};
1428 my $resp = RENEW_ALL_RESP;
1430 my ( @renewed, @unrenewed );
1432 $ils->check_inst_id( $fields->{ (FID_INST_ID) }, "handle_renew_all" );
1434 ($trans_date) = @{ $self->{fixed_fields} };
1436 $patron_id = $fields->{ (FID_PATRON_ID) };
1437 $patron_pwd = $fields->{ (FID_PATRON_PWD) };
1438 $terminal_pwd = $fields->{ (FID_TERMINAL_PWD) };
1439 $fee_ack = $fields->{ (FID_FEE_ACK) };
1441 $status = $ils->renew_all( $patron_id, $patron_pwd, $fee_ack );
1443 $resp .= $status->ok ? '1' : '0';
1445 if ( !$status->ok ) {
1446 $resp .= add_count( "renew_all/renewed_count", 0 );
1447 $resp .= add_count( "renew_all/unrenewed_count", 0 );
1451 @renewed = ( @{ $status->renewed } );
1452 @unrenewed = ( @{ $status->unrenewed } );
1453 $resp .= add_count( "renew_all/renewed_count", scalar @renewed );
1454 $resp .= add_count( "renew_all/unrenewed_count", scalar @unrenewed );
1458 $resp .= add_field( FID_INST_ID, $ils->institution );
1460 $resp .= join( '', map( add_field( FID_RENEWED_ITEMS, $_ ), @renewed ) );
1461 $resp .= join( '', map( add_field( FID_UNRENEWED_ITEMS, $_ ), @unrenewed ) );
1463 $resp .= maybe_add( FID_SCREEN_MSG, $status->screen_msg, $server );
1464 $resp .= maybe_add( FID_PRINT_LINE, $status->print_line );
1466 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1472 # send_acs_status($self, $server)
1474 # Send an ACS Status message, which is contains lots of little fields
1475 # of information gleaned from all sorts of places.
1478 my @message_type_names = (
1479 "patron status request",
1484 "request sc/acs resend",
1486 "patron information",
1487 "end patron session",
1490 "item status update",
1497 sub send_acs_status {
1498 my ( $self, $server, $screen_msg, $print_line ) = @_;
1499 my $msg = ACS_STATUS;
1500 ($server) or die "send_acs_status error: no \$server argument received";
1501 my $account = $server->{account} or die "send_acs_status error: no 'account' in \$server object:\n" . Dumper($server);
1502 my $policy = $server->{policy} or die "send_acs_status error: no 'policy' in \$server object:\n" . Dumper($server);
1503 my $ils = $server->{ils} or die "send_acs_status error: no 'ils' in \$server object:\n" . Dumper($server);
1504 my ( $online_status, $checkin_ok, $checkout_ok, $ACS_renewal_policy );
1505 my ( $status_update_ok, $offline_ok, $timeout, $retries );
1507 $online_status = 'Y';
1508 $checkout_ok = sipbool( $ils->checkout_ok );
1509 $checkin_ok = sipbool( $ils->checkin_ok );
1510 $ACS_renewal_policy = sipbool( $policy->{renewal} );
1511 $status_update_ok = sipbool( $ils->status_update_ok );
1512 $offline_ok = sipbool( $ils->offline_ok );
1513 $timeout = sprintf( "%03d", $policy->{timeout} );
1514 $retries = sprintf( "%03d", $policy->{retries} );
1516 if ( length($timeout) != 3 ) {
1517 syslog( "LOG_ERR", "handle_acs_status: timeout field wrong size: '%s'", $timeout );
1521 if ( length($retries) != 3 ) {
1522 syslog( "LOG_ERR", "handle_acs_status: retries field wrong size: '%s'", $retries );
1526 $msg .= "$online_status$checkin_ok$checkout_ok$ACS_renewal_policy";
1527 $msg .= "$status_update_ok$offline_ok$timeout$retries";
1528 $msg .= timestamp();
1530 if ( $protocol_version == 1 ) {
1532 } elsif ( $protocol_version == 2 ) {
1535 syslog( "LOG_ERR", 'Bad setting for $protocol_version, "%s" in send_acs_status', $protocol_version );
1540 $msg .= add_field( FID_INST_ID, $account->{institution} );
1542 if ( $protocol_version >= 2 ) {
1544 # Supported messages: we do it all
1545 my $supported_msgs = '';
1547 foreach my $msg_name (@message_type_names) {
1548 if ( $msg_name eq 'request sc/acs resend' ) {
1549 $supported_msgs .= sipbool(1);
1551 $supported_msgs .= sipbool( $ils->supports($msg_name) );
1554 if ( length($supported_msgs) < 16 ) {
1555 syslog( "LOG_ERR", 'send_acs_status: supported messages "%s" too short', $supported_msgs );
1557 $msg .= add_field( FID_SUPPORTED_MSGS, $supported_msgs );
1560 $msg .= maybe_add( FID_SCREEN_MSG, $screen_msg, $server );
1562 if ( defined( $account->{print_width} )
1563 && defined($print_line)
1564 && $account->{print_width} < length($print_line) ) {
1565 syslog( "LOG_WARNING", "send_acs_status: print line '%s' too long. Truncating", $print_line );
1566 $print_line = substr( $print_line, 0, $account->{print_width} );
1569 $msg .= maybe_add( FID_PRINT_LINE, $print_line );
1571 # Do we want to tell the terminal its location?
1573 $self->write_msg( $msg, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1578 # build_patron_status: create the 14-char patron status
1579 # string for the Patron Status message
1581 sub patron_status_string {
1585 syslog( "LOG_DEBUG", "patron_status_string: %s charge_ok: %s", $patron->id, $patron->charge_ok );
1586 $patron_status = sprintf(
1587 '%s%s%s%s%s%s%s%s%s%s%s%s%s%s',
1588 denied( $patron->charge_ok ),
1589 denied( $patron->renew_ok ),
1590 denied( $patron->recall_ok ),
1591 denied( $patron->hold_ok ),
1592 boolspace( $patron->card_lost ),
1593 boolspace( $patron->too_many_charged ),
1594 boolspace( $patron->too_many_overdue ),
1595 boolspace( $patron->too_many_renewal ),
1596 boolspace( $patron->too_many_claim_return ),
1597 boolspace( $patron->too_many_lost ),
1598 boolspace( $patron->excessive_fines ),
1599 boolspace( $patron->excessive_fees ),
1600 boolspace( $patron->recall_overdue ),
1601 boolspace( $patron->too_many_billed )
1603 return $patron_status;
1607 my ( $username, $password, $branch ) = @_;
1608 $ENV{REMOTE_USER} = $username;
1609 my $query = CGI->new();
1610 $query->param( userid => $username );
1611 $query->param( password => $password );
1613 $query->param( branch => $branch );
1615 my ( $status, $cookie, $sessionID ) = check_api_auth( $query, { circulate => 1 }, 'intranet' );