4 # A Class for handing SIP messages
7 package C4::SIP::Sip::MsgType;
13 use C4::SIP::Sip qw(:all);
14 use C4::SIP::Sip::Constants qw(:all);
15 use C4::SIP::Sip::Checksum qw(verify_cksum);
19 use C4::Auth qw(&check_api_auth);
22 use Koha::Patron::Attributes;
25 use Koha::DateUtils qw( output_pref );
29 use vars qw(@ISA @EXPORT_OK);
31 use constant INVALID_CARD => 'Invalid cardnumber';
32 use constant INVALID_PW => 'Invalid password';
36 @EXPORT_OK = qw(handle login_core);
39 # Predeclare handler subroutines
40 use subs qw(handle_patron_status handle_checkout handle_checkin
41 handle_block_patron handle_sc_status handle_request_acs_resend
42 handle_login handle_patron_info handle_end_patron_session
43 handle_fee_paid handle_item_information handle_item_status_update
44 handle_patron_enable handle_hold handle_renew handle_renew_all);
47 # For the most part, Version 2.00 of the protocol just adds new
48 # variable fields, but sometimes it changes the fixed header.
50 # In general, if there's no '2.00' protocol entry for a handler, that's
51 # because 2.00 didn't extend the 1.00 version of the protocol. This will
52 # be handled by the module initialization code following the declaration,
53 # which goes through the handlers table and creates a '2.00' entry that
54 # points to the same place as the '1.00' entry. If there's a 2.00 entry
55 # but no 1.00 entry, then that means that it's a completely new service
56 # in 2.00, so 1.00 shouldn't recognize it.
59 (PATRON_STATUS_REQ) => {
60 name => "Patron Status Request",
61 handler => \&handle_patron_status,
66 fields => [ (FID_INST_ID), (FID_PATRON_ID), (FID_TERMINAL_PWD), (FID_PATRON_PWD) ],
72 handler => \&handle_checkout,
75 template => "A1A1A18A18",
77 fields => [ (FID_INST_ID), (FID_PATRON_ID), (FID_ITEM_ID), (FID_TERMINAL_PWD) ],
80 template => "A1A1A18A18",
82 fields => [ (FID_INST_ID), (FID_PATRON_ID), (FID_ITEM_ID), (FID_TERMINAL_PWD), (FID_ITEM_PROPS), (FID_PATRON_PWD), (FID_FEE_ACK), (FID_CANCEL) ],
88 handler => \&handle_checkin,
91 template => "A1A18A18",
93 fields => [ (FID_CURRENT_LOCN), (FID_INST_ID), (FID_ITEM_ID), (FID_TERMINAL_PWD) ],
96 template => "A1A18A18",
98 fields => [ (FID_CURRENT_LOCN), (FID_INST_ID), (FID_ITEM_ID), (FID_TERMINAL_PWD), (FID_ITEM_PROPS), (FID_CANCEL) ],
103 name => "Block Patron",
104 handler => \&handle_block_patron,
109 fields => [ (FID_INST_ID), (FID_BLOCKED_CARD_MSG), (FID_PATRON_ID), (FID_TERMINAL_PWD) ],
115 handler => \&handle_sc_status,
118 template => "A1A3A4",
124 (REQUEST_ACS_RESEND) => {
125 name => "Request ACS Resend",
126 handler => \&handle_request_acs_resend,
137 handler => \&handle_login,
142 fields => [ (FID_LOGIN_UID), (FID_LOGIN_PWD), (FID_LOCATION_CODE) ],
147 name => "Patron Info",
148 handler => \&handle_patron_info,
151 template => "A3A18A10",
153 fields => [ (FID_INST_ID), (FID_PATRON_ID), (FID_TERMINAL_PWD), (FID_PATRON_PWD), (FID_START_ITEM), (FID_END_ITEM) ],
157 (END_PATRON_SESSION) => {
158 name => "End Patron Session",
159 handler => \&handle_end_patron_session,
164 fields => [ (FID_INST_ID), (FID_PATRON_ID), (FID_TERMINAL_PWD), (FID_PATRON_PWD) ],
170 handler => \&handle_fee_paid,
173 template => "A18A2A2A3",
175 fields => [ (FID_FEE_AMT), (FID_INST_ID), (FID_PATRON_ID), (FID_TERMINAL_PWD), (FID_PATRON_PWD), (FID_FEE_ID), (FID_TRANSACTION_ID) ],
179 (ITEM_INFORMATION) => {
180 name => "Item Information",
181 handler => \&handle_item_information,
186 fields => [ (FID_INST_ID), (FID_ITEM_ID), (FID_TERMINAL_PWD) ],
190 (ITEM_STATUS_UPDATE) => {
191 name => "Item Status Update",
192 handler => \&handle_item_status_update,
197 fields => [ (FID_INST_ID), (FID_PATRON_ID), (FID_ITEM_ID), (FID_TERMINAL_PWD), (FID_ITEM_PROPS) ],
202 name => "Patron Enable",
203 handler => \&handle_patron_enable,
208 fields => [ (FID_INST_ID), (FID_PATRON_ID), (FID_TERMINAL_PWD), (FID_PATRON_PWD) ],
214 handler => \&handle_hold,
220 (FID_EXPIRATION), (FID_PICKUP_LOCN), (FID_HOLD_TYPE), (FID_INST_ID), (FID_PATRON_ID), (FID_PATRON_PWD),
221 (FID_ITEM_ID), (FID_TITLE_ID), (FID_TERMINAL_PWD), (FID_FEE_ACK)
228 handler => \&handle_renew,
231 template => "A1A1A18A18",
233 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) ],
239 handler => \&handle_renew_all,
244 fields => [ (FID_INST_ID), (FID_PATRON_ID), (FID_PATRON_PWD), (FID_TERMINAL_PWD), (FID_FEE_ACK) ],
251 # Now, initialize some of the missing bits of %handlers
253 foreach my $i ( keys(%handlers) ) {
254 if ( !exists( $handlers{$i}->{protocol}->{2} ) ) {
255 $handlers{$i}->{protocol}->{2} = $handlers{$i}->{protocol}->{1};
260 my ( $class, $msg, $seqno ) = @_;
262 my $msgtag = substr( $msg, 0, 2 );
264 if ( $msgtag eq LOGIN ) {
266 # If the client is using the 2.00-style "Login" message
267 # to authenticate to the server, then we get the Login message
268 # _before_ the client has indicated that it supports 2.00, but
269 # it's using the 2.00 login process, so it must support 2.00.
270 $protocol_version = 2;
272 siplog( "LOG_DEBUG", "Sip::MsgType::new('%s', '%s...', '%s'): seq.no '%s', protocol %s", $class, substr( $msg, 0, 10 ), $msgtag, $seqno, $protocol_version );
274 # warn "SIP PROTOCOL: $protocol_version";
275 if ( !exists( $handlers{$msgtag} ) ) {
276 siplog( "LOG_WARNING", "new Sip::MsgType: Skipping message of unknown type '%s' in '%s'", $msgtag, $msg );
278 } elsif ( !exists( $handlers{$msgtag}->{protocol}->{$protocol_version} ) ) {
279 siplog( "LOG_WARNING", "new Sip::MsgType: Skipping message '%s' unsupported by protocol rev. '%d'", $msgtag, $protocol_version );
285 $self->{seqno} = $seqno;
286 $self->_initialize( substr( $msg, 2 ), $handlers{$msgtag} );
292 my ( $self, $msg, $control_block ) = @_;
294 my $proto = $control_block->{protocol}->{$protocol_version};
296 $self->{name} = $control_block->{name};
297 $self->{handler} = $control_block->{handler};
299 $self->{fields} = {};
300 $self->{fixed_fields} = [];
302 chomp($msg); # These four are probably unnecessary now.
307 foreach my $field ( @{ $proto->{fields} } ) {
308 $self->{fields}->{$field} = undef;
311 siplog( "LOG_DEBUG", "Sip::MsgType::_initialize('%s', '%s', '%s', '%s', ...)", $self->{name}, $msg, $proto->{template}, $proto->{template_len} );
313 $self->{fixed_fields} = [ unpack( $proto->{template}, $msg ) ]; # see http://perldoc.perl.org/5.8.8/functions/unpack.html
315 # Skip over the fixed fields and the split the rest of
316 # the message into fields based on the delimiter and parse them
317 foreach my $field ( split( quotemeta($field_delimiter), substr( $msg, $proto->{template_len} ) ) ) {
318 $fn = substr( $field, 0, 2 );
320 if ( !exists( $self->{fields}->{$fn} ) ) {
321 siplog( "LOG_WARNING", "Unsupported field '%s' in %s message '%s'", $fn, $self->{name}, $msg );
322 } elsif ( defined( $self->{fields}->{$fn} ) ) {
323 siplog( "LOG_WARNING", "Duplicate field '%s' (previous value '%s') in %s message '%s'", $fn, $self->{fields}->{$fn}, $self->{name}, $msg );
325 $self->{fields}->{$fn} = substr( $field, 2 );
333 my ( $msg, $server, $req ) = @_;
334 my $config = $server->{config};
337 # Set system preference overrides, first global, then account level
338 # Clear overrides from previous message handling first
339 foreach my $key ( keys %ENV ) {
340 delete $ENV{$key} if index($key, 'OVERRIDE_SYSPREF_') > 0;
342 foreach my $key ( keys %{ $config->{'syspref_overrides'} } ) {
343 $ENV{"OVERRIDE_SYSPREF_$key"} = $config->{'syspref_overrides'}->{$key};
345 foreach my $key ( keys %{ $server->{account}->{'syspref_overrides'} } ) {
346 $ENV{"OVERRIDE_SYSPREF_$key"} =
347 $server->{account}->{'syspref_overrides'}->{$key};
351 # What's the field delimiter for variable length fields?
352 # This can't be based on the account, since we need to know
353 # the field delimiter to parse a SIP login message
355 if ( defined( $server->{config}->{delimiter} ) ) {
356 $field_delimiter = $server->{config}->{delimiter};
359 # error detection is active if this is a REQUEST_ACS_RESEND
360 # message with a checksum, or if the message is long enough
361 # and the last nine characters begin with a sequence number
363 if ( $msg eq REQUEST_ACS_RESEND_CKSUM ) {
366 $error_detection = 1;
367 $self = C4::SIP::Sip::MsgType->new( (REQUEST_ACS_RESEND), 0 );
368 } elsif ( ( length($msg) > 11 ) && ( substr( $msg, -9, 2 ) eq "AY" ) ) {
369 $error_detection = 1;
371 if ( !verify_cksum($msg) ) {
372 siplog( "LOG_WARNING", "Checksum failed on message '%s'", $msg );
374 # REQUEST_SC_RESEND with error detection
375 $last_response = REQUEST_SC_RESEND_CKSUM;
376 print("$last_response\r");
377 return REQUEST_ACS_RESEND;
380 # Save the sequence number, then strip off the
381 # error detection data to process the message
382 $self = C4::SIP::Sip::MsgType->new( substr( $msg, 0, -9 ), substr( $msg, -7, 1 ) );
384 } elsif ($error_detection) {
386 # We received a non-ED message when ED is supposed to be active.
387 # Warn about this problem, then process the message anyway.
388 siplog( "LOG_WARNING", "Received message without error detection: '%s'", $msg );
389 $error_detection = 0;
390 $self = C4::SIP::Sip::MsgType->new( $msg, 0 );
392 $self = C4::SIP::Sip::MsgType->new( $msg, 0 );
395 if ( ( substr( $msg, 0, 2 ) ne REQUEST_ACS_RESEND )
397 && ( substr( $msg, 0, 2 ) ne $req ) ) {
398 return substr( $msg, 0, 2 );
400 unless ( $self->{handler} ) {
401 siplog( "LOG_WARNING", "No handler defined for '%s'", $msg );
402 $last_response = REQUEST_SC_RESEND;
403 print("$last_response\r");
404 return REQUEST_ACS_RESEND;
406 return ( $self->{handler}->( $self, $server ) ); # FIXME
407 # FIXME: Use of uninitialized value in subroutine entry
408 # Can't use string ("") as a subroutine ref while "strict refs" in use
416 # Patron status messages are produced in response to both
417 # "Request Patron Status" and "Block Patron"
419 # Request Patron Status requires a patron password, but
420 # Block Patron doesn't (since the patron may never have
421 # provided one before attempting some illegal action).
423 # ASSUMPTION: If the patron password field is present in the
424 # message, then it must match, otherwise incomplete patron status
425 # information will be returned to the terminal.
427 sub build_patron_status {
428 my ( $patron, $lang, $fields, $server ) = @_;
430 my $patron_pwd = $fields->{ (FID_PATRON_PWD) };
431 my $resp = (PATRON_STATUS_RESP);
436 $password_rc = $patron->check_password($patron_pwd);
439 $resp .= patron_status_string( $patron, $server );
440 $resp .= $lang . timestamp();
441 if ( defined $server->{account}->{ae_field_template} ) {
442 $resp .= add_field( FID_PERSONAL_NAME, $patron->format( $server->{account}->{ae_field_template}, $server ) );
444 $resp .= add_field( FID_PERSONAL_NAME, $patron->name, $server );
448 # while the patron ID we got from the SC is valid, let's
449 # use the one returned from the ILS, just in case...
450 $resp .= add_field( FID_PATRON_ID, $patron->id, $server );
452 if ( $protocol_version >= 2 ) {
453 $resp .= add_field( FID_VALID_PATRON, 'Y', $server );
455 # Patron password is a required field.
456 $resp .= add_field( FID_VALID_PATRON_PWD, sipbool($password_rc), $server );
457 $resp .= maybe_add( FID_CURRENCY, $patron->currency, $server );
458 $resp .= maybe_add( FID_FEE_AMT, $patron->fee_amount, $server );
461 my $msg = $patron->screen_msg;
462 $msg .= ' -- '. INVALID_PW if $patron_pwd && !$password_rc;
463 $resp .= maybe_add( FID_SCREEN_MSG, $msg, $server );
465 $resp .= maybe_add( FID_SCREEN_MSG, $patron->{branchcode}, $server )
466 if ( $server->{account}->{send_patron_home_library_in_af} );
467 $resp .= maybe_add( FID_PRINT_LINE, $patron->print_line, $server );
469 $resp .= $patron->build_custom_field_string( $server );
470 $resp .= $patron->build_patron_attributes_string( $server );
473 # Invalid patron (cardnumber)
474 # Report that the user has no privs.
476 # no personal name, and is invalid (if we're using 2.00)
477 $resp .= 'YYYY' . ( ' ' x 10 ) . $lang . timestamp();
478 $resp .= add_field( FID_PERSONAL_NAME, '', $server );
480 # the patron ID is invalid, but it's a required field, so
482 $resp .= add_field( FID_PATRON_ID, $fields->{ (FID_PATRON_ID) }, $server );
484 ( $protocol_version >= 2 )
485 and $resp .= add_field( FID_VALID_PATRON, 'N', $server );
487 $resp .= maybe_add( FID_SCREEN_MSG, INVALID_CARD, $server );
490 $resp .= add_field( FID_INST_ID, $fields->{ (FID_INST_ID) }, $server );
494 sub handle_patron_status {
495 my ( $self, $server ) = @_;
496 my $ils = $server->{ils};
498 my $resp = (PATRON_STATUS_RESP);
499 my $account = $server->{account};
500 my ( $lang, $date ) = @{ $self->{fixed_fields} };
501 my $fields = $self->{fields};
503 $ils->check_inst_id( $fields->{ (FID_INST_ID) }, "handle_patron_status" );
504 $patron = $ils->find_patron( $fields->{ (FID_PATRON_ID) } );
505 $resp = build_patron_status( $patron, $lang, $fields, $server );
506 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
507 return (PATRON_STATUS_REQ);
510 sub handle_checkout {
511 my ( $self, $server ) = @_;
512 my $account = $server->{account};
513 my $ils = $server->{ils};
514 my $inst = $ils->institution;
515 my ( $sc_renewal_policy, $no_block, $trans_date, $nb_due_date );
517 my ( $patron_id, $item_id, $status );
518 my ( $item, $patron );
521 ( $sc_renewal_policy, $no_block, $trans_date, $nb_due_date ) = @{ $self->{fixed_fields} };
522 $fields = $self->{fields};
524 $patron_id = $fields->{ (FID_PATRON_ID) };
525 Koha::Plugins->call('patron_barcode_transform', \$patron_id );
526 $item_id = $fields->{ (FID_ITEM_ID) };
527 my $fee_ack = $fields->{ (FID_FEE_ACK) };
529 if ( $no_block eq 'Y' ) {
531 # Off-line transactions need to be recorded, but there's
532 # not a lot we can do about it
533 siplog( "LOG_WARNING", "received no-block checkout from terminal '%s'", $account->{id} );
535 $status = $ils->checkout( $patron_id, $item_id, $sc_renewal_policy, $fee_ack, $account, $nb_due_date );
538 # Does the transaction date really matter for items that are
539 # checkout out while the terminal is online? I'm guessing 'no'
540 $status = $ils->checkout( $patron_id, $item_id, $sc_renewal_policy, $fee_ack, $account );
543 $item = $status->item;
544 $patron = $status->patron;
548 # Item successfully checked out
550 $resp = CHECKOUT_RESP . '1';
551 $resp .= sipbool( $status->renew_ok );
552 if ( $ils->supports('magnetic media') ) {
553 $resp .= sipbool( $item->magnetic_media );
558 # We never return the obsolete 'U' value for 'desensitize'
571 # Now for the variable fields
572 $resp .= add_field( FID_INST_ID, $inst, $server );
573 $resp .= add_field( FID_PATRON_ID, $patron_id, $server );
574 $resp .= add_field( FID_ITEM_ID, $item_id, $server );
575 $resp .= add_field( FID_TITLE_ID, $item->title_id, $server );
576 if ( $item->due_date ) {
578 $account->{format_due_date}
579 ? output_pref( { str => $item->due_date, as_due_date => 1 } )
580 : timestamp( $item->due_date );
581 $resp .= add_field( FID_DUE_DATE, $due_date, $server );
583 $resp .= add_field( FID_DUE_DATE, q{}, $server );
586 $resp .= maybe_add( FID_SCREEN_MSG, $status->screen_msg, $server );
587 $resp .= maybe_add( FID_PRINT_LINE, $status->print_line, $server );
589 if ( $protocol_version >= 2 ) {
590 if ( $ils->supports('security inhibit') ) {
591 $resp .= add_field( FID_SECURITY_INHIBIT, $status->security_inhibit, $server );
593 $resp .= maybe_add( FID_MEDIA_TYPE, $item->sip_media_type, $server );
594 $resp .= maybe_add( FID_ITEM_PROPS, $item->sip_item_properties, $server );
602 # Checkout Response: not ok, no renewal, don't know mag. media,
604 $resp = sprintf( "120NUN%s", timestamp );
605 $resp .= add_field( FID_INST_ID, $inst, $server );
606 $resp .= add_field( FID_PATRON_ID, $patron_id, $server );
607 $resp .= add_field( FID_ITEM_ID, $item_id, $server );
609 # If the item is valid, provide the title, otherwise
611 $resp .= add_field( FID_TITLE_ID, $item ? $item->title_id : '', $server );
613 # Due date is required. Since it didn't get checked out,
614 # it's not due, so leave the date blank
615 $resp .= add_field( FID_DUE_DATE, '', $server );
617 $resp .= maybe_add( FID_SCREEN_MSG, $status->screen_msg, $server );
618 $resp .= maybe_add( FID_PRINT_LINE, $status->print_line, $server );
620 if ( $protocol_version >= 2 ) {
622 # Is the patron ID valid?
623 $resp .= add_field( FID_VALID_PATRON, sipbool($patron), $server );
625 if ( $patron && exists( $fields->{FID_PATRON_PWD} ) ) {
627 # Password provided, so we can tell if it was valid or not
628 $resp .= add_field( FID_VALID_PATRON_PWD, sipbool( $patron->check_password( $fields->{ (FID_PATRON_PWD) } ) ), $server );
633 $resp .= $item->build_additional_item_fields_string( $server ) if $item;
635 if ( $protocol_version >= 2 ) {
637 # Financials : return irrespective of ok status
638 if ( $status->fee_amount ) {
639 $resp .= add_field( FID_FEE_AMT, $status->fee_amount, $server );
640 $resp .= maybe_add( FID_CURRENCY, $status->sip_currency, $server );
641 $resp .= maybe_add( FID_FEE_TYPE, $status->sip_fee_type, $server );
642 $resp .= maybe_add( FID_TRANSACTION_ID, $status->transaction_id, $server );
646 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
651 my ( $self, $server ) = @_;
652 my $account = $server->{account};
653 my $ils = $server->{ils};
654 my $my_branch = $ils->institution;
655 my ( $current_loc, $inst_id, $item_id, $terminal_pwd, $item_props, $cancel );
656 my ( $patron, $item, $status );
657 my $resp = CHECKIN_RESP;
658 my ( $no_block, $trans_date, $return_date ) = @{ $self->{fixed_fields} };
659 my $fields = $self->{fields};
661 $current_loc = $fields->{ (FID_CURRENT_LOCN) };
662 $inst_id = $fields->{ (FID_INST_ID) };
663 $item_id = $fields->{ (FID_ITEM_ID) };
664 $item_props = $fields->{ (FID_ITEM_PROPS) };
665 $cancel = $fields->{ (FID_CANCEL) };
667 $my_branch = $current_loc; # most scm do not set $current_loc
670 $ils->check_inst_id( $inst_id, "handle_checkin" );
672 if ( $no_block eq 'Y' ) {
674 # Off-line transactions, ick.
675 siplog( "LOG_WARNING", "received no-block checkin from terminal '%s' - no-block checkin not supported", $account->{id} );
676 #FIXME We need to write the routine called below
677 #$status = $ils->checkin_no_block( $item_id, $trans_date, $return_date, $item_props, $cancel );
678 #Until we do, lets just checkin the item
679 $status = $ils->checkin( $item_id, $trans_date, $return_date, $my_branch, $item_props, $cancel, $account );
681 $status = $ils->checkin( $item_id, $trans_date, $return_date, $my_branch, $item_props, $cancel, $account );
684 $patron = $status->patron;
685 $item = $status->item;
687 $resp .= $status->ok ? '1' : '0';
688 $resp .= $status->resensitize ? 'Y' : 'N';
689 if ( $item && $ils->supports('magnetic media') ) {
690 $resp .= sipbool( $item->magnetic_media );
693 # item barcode is invalid or system doesn't support 'magnetic media' indicator
697 $resp .= $status->alert ? 'Y' : 'N';
699 $resp .= add_field( FID_INST_ID, $inst_id, $server );
700 $resp .= add_field( FID_ITEM_ID, $item_id, $server );
703 $resp .= add_field( FID_PERM_LOCN, $item->permanent_location, $server );
704 $resp .= maybe_add( FID_TITLE_ID, $item->title_id, $server );
705 $resp .= $item->build_additional_item_fields_string( $server );
708 if ( $protocol_version >= 2 ) {
709 $resp .= maybe_add( FID_SORT_BIN, $status->sort_bin, $server );
711 $resp .= add_field( FID_PATRON_ID, $patron->id, $server );
714 $resp .= maybe_add( FID_MEDIA_TYPE, $item->sip_media_type, $server );
715 $resp .= maybe_add( FID_ITEM_PROPS, $item->sip_item_properties, $server );
716 $resp .= maybe_add( FID_CALL_NUMBER, $item->call_number, $server );
717 $resp .= maybe_add( FID_HOLD_PATRON_ID, $item->hold_patron_bcode, $server );
718 $resp .= add_field( FID_DESTINATION_LOCATION, $item->destination_loc, $server ) if ( $item->destination_loc || $server->{account}->{ct_always_send} );
719 $resp .= maybe_add( FID_HOLD_PATRON_NAME, $item->hold_patron_name( $server->{account}->{da_field_template} ), $server );
721 if ( my $CR = $server->{account}->{cr_item_field} ) {
722 $resp .= maybe_add( FID_COLLECTION_CODE, $item->{$CR}, $server );
724 $resp .= maybe_add( FID_COLLECTION_CODE, $item->collection_code, $server );
727 if ( $status->hold and $status->hold->{branchcode} ne $item->destination_loc ) {
728 warn 'SIP hold mismatch: $status->hold->{branchcode}=' . $status->hold->{branchcode} . '; $item->destination_loc=' . $item->destination_loc;
730 # just me being paranoid.
735 if ( $status->alert && $status->alert_type ) {
736 $resp .= maybe_add( FID_ALERT_TYPE, $status->alert_type, $server );
737 } elsif ( $server->{account}->{cv_send_00_on_success} ) {
738 $resp .= add_field( FID_ALERT_TYPE, '00', $server );
740 $resp .= maybe_add( FID_SCREEN_MSG, $status->screen_msg, $server );
741 $resp .= maybe_add( FID_PRINT_LINE, $status->print_line, $server );
743 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
748 sub handle_block_patron {
749 my ( $self, $server ) = @_;
750 my $account = $server->{account};
751 my $ils = $server->{ils};
752 my ( $card_retained, $trans_date );
753 my ( $inst_id, $blocked_card_msg, $patron_id, $terminal_pwd );
754 my ( $fields, $resp, $patron );
756 ( $card_retained, $trans_date ) = @{ $self->{fixed_fields} };
757 $fields = $self->{fields};
758 $inst_id = $fields->{ (FID_INST_ID) };
759 $blocked_card_msg = $fields->{ (FID_BLOCKED_CARD_MSG) };
760 $patron_id = $fields->{ (FID_PATRON_ID) };
761 $terminal_pwd = $fields->{ (FID_TERMINAL_PWD) };
763 Koha::Plugins->call('patron_barcode_transform', \$patron_id );
765 # Terminal passwords are different from account login
766 # passwords, but I have no idea what to do with them. So,
767 # I'll just ignore them for now.
771 $ils->check_inst_id( $inst_id, "block_patron" );
772 $patron = $ils->find_patron($patron_id);
774 # The correct response for a "Block Patron" message is a
775 # "Patron Status Response", so use that handler to generate
776 # the message, but then return the correct code from here.
778 # Normally, the language is provided by the "Patron Status"
779 # fixed field, but since we're not responding to one of those
780 # we'll just say, "Unspecified", as per the spec. Let the
781 # terminal default to something that, one hopes, will be
786 $patron->block( $card_retained, $blocked_card_msg );
789 $resp = build_patron_status( $patron, $patron->language, $fields, $server );
790 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
791 return (BLOCK_PATRON);
794 sub handle_sc_status {
795 my ( $self, $server ) = @_;
796 ($server) or warn "handle_sc_status error: no \$server argument received.";
797 my ( $status, $print_width, $sc_protocol_version ) = @{ $self->{fixed_fields} };
800 if ( $sc_protocol_version =~ /^1\./ ) {
802 } elsif ( $sc_protocol_version =~ /^2\./ ) {
805 siplog( "LOG_WARNING", "Unrecognized protocol revision '%s', falling back to '1'", $sc_protocol_version );
809 if ( $new_proto != $protocol_version ) {
810 siplog( "LOG_INFO", "Setting protocol level to $new_proto" );
811 $protocol_version = $new_proto;
814 if ( $status == SC_STATUS_PAPER ) {
815 siplog( "LOG_WARNING", "Self-Check unit '%s@%s' out of paper", $self->{account}->{id}, $self->{account}->{institution} );
816 } elsif ( $status == SC_STATUS_SHUTDOWN ) {
817 siplog( "LOG_WARNING", "Self-Check unit '%s@%s' shutting down", $self->{account}->{id}, $self->{account}->{institution} );
820 $self->{account}->{print_width} = $print_width;
821 return ( send_acs_status( $self, $server ) ? SC_STATUS : '' );
824 sub handle_request_acs_resend {
825 my ( $self, $server ) = @_;
827 if ( !$last_response ) {
829 # We haven't sent anything yet, so respond with a
830 # REQUEST_SC_RESEND msg (p. 16)
831 $self->write_msg( REQUEST_SC_RESEND, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
832 } elsif ( ( length($last_response) < 9 )
833 || substr( $last_response, -9, 2 ) ne 'AY' ) {
835 # When resending a message, we aren't supposed to include
836 # a sequence number, even if the original had one (p. 4).
837 # If the last message didn't have a sequence number, then
838 # we can just send it.
839 print("$last_response\r"); # not write_msg?
842 # Cut out the sequence number and checksum, since the old
843 # checksum is wrong for the resent message.
844 my $rebuilt = substr( $last_response, 0, -9 );
845 $self->write_msg( $rebuilt, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
848 return REQUEST_ACS_RESEND;
852 my $server = shift or return;
855 my $status = 1; # Assume it all works
856 if ( !exists( $server->{config}->{accounts}->{$uid} ) ) {
857 siplog( "LOG_WARNING", "MsgType::login_core: Unknown login '$uid'" );
859 } elsif ( $server->{config}->{accounts}->{$uid}->{password} ne $pwd ) {
860 siplog( "LOG_WARNING", "MsgType::login_core: Invalid password for login '$uid'" );
864 # Store the active account someplace handy for everybody else to find.
865 $server->{account} = $server->{config}->{accounts}->{$uid};
866 my $inst = $server->{account}->{institution};
867 $server->{institution} = $server->{config}->{institutions}->{$inst};
868 $server->{policy} = $server->{institution}->{policy};
869 $server->{sip_username} = $uid;
870 $server->{sip_password} = $pwd;
872 my $auth_status = api_auth( $uid, $pwd, $inst );
873 if ( !$auth_status or $auth_status !~ /^ok$/i ) {
874 siplog( "LOG_WARNING", "api_auth failed for SIP terminal '%s' of '%s': %s", $uid, $inst, ( $auth_status || 'unknown' ) );
877 siplog( "LOG_INFO", "Successful login/auth for '%s' of '%s'", $server->{account}->{id}, $inst );
880 # initialize connection to ILS
882 my $module = $server->{config}->{institutions}->{$inst}->{implementation};
883 siplog( "LOG_DEBUG", 'login_core: ' . Dumper($module) );
885 # Suspect this is always ILS but so we don't break any eccentic install (for now)
886 if ( $module eq 'ILS' ) {
887 $module = 'C4::SIP::ILS';
891 siplog( "LOG_ERR", "%s: Loading ILS implementation '%s' for institution '%s' failed", $server->{service}, $module, $inst );
892 die("Failed to load ILS implementation '$module' for $inst");
895 # like ILS->new(), I think.
896 $server->{ils} = $module->new( $server->{institution}, $server->{account} );
897 if ( !$server->{ils} ) {
898 siplog( "LOG_ERR", "%s: ILS connection to '%s' failed", $server->{service}, $inst );
899 die("Unable to connect to ILS '$inst'");
907 my ( $self, $server ) = @_;
908 my ( $uid_algorithm, $pwd_algorithm );
912 my $status = 1; # Assume it all works
914 $fields = $self->{fields};
915 ( $uid_algorithm, $pwd_algorithm ) = @{ $self->{fixed_fields} };
917 $uid = $fields->{ (FID_LOGIN_UID) }; # Terminal ID, not patron ID.
918 $pwd = $fields->{ (FID_LOGIN_PWD) }; # Terminal PWD, not patron PWD.
920 if ( $uid_algorithm || $pwd_algorithm ) {
921 siplog( "LOG_ERR", "LOGIN: Unsupported non-zero encryption method(s): uid = $uid_algorithm, pwd = $pwd_algorithm" );
924 $status = login_core( $server, $uid, $pwd );
927 $self->write_msg( LOGIN_RESP . $status, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
928 return $status ? LOGIN : '';
932 # Build the detailed summary information for the Patron
933 # Information Response message based on the first 'Y' that appears
934 # in the 'summary' field of the Patron Information request. The
935 # specification says that only one 'Y' can appear in that field,
936 # and we're going to believe it.
939 my ( $ils, $patron, $summary, $start, $end, $server ) = @_;
943 # Map from offsets in the "summary" field of the Patron Information
944 # message to the corresponding field and handler
947 { func => $patron->can("hold_items"), fid => FID_HOLD_ITEMS },
948 { func => $patron->can("overdue_items"), fid => FID_OVERDUE_ITEMS },
949 { func => $patron->can("charged_items"), fid => FID_CHARGED_ITEMS },
950 { func => $patron->can("fine_items"), fid => FID_FINE_ITEMS },
951 { func => $patron->can("recall_items"), fid => FID_RECALL_ITEMS },
952 { func => $patron->can("unavail_holds"), fid => FID_UNAVAILABLE_HOLD_ITEMS },
955 my $summary_type = index( $summary, 'Y' );
956 return q{} if $summary_type == -1; # No detailed information required.
957 return q{} if $summary_type > 5; # Positions 6-9 are not defined in the sip spec,
958 # and we have no extensions to handle them.
960 siplog( "LOG_DEBUG", "Summary_info: index == '%d', field '%s'", $summary_type, $summary_map[$summary_type]->{fid} );
962 my $func = $summary_map[$summary_type]->{func};
963 my $fid = $summary_map[$summary_type]->{fid};
964 my $itemlist = &$func( $patron, $start, $end, $server );
966 siplog( "LOG_DEBUG", "summary_info: list = (%s)", join( ", ", map{ $_->{barcode} } @{$itemlist} ) );
967 foreach my $i ( @{$itemlist} ) {
968 $resp .= add_field( $fid, $i->{barcode}, $server );
974 sub handle_patron_info {
975 my ( $self, $server ) = @_;
976 my $ils = $server->{ils};
977 my ( $lang, $trans_date, $summary ) = @{ $self->{fixed_fields} };
978 my $fields = $self->{fields};
979 my ( $inst_id, $patron_id, $terminal_pwd, $patron_pwd, $start, $end );
980 my ( $resp, $patron );
982 $inst_id = $fields->{ (FID_INST_ID) };
983 $patron_id = $fields->{ (FID_PATRON_ID) };
984 $terminal_pwd = $fields->{ (FID_TERMINAL_PWD) };
985 $patron_pwd = $fields->{ (FID_PATRON_PWD) };
986 $start = $fields->{ (FID_START_ITEM) };
987 $end = $fields->{ (FID_END_ITEM) };
989 Koha::Plugins->call('patron_barcode_transform', \$patron_id );
991 $patron = $ils->find_patron($patron_id);
993 $resp = (PATRON_INFO_RESP);
995 $patron->update_lastseen();
996 $resp .= patron_status_string( $patron, $server );
997 $resp .= ( defined($lang) and length($lang) == 3 ) ? $lang : $patron->language;
998 $resp .= timestamp();
1000 $resp .= add_count( 'patron_info/hold_items', scalar @{ $patron->hold_items } );
1001 $resp .= add_count( 'patron_info/overdue_items', scalar @{ $patron->overdue_items } );
1002 $resp .= add_count( 'patron_info/charged_items', scalar @{ $patron->charged_items } );
1003 $resp .= add_count( 'patron_info/fine_items', scalar @{ $patron->fine_items } );
1004 $resp .= add_count( 'patron_info/recall_items', scalar @{ $patron->recall_items } );
1005 $resp .= add_count( 'patron_info/unavail_holds', scalar @{ $patron->unavail_holds } );
1007 $resp .= add_field( FID_INST_ID, ( $ils->institution_id || 'SIP2' ), $server );
1009 # while the patron ID we got from the SC is valid, let's
1010 # use the one returned from the ILS, just in case...
1011 $resp .= add_field( FID_PATRON_ID, $patron->id, $server );
1012 if ( defined $server->{account}->{ae_field_template} ) {
1013 $resp .= add_field( FID_PERSONAL_NAME, $patron->format( $server->{account}->{ae_field_template} ), $server );
1015 $resp .= add_field( FID_PERSONAL_NAME, $patron->name, $server );
1018 # TODO: add code for the fields
1020 # overdue items limit
1021 # charged items limit
1023 $resp .= add_field( FID_VALID_PATRON, 'Y', $server );
1025 if ( defined($patron_pwd) ) {
1027 # If patron password was provided, report whether it was right or not.
1028 if ( $patron_pwd eq q{} && $server->{account}->{allow_empty_passwords} ) {
1031 $password_rc = $patron->check_password($patron_pwd);
1033 $resp .= add_field( FID_VALID_PATRON_PWD, sipbool( $password_rc ), $server );
1036 $resp .= maybe_add( FID_CURRENCY, $patron->currency, $server );
1037 $resp .= maybe_add( FID_FEE_AMT, $patron->fee_amount, $server );
1038 $resp .= add_field( FID_FEE_LMT, $patron->fee_limit, $server );
1040 # TODO: zero or more item details for 2.0 can go here:
1047 $resp .= summary_info( $ils, $patron, $summary, $start, $end, $server );
1049 $resp .= maybe_add( FID_HOME_ADDR, $patron->address, $server );
1050 $resp .= maybe_add( FID_EMAIL, $patron->email_addr, $server );
1051 $resp .= maybe_add( FID_HOME_PHONE, $patron->home_phone, $server );
1053 # SIP 2.0 extensions used by Envisionware
1054 # Other terminals will ignore unrecognized fields (unrecognized field identifiers)
1055 $resp .= maybe_add( FID_PATRON_BIRTHDATE, $patron->birthdate, $server );
1056 $resp .= maybe_add( FID_PATRON_CLASS, $patron->ptype, $server );
1058 # Custom protocol extension to report patron internet privileges
1059 $resp .= maybe_add( FID_INET_PROFILE, $patron->inet_privileges, $server );
1061 my $msg = $patron->screen_msg;
1062 if( defined( $patron_pwd ) && !$password_rc ) {
1063 $msg .= ' -- ' . INVALID_PW;
1065 $resp .= maybe_add( FID_SCREEN_MSG, $msg, $server );
1066 if ( $server->{account}->{send_patron_home_library_in_af} ) {
1067 $resp .= maybe_add( FID_SCREEN_MSG, $patron->{branchcode}, $server);
1069 $resp .= maybe_add( FID_PRINT_LINE, $patron->print_line, $server );
1071 $resp .= $patron->build_custom_field_string( $server );
1072 $resp .= $patron->build_patron_attributes_string( $server );
1075 # Invalid patron ID:
1076 # no privileges, no items associated,
1077 # no personal name, and is invalid (if we're using 2.00)
1078 $resp .= 'YYYY' . ( ' ' x 10 ) . $lang . timestamp();
1079 $resp .= '0000' x 6;
1081 $resp .= add_field( FID_INST_ID, ( $ils->institution_id || 'SIP2' ), $server );
1083 # patron ID is invalid, but field is required, so just echo it back
1084 $resp .= add_field( FID_PATRON_ID, $fields->{ (FID_PATRON_ID) }, $server );
1085 $resp .= add_field( FID_PERSONAL_NAME, '', $server );
1087 if ( $protocol_version >= 2 ) {
1088 $resp .= add_field( FID_VALID_PATRON, 'N', $server );
1090 $resp .= maybe_add( FID_SCREEN_MSG, INVALID_CARD, $server );
1093 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1094 return (PATRON_INFO);
1097 sub handle_end_patron_session {
1098 my ( $self, $server ) = @_;
1099 my $ils = $server->{ils};
1101 my $fields = $self->{fields};
1102 my $resp = END_SESSION_RESP;
1103 my ( $status, $screen_msg, $print_line );
1105 ($trans_date) = @{ $self->{fixed_fields} };
1107 $ils->check_inst_id( $fields->{ (FID_INST_ID) }, 'handle_end_patron_session' );
1109 ( $status, $screen_msg, $print_line ) = $ils->end_patron_session( $fields->{ (FID_PATRON_ID) } );
1111 $resp .= $status ? 'Y' : 'N';
1112 $resp .= timestamp();
1114 $resp .= add_field( FID_INST_ID, $server->{ils}->institution, $server );
1115 $resp .= add_field( FID_PATRON_ID, $fields->{ (FID_PATRON_ID) }, $server );
1117 $resp .= maybe_add( FID_SCREEN_MSG, $screen_msg, $server );
1118 $resp .= maybe_add( FID_PRINT_LINE, $print_line, $server );
1120 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1122 return (END_PATRON_SESSION);
1125 sub handle_fee_paid {
1126 my ( $self, $server ) = @_;
1127 my $ils = $server->{ils};
1128 my ( $trans_date, $fee_type, $pay_type, $currency ) = @{ $self->{fixed_fields} };
1129 my $fields = $self->{fields};
1130 my ( $fee_amt, $inst_id, $patron_id, $terminal_pwd, $patron_pwd );
1131 my ( $fee_id, $trans_id );
1133 my $resp = FEE_PAID_RESP;
1135 my $disallow_overpayment = $server->{account}->{disallow_overpayment};
1136 my $payment_type_writeoff = $server->{account}->{payment_type_writeoff} || q{};
1137 my $register_id = $server->{account}->{register_id};
1139 my $is_writeoff = $pay_type eq $payment_type_writeoff;
1141 $fee_amt = $fields->{ (FID_FEE_AMT) };
1142 $inst_id = $fields->{ (FID_INST_ID) };
1143 $patron_id = $fields->{ (FID_PATRON_ID) };
1144 $patron_pwd = $fields->{ (FID_PATRON_PWD) };
1145 $fee_id = $fields->{ (FID_FEE_ID) };
1146 $trans_id = $fields->{ (FID_TRANSACTION_ID) };
1148 Koha::Plugins->call('patron_barcode_transform', \$patron_id );
1150 $ils->check_inst_id( $inst_id, "handle_fee_paid" );
1152 my $pay_result = $ils->pay_fee( $patron_id, $patron_pwd, $fee_amt, $fee_type, $pay_type, $fee_id, $trans_id, $currency, $is_writeoff, $disallow_overpayment, $register_id );
1153 $status = $pay_result->{status};
1154 my $pay_response = $pay_result->{pay_response};
1157 "no_item" => "No matching item could be found",
1158 "no_checkout" => "Item is not checked out",
1159 "too_soon" => "Cannot yet be renewed",
1160 "too_many" => "Renewed the maximum number of times",
1161 "auto_too_soon" => "Scheduled for automatic renewal and cannot yet be renewed",
1162 "auto_too_late" => "Scheduled for automatic renewal and cannot yet be any more",
1163 "auto_account_expired" => "Scheduled for automatic renewal and cannot be renewed because the patron's account has expired",
1164 "auto_renew" => "Scheduled for automatic renewal",
1165 "auto_too_much_oweing" => "Scheduled for automatic renewal",
1166 "on_reserve" => "On hold for another patron",
1167 "patron_restricted" => "Patron is currently restricted",
1168 "item_denied_renewal" => "Item is not allowed renewal",
1169 "onsite_checkout" => "Item is an onsite checkout"
1173 foreach my $result( @{$pay_response->{renew_result}} ) {
1174 my $item = Koha::Items->find({ itemnumber => $result->{itemnumber} });
1175 if ($result->{success}) {
1176 push @success, '"' . $item->biblio->title . '"';
1178 push @fail, '"' . $item->biblio->title . '" : ' . $failmap->{$result->{error}};
1183 if (scalar @success > 0) {
1184 $msg.="The following items were renewed: " . join(", ", @success) . ". ";
1186 if (scalar @fail > 0) {
1187 $msg.="The following items were not renewed: " . join(", ", @fail) . ".";
1189 if (length $msg > 0) {
1190 $status->screen_msg($status->screen_msg . " $msg");
1193 $resp .= ( $status->ok ? 'Y' : 'N' ) . timestamp;
1194 $resp .= add_field( FID_INST_ID, $inst_id, $server );
1195 $resp .= add_field( FID_PATRON_ID, $patron_id, $server );
1196 $resp .= maybe_add( FID_TRANSACTION_ID, $status->transaction_id, $server );
1197 $resp .= maybe_add( FID_SCREEN_MSG, $pay_result->{error}, $server );
1198 $resp .= maybe_add( FID_SCREEN_MSG, $status->screen_msg, $server );
1199 $resp .= maybe_add( FID_PRINT_LINE, $status->print_line, $server );
1201 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1206 sub handle_item_information {
1207 my ( $self, $server ) = @_;
1208 my $account = $server->{account};
1209 my $ils = $server->{ils};
1210 my $fields = $self->{fields};
1211 my $resp = ITEM_INFO_RESP;
1216 ($trans_date) = @{ $self->{fixed_fields} };
1218 $ils->check_inst_id( $fields->{ (FID_INST_ID) }, "handle_item_information" );
1220 $item = $ils->find_item( $fields->{ (FID_ITEM_ID) } );
1222 if ( !defined($item) ) {
1225 # "Other" circ stat, "Other" security marker, "Unknown" fee type
1229 # Just echo back the invalid item id
1230 $resp .= add_field( FID_ITEM_ID, $fields->{ (FID_ITEM_ID) }, $server );
1232 # title id is required, but we don't have one
1233 $resp .= add_field( FID_TITLE_ID, '', $server );
1236 # Valid Item ID, send the good stuff
1237 my $circulation_status = $item->sip_circulation_status;
1238 $resp .= $circulation_status;
1239 $resp .= $item->sip_security_marker;
1240 $resp .= $item->sip_fee_type;
1243 if ( $circulation_status eq '01' ) {
1244 $resp .= maybe_add( FID_SCREEN_MSG, "Item is damaged", $server );
1247 $resp .= add_field( FID_ITEM_ID, $item->id, $server );
1248 $resp .= add_field( FID_TITLE_ID, $item->title_id, $server );
1250 $resp .= maybe_add( FID_MEDIA_TYPE, $item->sip_media_type, $server );
1251 $resp .= maybe_add( FID_PERM_LOCN, $item->permanent_location, $server );
1252 $resp .= maybe_add( FID_CURRENT_LOCN, $item->current_location, $server );
1253 $resp .= maybe_add( FID_ITEM_PROPS, $item->sip_item_properties, $server );
1256 if ( my $CR = $server->{account}->{cr_item_field} ) {
1257 $resp .= maybe_add( FID_COLLECTION_CODE, $item->{$CR}, $server );
1259 $resp .= maybe_add( FID_COLLECTION_CODE, $item->collection_code, $server );
1262 if ( ( $i = $item->fee ) != 0 ) {
1263 $resp .= add_field( FID_CURRENCY, $item->fee_currency, $server );
1264 $resp .= add_field( FID_FEE_AMT, $i, $server );
1266 $resp .= maybe_add( FID_OWNER, $item->owner, $server );
1268 if ( ( $i = scalar @{ $item->hold_queue } ) > 0 ) {
1269 $resp .= add_field( FID_HOLD_QUEUE_LEN, $i, $server );
1271 if ( $item->due_date ) {
1273 $account->{format_due_date}
1274 ? output_pref( { str => $item->due_date, as_due_date => 1 } )
1275 : timestamp( $item->due_date );
1276 $resp .= add_field( FID_DUE_DATE, $due_date, $server );
1278 if ( ( $i = $item->recall_date ) != 0 ) {
1279 $resp .= add_field( FID_RECALL_DATE, timestamp($i), $server );
1281 if ( ( $i = $item->hold_pickup_date ) != 0 ) {
1282 $resp .= add_field( FID_HOLD_PICKUP_DATE, timestamp($i), $server );
1285 $resp .= maybe_add( FID_SCREEN_MSG, $item->screen_msg, $server );
1286 $resp .= maybe_add( FID_PRINT_LINE, $item->print_line, $server );
1288 $resp .= $item->build_additional_item_fields_string( $server );
1289 $resp .= $item->build_custom_field_string( $server );
1292 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1294 return (ITEM_INFORMATION);
1297 sub handle_item_status_update {
1298 my ( $self, $server ) = @_;
1299 my $ils = $server->{ils};
1300 my ( $trans_date, $item_id, $terminal_pwd, $item_props );
1301 my $fields = $self->{fields};
1304 my $resp = ITEM_STATUS_UPDATE_RESP;
1306 ($trans_date) = @{ $self->{fixed_fields} };
1308 $ils->check_inst_id( $fields->{ (FID_INST_ID) } );
1310 $item_id = $fields->{ (FID_ITEM_ID) };
1311 $item_props = $fields->{ (FID_ITEM_PROPS) };
1313 if ( !defined($item_id) ) {
1314 siplog( "LOG_WARNING", "handle_item_status: received message without Item ID field" );
1316 $item = $ils->find_item($item_id);
1324 $resp .= add_field( FID_ITEM_ID, $item_id, $server );
1329 $status = $item->status_update($item_props);
1331 $resp .= $status->ok ? '1' : '0';
1334 $resp .= add_field( FID_ITEM_ID, $item->id, $server );
1335 $resp .= add_field( FID_TITLE_ID, $item->title_id, $server );
1336 $resp .= maybe_add( FID_ITEM_PROPS, $item->sip_item_properties, $server );
1339 $resp .= maybe_add( FID_SCREEN_MSG, $status->screen_msg, $server );
1340 $resp .= maybe_add( FID_PRINT_LINE, $status->print_line, $server );
1342 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1344 return (ITEM_STATUS_UPDATE);
1347 sub handle_patron_enable {
1348 my ( $self, $server ) = @_;
1349 my $ils = $server->{ils};
1350 my $fields = $self->{fields};
1351 my ( $trans_date, $patron_id, $terminal_pwd, $patron_pwd );
1352 my ( $status, $patron );
1353 my $resp = PATRON_ENABLE_RESP;
1355 ($trans_date) = @{ $self->{fixed_fields} };
1356 $patron_id = $fields->{ (FID_PATRON_ID) };
1357 $patron_pwd = $fields->{ (FID_PATRON_PWD) };
1359 Koha::Plugins->call('patron_barcode_transform', \$patron_id );
1361 siplog( "LOG_DEBUG", "handle_patron_enable: patron_id: '%s', patron_pwd: '%s'", $patron_id, $patron_pwd );
1363 $patron = $ils->find_patron($patron_id);
1365 if ( !defined($patron) ) {
1368 $resp .= 'YYYY' . ( ' ' x 10 ) . '000' . timestamp();
1369 $resp .= add_field( FID_PATRON_ID, $patron_id, $server );
1370 $resp .= add_field( FID_PERSONAL_NAME, '', $server );
1371 $resp .= add_field( FID_VALID_PATRON, 'N', $server );
1372 $resp .= add_field( FID_VALID_PATRON_PWD, 'N', $server );
1376 if ( !defined($patron_pwd) || $patron->check_password($patron_pwd) ) {
1378 # Don't enable the patron if there was an invalid password
1379 $status = $patron->enable;
1381 $resp .= patron_status_string( $patron, $server );
1382 $resp .= $patron->language . timestamp();
1384 $resp .= add_field( FID_PATRON_ID, $patron->id, $server );
1385 $resp .= add_field( FID_PERSONAL_NAME, $patron->format( $server->{account}->{ae_field_template} ), $server );
1386 if ( defined($patron_pwd) ) {
1387 $resp .= add_field( FID_VALID_PATRON_PWD, sipbool( $patron->check_password($patron_pwd) ), $server );
1389 $resp .= add_field( FID_VALID_PATRON, 'Y', $server );
1390 $resp .= maybe_add( FID_SCREEN_MSG, $patron->screen_msg, $server );
1391 $resp .= maybe_add( FID_PRINT_LINE, $patron->print_line, $server );
1394 $resp .= add_field( FID_INST_ID, $ils->institution, $server );
1396 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1398 return (PATRON_ENABLE);
1402 my ( $self, $server ) = @_;
1403 my $ils = $server->{ils};
1404 my ( $hold_mode, $trans_date );
1405 my ( $expiry_date, $pickup_locn, $hold_type, $patron_id, $patron_pwd );
1406 my ( $item_id, $title_id, $fee_ack );
1407 my $fields = $self->{fields};
1409 my $resp = HOLD_RESP;
1411 ( $hold_mode, $trans_date ) = @{ $self->{fixed_fields} };
1413 $ils->check_inst_id( $fields->{ (FID_INST_ID) }, "handle_hold" );
1415 $patron_id = $fields->{ (FID_PATRON_ID) };
1416 $expiry_date = $fields->{ (FID_EXPIRATION) } || '';
1417 $pickup_locn = $fields->{ (FID_PICKUP_LOCN) } || '';
1418 $hold_type = $fields->{ (FID_HOLD_TYPE) } || '2'; # Any copy of title
1419 $patron_pwd = $fields->{ (FID_PATRON_PWD) };
1420 $item_id = $fields->{ (FID_ITEM_ID) } || '';
1421 $title_id = $fields->{ (FID_TITLE_ID) } || '';
1422 $fee_ack = $fields->{ (FID_FEE_ACK) } || 'N';
1424 Koha::Plugins->call('patron_barcode_transform', \$patron_id );
1426 if ( $hold_mode eq '+' ) {
1427 $status = $ils->add_hold( $patron_id, $patron_pwd, $item_id, $title_id, $expiry_date, $pickup_locn, $hold_type, $fee_ack );
1428 } elsif ( $hold_mode eq '-' ) {
1429 $status = $ils->cancel_hold( $patron_id, $patron_pwd, $item_id, $title_id );
1430 } elsif ( $hold_mode eq '*' ) {
1431 $status = $ils->alter_hold( $patron_id, $patron_pwd, $item_id, $title_id, $expiry_date, $pickup_locn, $hold_type, $fee_ack );
1433 siplog( "LOG_WARNING", "handle_hold: Unrecognized hold mode '%s' from terminal '%s'", $hold_mode, $server->{account}->{id} );
1434 $status = $ils->Transaction::Hold; # new?
1435 $status->screen_msg("System error. Please contact library staff.");
1438 $resp .= $status->ok;
1439 $resp .= sipbool( $status->item && $status->item->available($patron_id) );
1442 if ( $status->ok ) {
1443 $resp .= add_field( FID_PATRON_ID, $status->patron->id, $server );
1445 ( $status->expiration_date )
1446 and $resp .= maybe_add( FID_EXPIRATION, timestamp( $status->expiration_date ), $server );
1447 $resp .= maybe_add( FID_QUEUE_POS, $status->queue_position, $server );
1448 $resp .= maybe_add( FID_PICKUP_LOCN, $status->pickup_location, $server );
1449 $resp .= maybe_add( FID_ITEM_ID, $status->item->id, $server );
1450 $resp .= maybe_add( FID_TITLE_ID, $status->item->title_id, $server );
1453 # Not ok. still need required fields
1454 $resp .= add_field( FID_PATRON_ID, $patron_id, $server );
1457 $resp .= add_field( FID_INST_ID, $ils->institution, $server );
1458 $resp .= maybe_add( FID_SCREEN_MSG, $status->screen_msg, $server );
1459 $resp .= maybe_add( FID_PRINT_LINE, $status->print_line, $server );
1461 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1467 my ( $self, $server ) = @_;
1468 my $ils = $server->{ils};
1469 my ( $third_party, $no_block, $trans_date, $nb_due_date );
1470 my ( $patron_id, $patron_pwd, $item_id, $title_id, $item_props, $fee_ack );
1471 my $fields = $self->{fields};
1473 my ( $patron, $item );
1474 my $resp = RENEW_RESP;
1476 ( $third_party, $no_block, $trans_date, $nb_due_date ) = @{ $self->{fixed_fields} };
1478 $ils->check_inst_id( $fields->{ (FID_INST_ID) }, "handle_renew" );
1480 if ( $no_block eq 'Y' ) {
1481 siplog( "LOG_WARNING", "handle_renew: received 'no block' renewal from terminal '%s'", $server->{account}->{id} );
1484 $patron_id = $fields->{ (FID_PATRON_ID) };
1485 $patron_pwd = $fields->{ (FID_PATRON_PWD) };
1486 $item_id = $fields->{ (FID_ITEM_ID) };
1487 $title_id = $fields->{ (FID_TITLE_ID) };
1488 $item_props = $fields->{ (FID_ITEM_PROPS) };
1489 $fee_ack = $fields->{ (FID_FEE_ACK) };
1491 Koha::Plugins->call('patron_barcode_transform', \$patron_id );
1493 $status = $ils->renew( $patron_id, $patron_pwd, $item_id, $title_id, $no_block, $nb_due_date, $third_party, $item_props, $fee_ack );
1495 $patron = $status->patron;
1496 $item = $status->item;
1498 if ( $status->renewal_ok ) {
1500 $resp .= $status->renewal_ok ? 'Y' : 'N';
1501 if ( $ils->supports('magnetic media') ) {
1502 $resp .= sipbool( $item->magnetic_media );
1506 $resp .= sipbool( desensitize( { status => $status, patron => $patron, server => $server } ) );
1508 $resp .= add_field( FID_PATRON_ID, $patron->id, $server );
1509 $resp .= add_field( FID_ITEM_ID, $item->id, $server );
1510 $resp .= add_field( FID_TITLE_ID, $item->title_id, $server );
1511 if ( $item->due_date ) {
1512 $resp .= add_field( FID_DUE_DATE, timestamp( $item->due_date ), $server );
1514 $resp .= add_field( FID_DUE_DATE, q{}, $server );
1516 if ( $ils->supports('security inhibit') ) {
1517 $resp .= add_field( FID_SECURITY_INHIBIT, $status->security_inhibit, $server );
1519 $resp .= add_field( FID_MEDIA_TYPE, $item->sip_media_type, $server );
1520 $resp .= maybe_add( FID_ITEM_PROPS, $item->sip_item_properties, $server );
1523 # renew failed for some reason
1524 # not OK, renewal not OK, Unknown media type (why bother checking?)
1528 # If we found the patron or the item, the return the ILS
1529 # information, otherwise echo back the information we received
1531 $resp .= add_field( FID_PATRON_ID, $patron ? $patron->id : $patron_id, $server );
1532 $resp .= add_field( FID_ITEM_ID, $item ? $item->id : $item_id, $server );
1533 $resp .= add_field( FID_TITLE_ID, $item ? $item->title_id : $title_id, $server );
1534 $resp .= add_field( FID_DUE_DATE, '', $server );
1537 if ( $status->fee_amount ) {
1538 $resp .= add_field( FID_FEE_AMT, $status->fee_amount, $server );
1539 $resp .= maybe_add( FID_CURRENCY, $status->sip_currency, $server );
1540 $resp .= maybe_add( FID_FEE_TYPE, $status->sip_fee_type, $server );
1541 $resp .= maybe_add( FID_TRANSACTION_ID, $status->transaction_id, $server );
1544 $resp .= add_field( FID_INST_ID, $ils->institution, $server );
1545 $resp .= maybe_add( FID_SCREEN_MSG, $status->screen_msg, $server );
1546 $resp .= maybe_add( FID_PRINT_LINE, $status->print_line, $server );
1548 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1553 sub handle_renew_all {
1555 # my ($third_party, $no_block, $nb_due_date, $fee_ack, $patron);
1557 my ( $self, $server ) = @_;
1558 my $ils = $server->{ils};
1559 my ( $trans_date, $patron_id, $patron_pwd, $terminal_pwd, $fee_ack );
1560 my $fields = $self->{fields};
1561 my $resp = RENEW_ALL_RESP;
1563 my ( @renewed, @unrenewed );
1565 $ils->check_inst_id( $fields->{ (FID_INST_ID) }, "handle_renew_all" );
1567 ($trans_date) = @{ $self->{fixed_fields} };
1569 $patron_id = $fields->{ (FID_PATRON_ID) };
1570 $patron_pwd = $fields->{ (FID_PATRON_PWD) };
1571 $terminal_pwd = $fields->{ (FID_TERMINAL_PWD) };
1572 $fee_ack = $fields->{ (FID_FEE_ACK) };
1574 Koha::Plugins->call('patron_barcode_transform', \$patron_id );
1576 $status = $ils->renew_all( $patron_id, $patron_pwd, $fee_ack );
1578 $resp .= $status->ok ? '1' : '0';
1580 if ( !$status->ok ) {
1581 $resp .= add_count( "renew_all/renewed_count", 0 );
1582 $resp .= add_count( "renew_all/unrenewed_count", 0 );
1586 @renewed = ( @{ $status->renewed } );
1587 @unrenewed = ( @{ $status->unrenewed } );
1588 $resp .= add_count( "renew_all/renewed_count", scalar @renewed );
1589 $resp .= add_count( "renew_all/unrenewed_count", scalar @unrenewed );
1593 $resp .= add_field( FID_INST_ID, $ils->institution, $server );
1595 $resp .= join( '', map( add_field( FID_RENEWED_ITEMS, $_ ), @renewed ), $server );
1596 $resp .= join( '', map( add_field( FID_UNRENEWED_ITEMS, $_ ), @unrenewed ), $server );
1598 $resp .= maybe_add( FID_SCREEN_MSG, $status->screen_msg, $server );
1599 $resp .= maybe_add( FID_PRINT_LINE, $status->print_line, $server );
1601 $self->write_msg( $resp, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1607 # send_acs_status($self, $server)
1609 # Send an ACS Status message, which is contains lots of little fields
1610 # of information gleaned from all sorts of places.
1613 my @message_type_names = (
1614 "patron status request",
1619 "request sc/acs resend",
1621 "patron information",
1622 "end patron session",
1625 "item status update",
1632 sub send_acs_status {
1633 my ( $self, $server, $screen_msg, $print_line ) = @_;
1635 my $msg = ACS_STATUS;
1636 ($server) or die "send_acs_status error: no \$server argument received";
1637 my $account = $server->{account} or die "send_acs_status error: no 'account' in \$server object:\n" . Dumper($server);
1638 my $policy = $server->{policy} or die "send_acs_status error: no 'policy' in \$server object:\n" . Dumper($server);
1639 my $ils = $server->{ils} or die "send_acs_status error: no 'ils' in \$server object:\n" . Dumper($server);
1640 my $sip_username = $server->{sip_username} or die "send_acs_status error: no 'sip_username' in \$server object:\n" . Dumper($server);
1641 my ( $online_status, $checkin_ok, $checkout_ok, $ACS_renewal_policy );
1642 my ( $status_update_ok, $offline_ok, $timeout, $retries );
1643 my $sip_user = Koha::Patrons->find({ userid => $sip_username });
1644 die "send_acs_status error: sip_username cannot be found in DB or DB cannot be reached" unless $sip_user;
1646 $online_status = 'Y';
1647 $checkout_ok = sipbool( $ils->checkout_ok );
1648 $checkin_ok = sipbool( $ils->checkin_ok );
1649 $ACS_renewal_policy = sipbool( $policy->{renewal} );
1650 $status_update_ok = sipbool( $ils->status_update_ok );
1651 $offline_ok = sipbool( $ils->offline_ok );
1652 $timeout = $server->get_timeout({ policy => 1 });
1653 $retries = sprintf( "%03d", $policy->{retries} );
1655 if ( length($retries) != 3 ) {
1656 siplog( "LOG_ERR", "handle_acs_status: retries field wrong size: '%s'", $retries );
1660 $msg .= "$online_status$checkin_ok$checkout_ok$ACS_renewal_policy";
1661 $msg .= "$status_update_ok$offline_ok$timeout$retries";
1662 $msg .= timestamp();
1664 if ( $protocol_version == 1 ) {
1666 } elsif ( $protocol_version == 2 ) {
1669 siplog( "LOG_ERR", 'Bad setting for $protocol_version, "%s" in send_acs_status', $protocol_version );
1674 $msg .= add_field( FID_INST_ID, $account->{institution}, $server );
1676 if ( $protocol_version >= 2 ) {
1678 # Supported messages: we do it all
1679 my $supported_msgs = '';
1681 foreach my $msg_name (@message_type_names) {
1682 if ( $msg_name eq 'request sc/acs resend' ) {
1683 $supported_msgs .= sipbool(1);
1685 $supported_msgs .= sipbool( $ils->supports($msg_name) );
1688 if ( length($supported_msgs) < 16 ) {
1689 siplog( "LOG_ERR", 'send_acs_status: supported messages "%s" too short', $supported_msgs );
1691 $msg .= add_field( FID_SUPPORTED_MSGS, $supported_msgs, $server );
1694 $msg .= maybe_add( FID_SCREEN_MSG, $screen_msg, $server );
1696 if ( defined( $account->{print_width} )
1697 && defined($print_line)
1698 && $account->{print_width} < length($print_line) ) {
1699 siplog( "LOG_WARNING", "send_acs_status: print line '%s' too long. Truncating", $print_line );
1700 $print_line = substr( $print_line, 0, $account->{print_width} );
1703 $msg .= maybe_add( FID_PRINT_LINE, $print_line, $server );
1705 # Do we want to tell the terminal its location?
1707 $self->write_msg( $msg, undef, $server->{account}->{terminator}, $server->{account}->{encoding} );
1712 # build_patron_status: create the 14-char patron status
1713 # string for the Patron Status message
1715 sub patron_status_string {
1721 siplog( "LOG_DEBUG", "patron_status_string: %s charge_ok: %s", $patron->id, $patron->charge_ok );
1722 $patron_status = sprintf(
1723 '%s%s%s%s%s%s%s%s%s%s%s%s%s%s',
1724 denied( $patron->charge_ok ),
1725 denied( $patron->renew_ok ),
1726 denied( $patron->recall_ok ),
1727 denied( $patron->hold_ok ),
1728 boolspace( $patron->card_lost ),
1729 boolspace( $patron->too_many_charged ),
1730 $server->{account}->{overdues_block_checkout} ? boolspace( $patron->too_many_overdue ) : q{ },
1731 boolspace( $patron->too_many_renewal ),
1732 boolspace( $patron->too_many_claim_return ),
1733 boolspace( $patron->too_many_lost( $server ) ),
1734 boolspace( $patron->excessive_fines ),
1735 boolspace( $patron->excessive_fees ),
1736 boolspace( $patron->recall_overdue ),
1737 boolspace( $patron->too_many_billed )
1739 return $patron_status;
1743 my ( $username, $password, $branch ) = @_;
1744 $ENV{REMOTE_USER} = $username;
1745 my $query = CGI->new();
1746 $query->param( userid => $username );
1747 $query->param( password => $password );
1749 $query->param( branch => $branch );
1751 my ( $status, $cookie, $sessionID ) = check_api_auth( $query, { circulate => 1 }, 'intranet' );
1758 my $status = $params->{status};
1759 my $desensitize = $status->desensitize();
1761 # If desenstize is already false, no need to do anything
1762 return unless $desensitize;
1764 my $patron = $params->{patron};
1765 my $item = $params->{item};
1766 my $server = $params->{server};
1768 my $patron_categories = $server->{account}->{inhouse_patron_categories} // q{};
1769 my $item_types = $server->{account}->{inhouse_item_types} // q{};
1771 # If no patron categories or item types are set for never desensitize, no need to do anything
1772 return $desensitize unless $patron_categories || $item_types;
1774 my $patron_category = $patron->ptype();
1775 my @patron_categories = split( /,/, $patron_categories );
1776 my $found_patron_category = grep( /^$patron_category$/, @patron_categories );
1777 return 0 if $found_patron_category;
1779 my $item_type = $item->itemtype;
1780 my @item_types = split( /,/, $item_types );
1781 my $found_item_type = grep( /^$item_type$/, @item_types );
1782 return 0 if $found_item_type;