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 OpenILS::Utils::DateTime qw/:datetime/;
27 use DateTime::Format::ISO8601;
29 my $U = 'OpenILS::Application::AppUtils';
34 my $target_encoding; # FIXME: this is configured at the institution level.
36 use Digest::MD5 qw(md5_hex);
38 # Copied from Sip::Constants
40 SIP_DATETIME => "%Y%m%d %H%M%S",
44 OpenSRF::Transport::PeerHandle->retrieve->disconnect
48 my ($class, $institution, $login, $state) = @_;
49 my $type = ref($class) || $class;
52 $self->{login} = $login_account = $login;
54 $config = $institution;
55 syslog("LOG_DEBUG", "OILS: new ILS '%s'", $institution->{id});
56 $self->{institution} = $institution;
58 my $bsconfig = $institution->{implementation_config}->{bootstrap};
59 $target_encoding = $institution->{implementation_config}->{encoding} || 'ascii';
61 syslog('LOG_DEBUG', "OILS: loading bootstrap config: $bsconfig");
63 # ingress will persist throughout
64 OpenSRF::AppSession->ingress('sip2');
66 local $/ = "\n"; # why?
67 OpenSRF::System->bootstrap_client(config_file => $bsconfig);
68 syslog('LOG_DEBUG', "OILS: bootstrap loaded..");
70 $self->{osrf_config} = OpenSRF::Utils::SettingsClient->new;
72 Fieldmapper->import($self->{osrf_config}->config_value('IDL'));
74 bless( $self, $type );
77 $self->login( $login->{id}, $login->{password}, $state );
85 my $ses = $U->simplereq(
87 'open-ils.auth.session.retrieve', $self->{authtoken});
89 return undef if $U->event_code($ses); # auth timed out
90 return $self->{login_session} = $ses;
96 return 1 if $self->fetch_session;
98 syslog('LOG_INFO', "OILS: Logging back after session timeout as user ".$self->{login}->{id});
99 return $self->login( $self->{login}->{id}, $self->{login}->{password} );
103 return $editor = make_editor();
110 return $login_account;
113 sub get_option_value {
114 my($self, $option) = @_;
115 my $ops = $config->{implementation_config}->{options}->{option};
116 $ops = [$ops] unless ref $ops eq 'ARRAY';
117 my @vals = grep { $_->{name} eq $option } @$ops;
118 return @vals ? $vals[0]->{value} : undef;
122 # Creates the global editor object
123 my $cstore_init = 1; # call init on first use
125 OpenILS::Utils::CStoreEditor::init() if $cstore_init;
127 return OpenILS::Utils::CStoreEditor->new;
131 sub shortname_from_id {
132 my $id = shift or return;
133 return $id->shortname if ref $id;
134 return $org_sn_cache{$id} if $org_sn_cache{$id};
135 return $org_sn_cache{$id} = editor()->retrieve_actor_org_unit($id)->shortname;
137 sub patron_barcode_from_id {
138 my $id = shift or return;
139 return editor()->search_actor_card({ usr => $id, active => 't' })->[0]->barcode;
145 my $type = shift || '';
147 return "" unless $date;
149 my $dt = DateTime::Format::ISO8601->new->
150 parse_datetime(clean_ISO8601($date));
152 # actor.usr.dob stores dates without time/timezone, which causes
153 # DateTime to assume the date is stored as UTC. Tell DateTime
154 # to use the local time zone, instead.
155 # Other dates will have time zones and should be parsed as-is.
156 $dt->set_time_zone('local') if $type eq 'dob';
158 my @time = localtime($dt->epoch);
160 my $year = $time[5]+1900;
161 my $mon = $time[4]+1;
164 my $minute = $time[1];
165 my $second = $time[0];
167 $date = sprintf("%04d%02d%02d", $year, $mon, $day);
169 # Due dates need hyphen separators and time of day as well
170 if ($type eq 'due') {
172 my $use_sdf = $class->get_option_value('use_sip_date_format') || '';
174 if ($use_sdf =~ /true/i) {
175 $date = $dt->strftime(SIP_DATETIME);
178 $date = sprintf("%04d-%02d-%02d %02d:%02d:%02d",
179 $year, $mon, $day, $hour, $minute, $second);
183 syslog('LOG_DEBUG', "OILS: formatted date [type=$type]: $date");
190 my( $self, $username, $password, $state ) = @_;
191 syslog('LOG_DEBUG', "OILS: Logging in with username $username");
194 if ($state and ref $state and $$state{authtoken}) {
195 $self->{authtoken} = $$state{authtoken};
196 return $self->{authtoken} if ($self->fetch_session); # fetch the session
199 my $nonce = rand($$);
201 my $seed = $U->simplereq(
203 'open-ils.auth.authenticate.init', $username, $nonce );
207 username => $username,
208 password => md5_hex($seed . md5_hex($password)),
213 if ($self->{login}->{location}) {
214 $opts->{workstation} = $self->{login}->{location};
217 my $response = $U->simplereq(
219 'open-ils.auth.authenticate.complete',
223 if( my $code = $U->event_code($response) ) {
224 my $txt = $response->{textcode};
225 syslog('LOG_WARNING', "OILS: Login failed for $username. $txt:$code");
229 my $key = $response->{payload}->{authtoken};
230 syslog('LOG_INFO', "OILS: Login succeeded for $username : authkey = $key");
232 $self->{authtoken} = $key;
234 $self->fetch_session; # to cache the login
241 return { authtoken => $self->{authtoken} };
247 my $sess = $self->fetch_session;
248 return $U->ou_ancestor_setting_value($sess->home_ou, $setting);
251 sub get_barcode_regex {
253 if (!defined($self->{bc_regex})) {
254 $self->{bc_regex} = $self->get_ou_setting('opac.barcode_regex');
255 $self->{bc_regex} = '^\d' unless ($self->{bc_regex});
257 return $self->{bc_regex};
261 # find_patron($barcode);
262 # find_patron(barcode => $barcode); # same as above
263 # find_patron(usr => $id);
264 # find_patron(usrname => $usrname);
268 my $key = (@_ > 1) ? shift : 'barcode'; # if we have multiple args, the first is the key index (default barcode)
269 my $patron_id = shift;
271 # Check for usrname or barcode in the same, simple way that the OPAC does.
272 my $bc_regex = $self->get_barcode_regex();
273 if ($key eq 'barcode' && $patron_id !~ /$bc_regex/) {
277 $self->verify_session;
278 return OpenILS::SIP::Patron->new($key => $patron_id, authtoken => $self->{authtoken}, @_);
284 $self->verify_session;
285 return OpenILS::SIP::Item->new(@_);
291 return $self->{institution}->{id}; # consider making this return the whole institution
296 return $self->{institution}->{id}; # then use this for just the ID
300 my ($self, $op) = @_;
301 my ($i) = grep { $_->{name} eq $op }
302 @{$config->{implementation_config}->{supports}->{item}};
303 return to_bool($i->{value});
307 my ($self, $id, $whence) = @_;
308 if ($id ne $self->{institution}->{id}) {
309 syslog("LOG_WARNING", "OILS: %s: received institution '%s', expected '%s'", $whence, $id, $self->{institution}->{id});
310 # Just an FYI check, we don't expect the user to change location from that in SIPconfig.xml
317 # If it's defined, and matches a true sort of string, or is
318 # a non-zero number, then it's true.
319 defined($bool) or return; # false
320 ($bool =~ /true|y|yes/i) and return 1; # true
321 return ($bool =~ /^\d+$/ and $bool != 0); # true for non-zero numbers, false otherwise
325 return to_bool($config->{policy}->{checkout});
329 return to_bool($config->{policy}->{checkin});
333 return to_bool($config->{policy}->{renewal});
336 sub status_update_ok {
337 return to_bool($config->{policy}->{status_update});
341 return to_bool($config->{policy}->{offline});
347 ## Checkout(patron_id, item_id, sc_renew, fee_ack):
348 ## patron_id & item_id are the identifiers send by the terminal
349 ## sc_renew is the renewal policy configured on the terminal
350 ## returns a status opject that can be queried for the various bits
351 ## of information that the protocol (SIP or NCIP) needs to generate
353 ## fee_ack is the fee_acknowledged field (BO) sent from the sc
354 ## when doing chargeable loans.
358 my ($self, $patron_id, $item_id, $sc_renew, $fee_ack) = @_;
359 # In order to allow renewals the selfcheck AND the config have to say they are allowed
360 $sc_renew = (chr($sc_renew) eq 'Y' && $self->renew_ok());
362 $self->verify_session;
364 syslog('LOG_DEBUG', "OILS: OpenILS::Checkout attempt: patron=$patron_id, item=$item_id");
366 my $xact = OpenILS::SIP::Transaction::Checkout->new( authtoken => $self->{authtoken} );
367 my $patron = $self->find_patron($patron_id);
368 my $item = $self->find_item($item_id);
370 $xact->patron($patron);
374 $xact->screen_msg("Invalid Patron Barcode '$patron_id'");
378 if (!$patron->charge_ok) {
379 $xact->screen_msg("Patron Blocked");
384 $xact->screen_msg("Invalid Item Barcode: '$item_id'");
388 syslog('LOG_DEBUG', "OILS: OpenILS::Checkout data loaded OK, checking out...");
390 if ($item->{patron} && ($item->{patron} eq $patron_id)) {
391 $xact->renew_ok(1); # So that accept/reject responses have the correct value later
393 syslog('LOG_INFO', "OILS: OpenILS::Checkout data loaded OK, doing renew...");
395 syslog('LOG_INFO', "OILS: OpenILS::Checkout appears to be renew, but renewal disallowed...");
396 $xact->screen_msg("Renewals not permitted");
398 return $xact; # Don't attempt later
400 } elsif ($item->{patron} && ($item->{patron} ne $patron_id)) {
401 # I can't deal with this right now
402 # XXX check in then check out?
403 $xact->screen_msg("Item checked out to another patron");
405 return $xact; # Don't wipe out the screen message later
410 # Check for fee and $fee_ack. If there is a fee, and $fee_ack
411 # is 'Y', we proceed, otherwise we reject the checkout.
412 if ($item->fee > 0.0) {
413 $xact->fee_amount($item->fee);
414 $xact->sip_fee_type($item->sip_fee_type);
415 $xact->sip_currency($item->fee_currency);
416 if ($fee_ack && $fee_ack eq 'Y') {
419 $xact->screen_msg('Fee required');
425 $xact->do_checkout($sc_renew);
426 $xact->desensitize(!$item->magnetic);
430 syslog("LOG_DEBUG", "OILS: OpenILS::Checkout: " .
431 "patron %s checkout %s succeeded", $patron_id, $item_id);
433 #editor()->xact_rollback;
434 syslog("LOG_DEBUG", "OILS: OpenILS::Checkout: " .
435 "patron %s checkout %s FAILED, rolling back xact...", $patron_id, $item_id);
443 my ($self, $item_id, $inst_id, $trans_date, $return_date,
444 $current_loc, $item_props, $cancel) = @_;
446 my $start_time = time();
448 $self->verify_session;
450 syslog('LOG_DEBUG', "OILS: OpenILS::Checkin of item=$item_id (to $inst_id)");
452 my $xact = OpenILS::SIP::Transaction::Checkin->new(authtoken => $self->{authtoken});
453 my $item = OpenILS::SIP::Item->new($item_id);
455 unless ( $xact->item($item) ) {
457 # $circ->alert(1); $circ->alert_type(99);
458 $xact->screen_msg("Invalid Item Barcode: '$item_id'");
459 syslog('LOG_INFO', "OILS: Checkin failed. " . $xact->screen_msg() );
463 $xact->do_checkin( $self, $inst_id, $trans_date, $return_date, $current_loc, $item_props );
466 $xact->patron($self->find_patron(usr => $xact->{circ_user_id}, slim_user => 1)) if $xact->{circ_user_id};
467 delete $item->{patron};
468 delete $item->{due_date};
469 syslog('LOG_INFO', "OILS: Checkin succeeded");
471 syslog('LOG_WARNING', "OILS: Checkin failed");
474 syslog('LOG_INFO', "OILS: SIP Checkin request took %0.3f seconds", (time() - $start_time));
478 ## If the ILS caches patron information, this lets it free it up.
479 ## Also, this could be used for centrally logging session duration.
480 ## We don't do anything with it.
481 sub end_patron_session {
482 my ($self, $patron_id) = @_;
483 return (1, 'Thank you!', '');
488 my ($self, $patron_id, $patron_pwd, $fee_amt, $fee_type,
489 $pay_type, $fee_id, $trans_id, $currency) = @_;
491 $self->verify_session;
493 my $xact = OpenILS::SIP::Transaction::FeePayment->new(authtoken => $self->{authtoken});
494 my $patron = $self->find_patron($patron_id);
497 $xact->screen_msg("Invalid Patron Barcode '$patron_id'");
502 $xact->patron($patron);
503 $xact->sip_currency($currency);
504 $xact->fee_amount($fee_amt);
505 $xact->sip_fee_type($fee_type);
506 $xact->transaction_id($trans_id);
507 $xact->fee_id($fee_id);
508 $xact->sip_payment_type($pay_type);
509 # We don't presently use this, but we might in the future.
510 $xact->patron_password($patron_pwd);
512 $xact->do_fee_payment();
518 # my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
519 # $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
520 # my ($patron, $item);
525 # $trans = new ILS::Transaction::Hold;
527 # # BEGIN TRANSACTION
528 # $patron = new ILS::Patron $patron_id;
530 # || (defined($patron_pwd) && !$patron->check_password($patron_pwd))) {
531 # $trans->screen_msg("Invalid Patron.");
536 # $item = new ILS::Item ($item_id || $title_id);
538 # $trans->screen_msg("No such item.");
540 # # END TRANSACTION (conditionally)
542 # } elsif ($item->fee && ($fee_ack ne 'Y')) {
543 # $trans->screen_msg = "Fee required to place hold.";
545 # # END TRANSACTION (conditionally)
550 # item_id => $item->id,
551 # patron_id => $patron->id,
552 # expiration_date => $expiry_date,
553 # pickup_location => $pickup_location,
554 # hold_type => $hold_type,
558 # $trans->patron($patron);
559 # $trans->item($item);
560 # $trans->pickup_location($pickup_location);
562 # push(@{$item->hold_queue}, $hold);
563 # push(@{$patron->{hold_items}}, $hold);
571 # Note: item_id in this context is the hold id
573 my ($self, $patron_id, $patron_pwd, $item_id, $title_id) = @_;
575 my $trans = OpenILS::SIP::Transaction::Hold->new(authtoken => $self->{authtoken});
576 my $patron = $self->find_patron($patron_id);
579 $trans->screen_msg("Invalid patron barcode.");
584 if (defined($patron_pwd) && !$patron->check_password($patron_pwd)) {
585 $trans->screen_msg('Invalid patron password.');
590 $trans->patron($patron);
591 my $hold = $patron->find_hold_from_copy($item_id);
594 syslog('LOG_WARNING', "OILS: No hold found from copy $item_id");
595 $trans->screen_msg("No such hold.");
600 if ($hold->usr ne $patron->{user}->id) {
601 $trans->screen_msg("No such hold on patron record.");
607 $trans->do_hold_cancel($self);
609 if ($trans->cancel_ok) {
610 $trans->screen_msg("Hold Cancelled.");
612 $trans->screen_msg("Hold was not cancelled.");
615 # if the hold had no current_copy, use the representative
616 # item as the item for the hold. Without this, the SIP
618 $trans->item($self->find_item($item_id)) unless $trans->item;
624 ## The patron and item id's can't be altered, but the
625 ## date, location, and type can.
627 # my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
628 # $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
629 # my ($patron, $item);
633 # $trans = new ILS::Transaction::Hold;
635 # # BEGIN TRANSACTION
636 # $patron = new ILS::Patron $patron_id;
638 # $trans->screen_msg("Invalid patron barcode.");
643 # foreach my $i (0 .. scalar @{$patron->{hold_items}}) {
644 # $hold = $patron->{hold_items}[$i];
646 # if ($hold->{item_id} eq $item_id) {
647 # # Found it. So fix it.
648 # $hold->{expiration_date} = $expiry_date if $expiry_date;
649 # $hold->{pickup_location} = $pickup_location if $pickup_location;
650 # $hold->{hold_type} = $hold_type if $hold_type;
653 # $trans->screen_msg("Hold updated.");
654 # $trans->patron($patron);
655 # $trans->item(new ILS::Item $hold->{item_id});
660 # # The same hold structure is linked into both the patron's
661 # # list of hold items and into the queue of outstanding holds
662 # # for the item, so we don't need to search the hold queue for
663 # # the item, since it's already been updated by the patron code.
666 # $trans->screen_msg("No such outstanding hold.");
674 my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
675 $no_block, $nb_due_date, $third_party, $item_props, $fee_ack) = @_;
677 $self->verify_session;
679 my $trans = OpenILS::SIP::Transaction::Renew->new( authtoken => $self->{authtoken} );
680 $trans->patron($self->find_patron($patron_id));
681 $trans->item($self->find_item($item_id));
683 if(!$trans->patron) {
684 $trans->screen_msg("Invalid patron barcode.");
689 if(!$trans->patron->renew_ok) {
690 $trans->screen_msg("Renewals not allowed.");
697 $trans->screen_msg("Title ID renewal not supported. Use item barcode.");
699 $trans->screen_msg("Invalid item barcode.");
705 if(!$trans->item->{patron} or
706 $trans->item->{patron} ne $patron_id) {
707 $trans->screen_msg("Item not checked out to " . $trans->patron->name);
712 # Perform the renewal
715 $trans->desensitize(0); # It's already checked out
716 $trans->item->{due_date} = $nb_due_date if $no_block eq 'Y';
717 $trans->item->{sip_item_properties} = $item_props if $item_props;
724 my ($self, $patron_id, $patron_pwd, $fee_ack) = @_;
726 $self->verify_session;
728 my $trans = OpenILS::SIP::Transaction::RenewAll->new(authtoken => $self->{authtoken});
729 $trans->patron($self->find_patron($patron_id));
731 if(!$trans->patron) {
732 $trans->screen_msg("Invalid patron barcode.");
737 if(!$trans->patron->renew_ok) {
738 $trans->screen_msg("Renewals not allowed.");
743 $trans->do_renew_all($self);
750 # my ($self, $patron_id, $patron_pwd, $fee_ack) = @_;
751 # my ($patron, $item_id);
754 # $trans = new ILS::Transaction::RenewAll;
756 # $trans->patron($patron = new ILS::Patron $patron_id);
757 # if (defined $patron) {
758 # syslog("LOG_DEBUG", "ILS::renew_all: patron '%s': renew_ok: %s",
759 # $patron->name, $patron->renew_ok);
761 # syslog("LOG_DEBUG", "ILS::renew_all: Invalid patron id: '%s'",
765 # if (!defined($patron)) {
766 # $trans->screen_msg("Invalid patron barcode.");
768 # } elsif (!$patron->renew_ok) {
769 # $trans->screen_msg("Renewals not allowed.");
771 # } elsif (defined($patron_pwd) && !$patron->check_password($patron_pwd)) {
772 # $trans->screen_msg("Invalid patron password.");
776 # foreach $item_id (@{$patron->{items}}) {
777 # my $item = new ILS::Item $item_id;
779 # if (!defined($item)) {
780 # syslog("LOG_WARNING",
781 # "renew_all: Invalid item id associated with patron '%s'",
786 # if (@{$item->hold_queue}) {
787 # # Can't renew if there are outstanding holds
788 # push @{$trans->unrenewed}, $item_id;
790 # $item->{due_date} = time + (14*24*60*60); # two weeks hence
791 # push @{$trans->renewed}, $item_id;