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 my ($class, $institution, $login) = @_;
47 my $type = ref($class) || $class;
50 $self->{login} = $login_account = $login;
52 $config = $institution;
53 syslog("LOG_DEBUG", "OILS: new ILS '%s'", $institution->{id});
54 $self->{institution} = $institution;
56 my $bsconfig = $institution->{implementation_config}->{bootstrap};
57 $target_encoding = $institution->{implementation_config}->{encoding} || 'ascii';
59 syslog('LOG_DEBUG', "OILS: loading bootstrap config: $bsconfig");
61 # ingress will persist throughout
62 OpenSRF::AppSession->ingress('sip2');
64 local $/ = "\n"; # why?
65 OpenSRF::System->bootstrap_client(config_file => $bsconfig);
66 syslog('LOG_DEBUG', "OILS: bootstrap loaded..");
68 $self->{osrf_config} = OpenSRF::Utils::SettingsClient->new;
70 Fieldmapper->import($self->{osrf_config}->config_value('IDL'));
72 bless( $self, $type );
75 $self->login( $login->{id}, $login->{password} );
83 my $ses = $U->simplereq(
85 'open-ils.auth.session.retrieve', $self->{authtoken});
87 return undef if $U->event_code($ses); # auth timed out
88 return $self->{login_session} = $ses;
94 return 1 if $self->fetch_session;
96 syslog('LOG_INFO', "OILS: Logging back after session timeout as user ".$self->{login}->{id});
97 return $self->login( $self->{login}->{id}, $self->{login}->{password} );
101 return $editor = make_editor();
108 return $login_account;
111 sub get_option_value {
112 my($self, $option) = @_;
113 my $ops = $config->{implementation_config}->{options}->{option};
114 $ops = [$ops] unless ref $ops eq 'ARRAY';
115 my @vals = grep { $_->{name} eq $option } @$ops;
116 return @vals ? $vals[0]->{value} : undef;
120 # Creates the global editor object
121 my $cstore_init = 1; # call init on first use
123 OpenILS::Utils::CStoreEditor::init() if $cstore_init;
125 return OpenILS::Utils::CStoreEditor->new;
128 =head2 clean_text(scalar)
130 Evergreen uses the UTF8 encoding for everything from the database up. Perl
131 doesn't know this, however, so we have to convince it to treat our UTF8 strings
132 as UTF8 strings. This may enable OpenNCIP to correctly calculate the checksums
133 for UTF8 text for SIP clients that support such modern options.
135 The target encoding is set in the <encoding> element of the SIPServer.pm
141 my $text = shift || '';
143 # Convert our incoming UTF8 data into Perl's internal string format
145 # Also convert to Normalization Form D, as the ASCII, iso-8859-1,
146 # and latin-1 encodings (at least) require this to substitute
147 # characters rather than simply returning a string truncated
148 # after the first non-ASCII character
149 $text = NFD(decode_utf8($text));
151 if ($target_encoding eq 'ascii') {
153 # Try to maintain a reasonable version of the content by
154 # stripping diacritics from the text, given that the SIP client
155 # wants just plain ASCII. This is the base requirement according
156 # to the SIP2 specification.
158 # Stripping the combining characters converts ""béè♁ts"
159 # into "bee?ts" instead of "b???ts" - better, eh?
163 # Characters that cannot be represented in the target encoding will
164 # generally be replaced with a question mark (?) character.
165 $text = encode($target_encoding, $text);
171 sub shortname_from_id {
172 my $id = shift or return;
173 return $id->shortname if ref $id;
174 return $org_sn_cache{$id} if $org_sn_cache{$id};
175 return $org_sn_cache{$id} = editor()->retrieve_actor_org_unit($id)->shortname;
177 sub patron_barcode_from_id {
178 my $id = shift or return;
179 return editor()->search_actor_card({ usr => $id, active => 't' })->[0]->barcode;
185 my $type = shift || 'dob';
187 return "" unless $date;
189 my $dt = DateTime::Format::ISO8601->new->
190 parse_datetime(OpenSRF::Utils::cleanse_ISO8601($date));
191 my @time = localtime($dt->epoch);
193 my $year = $time[5]+1900;
194 my $mon = $time[4]+1;
197 my $minute = $time[1];
198 my $second = $time[0];
200 $date = sprintf("%04d%02d%02d", $year, $mon, $day);
202 # Due dates need hyphen separators and time of day as well
203 if ($type eq 'due') {
205 my $use_sdf = $class->get_option_value('use_sip_date_format') | '';
207 if ($use_sdf =~ /true/i) {
208 $date = $dt->strftime(SIP_DATETIME);
211 $date = sprintf("%04d-%02d-%02d %02d:%02d:%02d",
212 $year, $mon, $day, $hour, $minute, $second);
216 syslog('LOG_DEBUG', "OILS: formatted date [type=$type]: $date");
223 my( $self, $username, $password ) = @_;
224 syslog('LOG_DEBUG', "OILS: Logging in with username $username");
226 my $seed = $U->simplereq(
228 'open-ils.auth.authenticate.init', $username );
230 my $response = $U->simplereq(
232 'open-ils.auth.authenticate.complete',
234 username => $username,
235 password => md5_hex($seed . md5_hex($password)),
240 if( my $code = $U->event_code($response) ) {
241 my $txt = $response->{textcode};
242 syslog('LOG_WARNING', "OILS: Login failed for $username. $txt:$code");
246 my $key = $response->{payload}->{authtoken};
247 syslog('LOG_INFO', "OILS: Login succeeded for $username : authkey = $key");
249 $self->{authtoken} = $key;
251 $self->fetch_session; # to cache the login
257 # find_patron($barcode);
258 # find_patron(barcode => $barcode); # same as above
259 # find_patron(usr => $id);
263 my $key = (@_ > 1) ? shift : 'barcode'; # if we have multiple args, the first is the key index (default barcode)
264 my $patron_id = shift;
266 return OpenILS::SIP::Patron->new($key => $patron_id, authtoken => $self->{authtoken}, @_);
272 return OpenILS::SIP::Item->new(@_);
278 return $self->{institution}->{id}; # consider making this return the whole institution
283 return $self->{institution}->{id}; # then use this for just the ID
287 my ($self, $op) = @_;
288 my ($i) = grep { $_->{name} eq $op }
289 @{$config->{implementation_config}->{supports}->{item}};
290 return to_bool($i->{value});
294 my ($self, $id, $whence) = @_;
295 if ($id ne $self->{institution}->{id}) {
296 syslog("LOG_WARNING", "OILS: %s: received institution '%s', expected '%s'", $whence, $id, $self->{institution}->{id});
297 # Just an FYI check, we don't expect the user to change location from that in SIPconfig.xml
304 # If it's defined, and matches a true sort of string, or is
305 # a non-zero number, then it's true.
306 defined($bool) or return; # false
307 ($bool =~ /true|y|yes/i) and return 1; # true
308 return ($bool =~ /^\d+$/ and $bool != 0); # true for non-zero numbers, false otherwise
312 return to_bool($config->{policy}->{checkout});
316 return to_bool($config->{policy}->{checkin});
320 return to_bool($config->{policy}->{renewal});
323 sub status_update_ok {
324 return to_bool($config->{policy}->{status_update});
328 return to_bool($config->{policy}->{offline});
334 ## Checkout(patron_id, item_id, sc_renew, fee_ack):
335 ## patron_id & item_id are the identifiers send by the terminal
336 ## sc_renew is the renewal policy configured on the terminal
337 ## returns a status opject that can be queried for the various bits
338 ## of information that the protocol (SIP or NCIP) needs to generate
340 ## fee_ack is the fee_acknowledged field (BO) sent from the sc
341 ## when doing chargeable loans.
345 my ($self, $patron_id, $item_id, $sc_renew, $fee_ack) = @_;
346 # In order to allow renewals the selfcheck AND the config have to say they are allowed
347 $sc_renew = (chr($sc_renew) eq 'Y' && $self->renew_ok());
349 $self->verify_session;
351 syslog('LOG_DEBUG', "OILS: OpenILS::Checkout attempt: patron=$patron_id, item=$item_id");
353 my $xact = OpenILS::SIP::Transaction::Checkout->new( authtoken => $self->{authtoken} );
354 my $patron = $self->find_patron($patron_id);
355 my $item = $self->find_item($item_id);
357 $xact->patron($patron);
361 $xact->screen_msg("Invalid Patron Barcode '$patron_id'");
365 if (!$patron->charge_ok) {
366 $xact->screen_msg("Patron Blocked");
371 $xact->screen_msg("Invalid Item Barcode: '$item_id'");
375 syslog('LOG_DEBUG', "OILS: OpenILS::Checkout data loaded OK, checking out...");
377 if ($item->{patron} && ($item->{patron} eq $patron_id)) {
378 $xact->renew_ok(1); # So that accept/reject responses have the correct value later
380 syslog('LOG_INFO', "OILS: OpenILS::Checkout data loaded OK, doing renew...");
382 syslog('LOG_INFO', "OILS: OpenILS::Checkout appears to be renew, but renewal disallowed...");
383 $xact->screen_msg("Renewals not permitted");
385 return $xact; # Don't attempt later
387 } elsif ($item->{patron} && ($item->{patron} ne $patron_id)) {
388 # I can't deal with this right now
389 # XXX check in then check out?
390 $xact->screen_msg("Item checked out to another patron");
392 return $xact; # Don't wipe out the screen message later
397 # Check for fee and $fee_ack. If there is a fee, and $fee_ack
398 # is 'Y', we proceed, otherwise we reject the checkout.
399 if ($item->fee > 0.0) {
400 $xact->fee_amount($item->fee);
401 $xact->sip_fee_type($item->sip_fee_type);
402 $xact->sip_currency($item->fee_currency);
403 if ($fee_ack && $fee_ack eq 'Y') {
406 $xact->screen_msg('Fee required');
412 $xact->do_checkout($sc_renew);
413 $xact->desensitize(!$item->magnetic);
417 syslog("LOG_DEBUG", "OILS: OpenILS::Checkout: " .
418 "patron %s checkout %s succeeded", $patron_id, $item_id);
420 #editor()->xact_rollback;
421 syslog("LOG_DEBUG", "OILS: OpenILS::Checkout: " .
422 "patron %s checkout %s FAILED, rolling back xact...", $patron_id, $item_id);
430 my ($self, $item_id, $inst_id, $trans_date, $return_date,
431 $current_loc, $item_props, $cancel) = @_;
433 my $start_time = time();
435 $self->verify_session;
437 syslog('LOG_DEBUG', "OILS: OpenILS::Checkin of item=$item_id (to $inst_id)");
439 my $xact = OpenILS::SIP::Transaction::Checkin->new(authtoken => $self->{authtoken});
440 my $item = OpenILS::SIP::Item->new($item_id);
442 unless ( $xact->item($item) ) {
444 # $circ->alert(1); $circ->alert_type(99);
445 $xact->screen_msg("Invalid Item Barcode: '$item_id'");
446 syslog('LOG_INFO', "OILS: Checkin failed. " . $xact->screen_msg() );
450 $xact->do_checkin( $self, $inst_id, $trans_date, $return_date, $current_loc, $item_props );
453 $xact->patron($self->find_patron(usr => $xact->{circ_user_id}, slim_user => 1)) if $xact->{circ_user_id};
454 delete $item->{patron};
455 delete $item->{due_date};
456 syslog('LOG_INFO', "OILS: Checkin succeeded");
458 syslog('LOG_WARNING', "OILS: Checkin failed");
461 syslog('LOG_INFO', "OILS: SIP Checkin request took %0.3f seconds", (time() - $start_time));
465 ## If the ILS caches patron information, this lets it free it up.
466 ## Also, this could be used for centrally logging session duration.
467 ## We don't do anything with it.
468 sub end_patron_session {
469 my ($self, $patron_id) = @_;
470 return (1, 'Thank you!', '');
475 my ($self, $patron_id, $patron_pwd, $fee_amt, $fee_type,
476 $pay_type, $fee_id, $trans_id, $currency) = @_;
478 $self->verify_session;
480 my $xact = OpenILS::SIP::Transaction::FeePayment->new(authtoken => $self->{authtoken});
481 my $patron = $self->find_patron($patron_id);
484 $xact->screen_msg("Invalid Patron Barcode '$patron_id'");
489 $xact->patron($patron);
490 $xact->sip_currency($currency);
491 $xact->fee_amount($fee_amt);
492 $xact->sip_fee_type($fee_type);
493 $xact->transaction_id($trans_id);
494 $xact->fee_id($fee_id);
495 $xact->sip_payment_type($pay_type);
496 # We don't presently use this, but we might in the future.
497 $xact->patron_password($patron_pwd);
499 $xact->do_fee_payment();
505 # my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
506 # $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
507 # my ($patron, $item);
512 # $trans = new ILS::Transaction::Hold;
514 # # BEGIN TRANSACTION
515 # $patron = new ILS::Patron $patron_id;
517 # || (defined($patron_pwd) && !$patron->check_password($patron_pwd))) {
518 # $trans->screen_msg("Invalid Patron.");
523 # $item = new ILS::Item ($item_id || $title_id);
525 # $trans->screen_msg("No such item.");
527 # # END TRANSACTION (conditionally)
529 # } elsif ($item->fee && ($fee_ack ne 'Y')) {
530 # $trans->screen_msg = "Fee required to place hold.";
532 # # END TRANSACTION (conditionally)
537 # item_id => $item->id,
538 # patron_id => $patron->id,
539 # expiration_date => $expiry_date,
540 # pickup_location => $pickup_location,
541 # hold_type => $hold_type,
545 # $trans->patron($patron);
546 # $trans->item($item);
547 # $trans->pickup_location($pickup_location);
549 # push(@{$item->hold_queue}, $hold);
550 # push(@{$patron->{hold_items}}, $hold);
558 # Note: item_id in this context is the hold id
560 my ($self, $patron_id, $patron_pwd, $item_id, $title_id) = @_;
562 my $trans = OpenILS::SIP::Transaction::Hold->new(authtoken => $self->{authtoken});
563 my $patron = $self->find_patron($patron_id);
566 $trans->screen_msg("Invalid patron barcode.");
571 if (defined($patron_pwd) && !$patron->check_password($patron_pwd)) {
572 $trans->screen_msg('Invalid patron password.');
577 $trans->patron($patron);
578 my $hold = $patron->find_hold_from_copy($item_id);
581 syslog('LOG_WARNING', "OILS: No hold found from copy $item_id");
582 $trans->screen_msg("No such hold.");
587 if ($hold->usr ne $patron->{user}->id) {
588 $trans->screen_msg("No such hold on patron record.");
594 $trans->do_hold_cancel($self);
596 if ($trans->cancel_ok) {
597 $trans->screen_msg("Hold Cancelled.");
599 $trans->screen_msg("Hold was not cancelled.");
602 # if the hold had no current_copy, use the representative
603 # item as the item for the hold. Without this, the SIP
605 $trans->item($self->find_item($item_id)) unless $trans->item;
611 ## The patron and item id's can't be altered, but the
612 ## date, location, and type can.
614 # my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
615 # $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
616 # my ($patron, $item);
620 # $trans = new ILS::Transaction::Hold;
622 # # BEGIN TRANSACTION
623 # $patron = new ILS::Patron $patron_id;
625 # $trans->screen_msg("Invalid patron barcode.");
630 # foreach my $i (0 .. scalar @{$patron->{hold_items}}) {
631 # $hold = $patron->{hold_items}[$i];
633 # if ($hold->{item_id} eq $item_id) {
634 # # Found it. So fix it.
635 # $hold->{expiration_date} = $expiry_date if $expiry_date;
636 # $hold->{pickup_location} = $pickup_location if $pickup_location;
637 # $hold->{hold_type} = $hold_type if $hold_type;
640 # $trans->screen_msg("Hold updated.");
641 # $trans->patron($patron);
642 # $trans->item(new ILS::Item $hold->{item_id});
647 # # The same hold structure is linked into both the patron's
648 # # list of hold items and into the queue of outstanding holds
649 # # for the item, so we don't need to search the hold queue for
650 # # the item, since it's already been updated by the patron code.
653 # $trans->screen_msg("No such outstanding hold.");
661 my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
662 $no_block, $nb_due_date, $third_party, $item_props, $fee_ack) = @_;
664 $self->verify_session;
666 my $trans = OpenILS::SIP::Transaction::Renew->new( authtoken => $self->{authtoken} );
667 $trans->patron($self->find_patron($patron_id));
668 $trans->item($self->find_item($item_id));
670 if(!$trans->patron) {
671 $trans->screen_msg("Invalid patron barcode.");
676 if(!$trans->patron->renew_ok) {
677 $trans->screen_msg("Renewals not allowed.");
684 $trans->screen_msg("Title ID renewal not supported. Use item barcode.");
686 $trans->screen_msg("Invalid item barcode.");
692 if(!$trans->item->{patron} or
693 $trans->item->{patron} ne $patron_id) {
694 $trans->screen_msg("Item not checked out to " . $trans->patron->name);
699 # Perform the renewal
702 $trans->desensitize(0); # It's already checked out
703 $trans->item->{due_date} = $nb_due_date if $no_block eq 'Y';
704 $trans->item->{sip_item_properties} = $item_props if $item_props;
711 my ($self, $patron_id, $patron_pwd, $fee_ack) = @_;
713 $self->verify_session;
715 my $trans = OpenILS::SIP::Transaction::RenewAll->new(authtoken => $self->{authtoken});
716 $trans->patron($self->find_patron($patron_id));
718 if(!$trans->patron) {
719 $trans->screen_msg("Invalid patron barcode.");
724 if(!$trans->patron->renew_ok) {
725 $trans->screen_msg("Renewals not allowed.");
730 $trans->do_renew_all($self);
737 # my ($self, $patron_id, $patron_pwd, $fee_ack) = @_;
738 # my ($patron, $item_id);
741 # $trans = new ILS::Transaction::RenewAll;
743 # $trans->patron($patron = new ILS::Patron $patron_id);
744 # if (defined $patron) {
745 # syslog("LOG_DEBUG", "ILS::renew_all: patron '%s': renew_ok: %s",
746 # $patron->name, $patron->renew_ok);
748 # syslog("LOG_DEBUG", "ILS::renew_all: Invalid patron id: '%s'",
752 # if (!defined($patron)) {
753 # $trans->screen_msg("Invalid patron barcode.");
755 # } elsif (!$patron->renew_ok) {
756 # $trans->screen_msg("Renewals not allowed.");
758 # } elsif (defined($patron_pwd) && !$patron->check_password($patron_pwd)) {
759 # $trans->screen_msg("Invalid patron password.");
763 # foreach $item_id (@{$patron->{items}}) {
764 # my $item = new ILS::Item $item_id;
766 # if (!defined($item)) {
767 # syslog("LOG_WARNING",
768 # "renew_all: Invalid item id associated with patron '%s'",
773 # if (@{$item->hold_queue}) {
774 # # Can't renew if there are outstanding holds
775 # push @{$trans->unrenewed}, $item_id;
777 # $item->{due_date} = time + (14*24*60*60); # two weeks hence
778 # push @{$trans->renewed}, $item_id;