2 # ILS.pm: Test ILS interface module
6 use warnings; use strict;
8 use Sys::Syslog qw(syslog);
9 use Time::HiRes q/time/;
11 use OpenILS::SIP::Item;
12 use OpenILS::SIP::Patron;
13 use OpenILS::SIP::Transaction;
14 use OpenILS::SIP::Transaction::Checkout;
15 use OpenILS::SIP::Transaction::Checkin;
16 use OpenILS::SIP::Transaction::Renew;
17 use OpenILS::SIP::Transaction::RenewAll;
18 use OpenILS::SIP::Transaction::FeePayment;
19 use OpenILS::SIP::Transaction::Hold;
22 use OpenSRF::AppSession;
23 use OpenILS::Utils::Fieldmapper;
24 use OpenSRF::Utils::SettingsClient;
25 use OpenILS::Application::AppUtils;
26 use OpenSRF::Utils qw/:datetime/;
27 use DateTime::Format::ISO8601;
29 use Unicode::Normalize;
31 my $U = 'OpenILS::Application::AppUtils';
36 my $target_encoding; # FIXME: this is configured at the institution level.
38 use Digest::MD5 qw(md5_hex);
40 # Copied from Sip::Constants
42 SIP_DATETIME => "%Y%m%d %H%M%S",
46 OpenSRF::Transport::PeerHandle->retrieve->disconnect
50 my ($class, $institution, $login, $state) = @_;
51 my $type = ref($class) || $class;
54 $self->{login} = $login_account = $login;
56 $config = $institution;
57 syslog("LOG_DEBUG", "OILS: new ILS '%s'", $institution->{id});
58 $self->{institution} = $institution;
60 my $bsconfig = $institution->{implementation_config}->{bootstrap};
61 $target_encoding = $institution->{implementation_config}->{encoding} || 'ascii';
63 syslog('LOG_DEBUG', "OILS: loading bootstrap config: $bsconfig");
65 # ingress will persist throughout
66 OpenSRF::AppSession->ingress('sip2');
68 local $/ = "\n"; # why?
69 OpenSRF::System->bootstrap_client(config_file => $bsconfig);
70 syslog('LOG_DEBUG', "OILS: bootstrap loaded..");
72 $self->{osrf_config} = OpenSRF::Utils::SettingsClient->new;
74 Fieldmapper->import($self->{osrf_config}->config_value('IDL'));
76 bless( $self, $type );
79 $self->login( $login->{id}, $login->{password}, $state );
87 my $ses = $U->simplereq(
89 'open-ils.auth.session.retrieve', $self->{authtoken});
91 return undef if $U->event_code($ses); # auth timed out
92 return $self->{login_session} = $ses;
98 return 1 if $self->fetch_session;
100 syslog('LOG_INFO', "OILS: Logging back after session timeout as user ".$self->{login}->{id});
101 return $self->login( $self->{login}->{id}, $self->{login}->{password} );
105 return $editor = make_editor();
112 return $login_account;
115 sub get_option_value {
116 my($self, $option) = @_;
117 my $ops = $config->{implementation_config}->{options}->{option};
118 $ops = [$ops] unless ref $ops eq 'ARRAY';
119 my @vals = grep { $_->{name} eq $option } @$ops;
120 return @vals ? $vals[0]->{value} : undef;
124 # Creates the global editor object
125 my $cstore_init = 1; # call init on first use
127 OpenILS::Utils::CStoreEditor::init() if $cstore_init;
129 return OpenILS::Utils::CStoreEditor->new;
132 =head2 clean_text(scalar)
134 Evergreen uses the UTF8 encoding for everything from the database up. Perl
135 doesn't know this, however, so we have to convince it to treat our UTF8 strings
136 as UTF8 strings. This may enable OpenNCIP to correctly calculate the checksums
137 for UTF8 text for SIP clients that support such modern options.
139 The target encoding is set in the <encoding> element of the SIPServer.pm
145 my $text = shift || '';
147 # Convert our incoming UTF8 data into Perl's internal string format
149 # Also convert to Normalization Form D, as the ASCII, iso-8859-1,
150 # and latin-1 encodings (at least) require this to substitute
151 # characters rather than simply returning a string truncated
152 # after the first non-ASCII character
153 $text = NFD(decode_utf8($text));
155 if ($target_encoding eq 'ascii') {
157 # Try to maintain a reasonable version of the content by
158 # stripping diacritics from the text, given that the SIP client
159 # wants just plain ASCII. This is the base requirement according
160 # to the SIP2 specification.
162 # Stripping the combining characters converts ""béè♁ts"
163 # into "bee?ts" instead of "b???ts" - better, eh?
167 # Characters that cannot be represented in the target encoding will
168 # generally be replaced with a question mark (?) character.
169 $text = encode($target_encoding, $text);
175 sub shortname_from_id {
176 my $id = shift or return;
177 return $id->shortname if ref $id;
178 return $org_sn_cache{$id} if $org_sn_cache{$id};
179 return $org_sn_cache{$id} = editor()->retrieve_actor_org_unit($id)->shortname;
181 sub patron_barcode_from_id {
182 my $id = shift or return;
183 return editor()->search_actor_card({ usr => $id, active => 't' })->[0]->barcode;
189 my $type = shift || 'dob';
191 return "" unless $date;
193 my $dt = DateTime::Format::ISO8601->new->
194 parse_datetime(OpenSRF::Utils::cleanse_ISO8601($date));
195 my @time = localtime($dt->epoch);
197 my $year = $time[5]+1900;
198 my $mon = $time[4]+1;
201 my $minute = $time[1];
202 my $second = $time[0];
204 $date = sprintf("%04d%02d%02d", $year, $mon, $day);
206 # Due dates need hyphen separators and time of day as well
207 if ($type eq 'due') {
209 my $use_sdf = $class->get_option_value('use_sip_date_format') || '';
211 if ($use_sdf =~ /true/i) {
212 $date = $dt->strftime(SIP_DATETIME);
215 $date = sprintf("%04d-%02d-%02d %02d:%02d:%02d",
216 $year, $mon, $day, $hour, $minute, $second);
220 syslog('LOG_DEBUG', "OILS: formatted date [type=$type]: $date");
227 my( $self, $username, $password, $state ) = @_;
228 syslog('LOG_DEBUG', "OILS: Logging in with username $username");
231 if ($state and ref $state and $$state{authtoken}) {
232 $self->{authtoken} = $$state{authtoken};
233 return $self->{authtoken} if ($self->fetch_session); # fetch the session
236 my $nonce = rand($$);
237 my $seed = $U->simplereq(
239 'open-ils.auth.authenticate.init', $username, $nonce );
241 my $response = $U->simplereq(
243 'open-ils.auth.authenticate.complete',
245 username => $username,
246 password => md5_hex($seed . md5_hex($password)),
252 if( my $code = $U->event_code($response) ) {
253 my $txt = $response->{textcode};
254 syslog('LOG_WARNING', "OILS: Login failed for $username. $txt:$code");
258 my $key = $response->{payload}->{authtoken};
259 syslog('LOG_INFO', "OILS: Login succeeded for $username : authkey = $key");
261 $self->{authtoken} = $key;
263 $self->fetch_session; # to cache the login
270 return { authtoken => $self->{authtoken} };
274 # find_patron($barcode);
275 # find_patron(barcode => $barcode); # same as above
276 # find_patron(usr => $id);
280 my $key = (@_ > 1) ? shift : 'barcode'; # if we have multiple args, the first is the key index (default barcode)
281 my $patron_id = shift;
283 return OpenILS::SIP::Patron->new($key => $patron_id, authtoken => $self->{authtoken}, @_);
289 return OpenILS::SIP::Item->new(@_);
295 return $self->{institution}->{id}; # consider making this return the whole institution
300 return $self->{institution}->{id}; # then use this for just the ID
304 my ($self, $op) = @_;
305 my ($i) = grep { $_->{name} eq $op }
306 @{$config->{implementation_config}->{supports}->{item}};
307 return to_bool($i->{value});
311 my ($self, $id, $whence) = @_;
312 if ($id ne $self->{institution}->{id}) {
313 syslog("LOG_WARNING", "OILS: %s: received institution '%s', expected '%s'", $whence, $id, $self->{institution}->{id});
314 # Just an FYI check, we don't expect the user to change location from that in SIPconfig.xml
321 # If it's defined, and matches a true sort of string, or is
322 # a non-zero number, then it's true.
323 defined($bool) or return; # false
324 ($bool =~ /true|y|yes/i) and return 1; # true
325 return ($bool =~ /^\d+$/ and $bool != 0); # true for non-zero numbers, false otherwise
329 return to_bool($config->{policy}->{checkout});
333 return to_bool($config->{policy}->{checkin});
337 return to_bool($config->{policy}->{renewal});
340 sub status_update_ok {
341 return to_bool($config->{policy}->{status_update});
345 return to_bool($config->{policy}->{offline});
351 ## Checkout(patron_id, item_id, sc_renew, fee_ack):
352 ## patron_id & item_id are the identifiers send by the terminal
353 ## sc_renew is the renewal policy configured on the terminal
354 ## returns a status opject that can be queried for the various bits
355 ## of information that the protocol (SIP or NCIP) needs to generate
357 ## fee_ack is the fee_acknowledged field (BO) sent from the sc
358 ## when doing chargeable loans.
362 my ($self, $patron_id, $item_id, $sc_renew, $fee_ack) = @_;
363 # In order to allow renewals the selfcheck AND the config have to say they are allowed
364 $sc_renew = (chr($sc_renew) eq 'Y' && $self->renew_ok());
366 $self->verify_session;
368 syslog('LOG_DEBUG', "OILS: OpenILS::Checkout attempt: patron=$patron_id, item=$item_id");
370 my $xact = OpenILS::SIP::Transaction::Checkout->new( authtoken => $self->{authtoken} );
371 my $patron = $self->find_patron($patron_id);
372 my $item = $self->find_item($item_id);
374 $xact->patron($patron);
378 $xact->screen_msg("Invalid Patron Barcode '$patron_id'");
382 if (!$patron->charge_ok) {
383 $xact->screen_msg("Patron Blocked");
388 $xact->screen_msg("Invalid Item Barcode: '$item_id'");
392 syslog('LOG_DEBUG', "OILS: OpenILS::Checkout data loaded OK, checking out...");
394 if ($item->{patron} && ($item->{patron} eq $patron_id)) {
395 $xact->renew_ok(1); # So that accept/reject responses have the correct value later
397 syslog('LOG_INFO', "OILS: OpenILS::Checkout data loaded OK, doing renew...");
399 syslog('LOG_INFO', "OILS: OpenILS::Checkout appears to be renew, but renewal disallowed...");
400 $xact->screen_msg("Renewals not permitted");
402 return $xact; # Don't attempt later
404 } elsif ($item->{patron} && ($item->{patron} ne $patron_id)) {
405 # I can't deal with this right now
406 # XXX check in then check out?
407 $xact->screen_msg("Item checked out to another patron");
409 return $xact; # Don't wipe out the screen message later
414 # Check for fee and $fee_ack. If there is a fee, and $fee_ack
415 # is 'Y', we proceed, otherwise we reject the checkout.
416 if ($item->fee > 0.0) {
417 $xact->fee_amount($item->fee);
418 $xact->sip_fee_type($item->sip_fee_type);
419 $xact->sip_currency($item->fee_currency);
420 if ($fee_ack && $fee_ack eq 'Y') {
423 $xact->screen_msg('Fee required');
429 $xact->do_checkout($sc_renew);
430 $xact->desensitize(!$item->magnetic);
434 syslog("LOG_DEBUG", "OILS: OpenILS::Checkout: " .
435 "patron %s checkout %s succeeded", $patron_id, $item_id);
437 #editor()->xact_rollback;
438 syslog("LOG_DEBUG", "OILS: OpenILS::Checkout: " .
439 "patron %s checkout %s FAILED, rolling back xact...", $patron_id, $item_id);
447 my ($self, $item_id, $inst_id, $trans_date, $return_date,
448 $current_loc, $item_props, $cancel) = @_;
450 my $start_time = time();
452 $self->verify_session;
454 syslog('LOG_DEBUG', "OILS: OpenILS::Checkin of item=$item_id (to $inst_id)");
456 my $xact = OpenILS::SIP::Transaction::Checkin->new(authtoken => $self->{authtoken});
457 my $item = OpenILS::SIP::Item->new($item_id);
459 unless ( $xact->item($item) ) {
461 # $circ->alert(1); $circ->alert_type(99);
462 $xact->screen_msg("Invalid Item Barcode: '$item_id'");
463 syslog('LOG_INFO', "OILS: Checkin failed. " . $xact->screen_msg() );
467 $xact->do_checkin( $self, $inst_id, $trans_date, $return_date, $current_loc, $item_props );
470 $xact->patron($self->find_patron(usr => $xact->{circ_user_id}, slim_user => 1)) if $xact->{circ_user_id};
471 delete $item->{patron};
472 delete $item->{due_date};
473 syslog('LOG_INFO', "OILS: Checkin succeeded");
475 syslog('LOG_WARNING', "OILS: Checkin failed");
478 syslog('LOG_INFO', "OILS: SIP Checkin request took %0.3f seconds", (time() - $start_time));
482 ## If the ILS caches patron information, this lets it free it up.
483 ## Also, this could be used for centrally logging session duration.
484 ## We don't do anything with it.
485 sub end_patron_session {
486 my ($self, $patron_id) = @_;
487 return (1, 'Thank you!', '');
492 my ($self, $patron_id, $patron_pwd, $fee_amt, $fee_type,
493 $pay_type, $fee_id, $trans_id, $currency) = @_;
495 $self->verify_session;
497 my $xact = OpenILS::SIP::Transaction::FeePayment->new(authtoken => $self->{authtoken});
498 my $patron = $self->find_patron($patron_id);
501 $xact->screen_msg("Invalid Patron Barcode '$patron_id'");
506 $xact->patron($patron);
507 $xact->sip_currency($currency);
508 $xact->fee_amount($fee_amt);
509 $xact->sip_fee_type($fee_type);
510 $xact->transaction_id($trans_id);
511 $xact->fee_id($fee_id);
512 $xact->sip_payment_type($pay_type);
513 # We don't presently use this, but we might in the future.
514 $xact->patron_password($patron_pwd);
516 $xact->do_fee_payment();
522 # my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
523 # $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
524 # my ($patron, $item);
529 # $trans = new ILS::Transaction::Hold;
531 # # BEGIN TRANSACTION
532 # $patron = new ILS::Patron $patron_id;
534 # || (defined($patron_pwd) && !$patron->check_password($patron_pwd))) {
535 # $trans->screen_msg("Invalid Patron.");
540 # $item = new ILS::Item ($item_id || $title_id);
542 # $trans->screen_msg("No such item.");
544 # # END TRANSACTION (conditionally)
546 # } elsif ($item->fee && ($fee_ack ne 'Y')) {
547 # $trans->screen_msg = "Fee required to place hold.";
549 # # END TRANSACTION (conditionally)
554 # item_id => $item->id,
555 # patron_id => $patron->id,
556 # expiration_date => $expiry_date,
557 # pickup_location => $pickup_location,
558 # hold_type => $hold_type,
562 # $trans->patron($patron);
563 # $trans->item($item);
564 # $trans->pickup_location($pickup_location);
566 # push(@{$item->hold_queue}, $hold);
567 # push(@{$patron->{hold_items}}, $hold);
575 # Note: item_id in this context is the hold id
577 my ($self, $patron_id, $patron_pwd, $item_id, $title_id) = @_;
579 my $trans = OpenILS::SIP::Transaction::Hold->new(authtoken => $self->{authtoken});
580 my $patron = $self->find_patron($patron_id);
583 $trans->screen_msg("Invalid patron barcode.");
588 if (defined($patron_pwd) && !$patron->check_password($patron_pwd)) {
589 $trans->screen_msg('Invalid patron password.');
594 $trans->patron($patron);
595 my $hold = $patron->find_hold_from_copy($item_id);
598 syslog('LOG_WARNING', "OILS: No hold found from copy $item_id");
599 $trans->screen_msg("No such hold.");
604 if ($hold->usr ne $patron->{user}->id) {
605 $trans->screen_msg("No such hold on patron record.");
611 $trans->do_hold_cancel($self);
613 if ($trans->cancel_ok) {
614 $trans->screen_msg("Hold Cancelled.");
616 $trans->screen_msg("Hold was not cancelled.");
619 # if the hold had no current_copy, use the representative
620 # item as the item for the hold. Without this, the SIP
622 $trans->item($self->find_item($item_id)) unless $trans->item;
628 ## The patron and item id's can't be altered, but the
629 ## date, location, and type can.
631 # my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
632 # $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
633 # my ($patron, $item);
637 # $trans = new ILS::Transaction::Hold;
639 # # BEGIN TRANSACTION
640 # $patron = new ILS::Patron $patron_id;
642 # $trans->screen_msg("Invalid patron barcode.");
647 # foreach my $i (0 .. scalar @{$patron->{hold_items}}) {
648 # $hold = $patron->{hold_items}[$i];
650 # if ($hold->{item_id} eq $item_id) {
651 # # Found it. So fix it.
652 # $hold->{expiration_date} = $expiry_date if $expiry_date;
653 # $hold->{pickup_location} = $pickup_location if $pickup_location;
654 # $hold->{hold_type} = $hold_type if $hold_type;
657 # $trans->screen_msg("Hold updated.");
658 # $trans->patron($patron);
659 # $trans->item(new ILS::Item $hold->{item_id});
664 # # The same hold structure is linked into both the patron's
665 # # list of hold items and into the queue of outstanding holds
666 # # for the item, so we don't need to search the hold queue for
667 # # the item, since it's already been updated by the patron code.
670 # $trans->screen_msg("No such outstanding hold.");
678 my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
679 $no_block, $nb_due_date, $third_party, $item_props, $fee_ack) = @_;
681 $self->verify_session;
683 my $trans = OpenILS::SIP::Transaction::Renew->new( authtoken => $self->{authtoken} );
684 $trans->patron($self->find_patron($patron_id));
685 $trans->item($self->find_item($item_id));
687 if(!$trans->patron) {
688 $trans->screen_msg("Invalid patron barcode.");
693 if(!$trans->patron->renew_ok) {
694 $trans->screen_msg("Renewals not allowed.");
701 $trans->screen_msg("Title ID renewal not supported. Use item barcode.");
703 $trans->screen_msg("Invalid item barcode.");
709 if(!$trans->item->{patron} or
710 $trans->item->{patron} ne $patron_id) {
711 $trans->screen_msg("Item not checked out to " . $trans->patron->name);
716 # Perform the renewal
719 $trans->desensitize(0); # It's already checked out
720 $trans->item->{due_date} = $nb_due_date if $no_block eq 'Y';
721 $trans->item->{sip_item_properties} = $item_props if $item_props;
728 my ($self, $patron_id, $patron_pwd, $fee_ack) = @_;
730 $self->verify_session;
732 my $trans = OpenILS::SIP::Transaction::RenewAll->new(authtoken => $self->{authtoken});
733 $trans->patron($self->find_patron($patron_id));
735 if(!$trans->patron) {
736 $trans->screen_msg("Invalid patron barcode.");
741 if(!$trans->patron->renew_ok) {
742 $trans->screen_msg("Renewals not allowed.");
747 $trans->do_renew_all($self);
754 # my ($self, $patron_id, $patron_pwd, $fee_ack) = @_;
755 # my ($patron, $item_id);
758 # $trans = new ILS::Transaction::RenewAll;
760 # $trans->patron($patron = new ILS::Patron $patron_id);
761 # if (defined $patron) {
762 # syslog("LOG_DEBUG", "ILS::renew_all: patron '%s': renew_ok: %s",
763 # $patron->name, $patron->renew_ok);
765 # syslog("LOG_DEBUG", "ILS::renew_all: Invalid patron id: '%s'",
769 # if (!defined($patron)) {
770 # $trans->screen_msg("Invalid patron barcode.");
772 # } elsif (!$patron->renew_ok) {
773 # $trans->screen_msg("Renewals not allowed.");
775 # } elsif (defined($patron_pwd) && !$patron->check_password($patron_pwd)) {
776 # $trans->screen_msg("Invalid patron password.");
780 # foreach $item_id (@{$patron->{items}}) {
781 # my $item = new ILS::Item $item_id;
783 # if (!defined($item)) {
784 # syslog("LOG_WARNING",
785 # "renew_all: Invalid item id associated with patron '%s'",
790 # if (@{$item->hold_queue}) {
791 # # Can't renew if there are outstanding holds
792 # push @{$trans->unrenewed}, $item_id;
794 # $item->{due_date} = time + (14*24*60*60); # two weeks hence
795 # push @{$trans->renewed}, $item_id;