3 # A Class for hiding the ILS's concept of the patron from the OpenSIP
7 package OpenILS::SIP::Patron;
13 use Sys::Syslog qw(syslog);
15 use Digest::MD5 qw(md5_hex);
18 use OpenILS::Application::AppUtils;
19 use OpenILS::Application::Actor;
20 use OpenSRF::Utils qw/:datetime/;
21 use DateTime::Format::ISO8601;
22 my $U = 'OpenILS::Application::AppUtils';
24 our (@ISA, @EXPORT_OK);
28 @EXPORT_OK = qw(invalid_patron);
35 my $patron_id = shift;
38 if ($key ne 'usr' and $key ne 'barcode') {
39 syslog("LOG_ERROR", "Patron (card) lookup requested by illegeal key '$key'");
43 unless(defined $patron_id) {
44 syslog("LOG_WARNING", "No patron ID provided to ILS::Patron->new");
48 my $type = ref($class) || $class;
49 my $self = bless({}, $type);
51 syslog("LOG_DEBUG", "OILS: new OpenILS Patron(%s => %s): searching...", $key, $patron_id);
53 my $e = OpenILS::SIP->editor();
72 # in some cases, we don't need all of this data. Only fetch the user + barcode
73 $usr_flesh = {flesh => 1, flesh_fields => {au => ['card']}} if $args{slim_user};
76 if($key eq 'barcode') { # retrieve user by barcode
78 $$usr_flesh{flesh} += 1;
79 $$usr_flesh{flesh_fields}{ac} = ['usr'];
81 my $card = $e->search_actor_card([{barcode => $patron_id}, $usr_flesh])->[0];
83 if(!$card or !$U->is_true($card->active)) {
84 syslog("LOG_WARNING", "No such patron barcode: $patron_id");
91 $user = $e->retrieve_actor_user([$patron_id, $usr_flesh]);
94 if(!$user or $U->is_true($user->deleted)) {
95 syslog("LOG_WARNING", "OILS: Unable to find patron %s => %s", $key, $patron_id);
99 if(!$U->is_true($user->active)) {
100 syslog("LOG_WARNING", "OILS: Patron is inactive %s => %s", $key, $patron_id);
104 # now grab the user's penalties
106 $self->flesh_user_penalties($user, $e) unless $args{slim_user};
108 $self->{authtoken} = $args{authtoken} if $args{authtoken};
109 $self->{editor} = $e;
110 $self->{user} = $user;
111 $self->{id} = ($key eq 'barcode') ? $patron_id : $user->card->barcode; # The barcode IS the ID to SIP.
112 # We give back the passed barcode if the key was indeed a barcode, just to be safe. Otherwise pull it from the card.
114 syslog("LOG_DEBUG", "OILS: new OpenILS Patron(%s => %s): found patron : barred=%s, card:active=%s",
115 $key, $patron_id, $user->barred, $user->card->active );
117 $U->log_user_activity($user->id, $self->get_act_who, 'verify');
124 my $config = OpenILS::SIP->config();
125 my $login = OpenILS::SIP->login_account();
127 my $act_who = $config->{implementation_config}->{default_activity_who};
128 my $force_who = $config->{implementation_config}->{force_activity_who};
130 # 1. future: test sip extension for caller-provided ewho and !$force_who
132 # 2. See if the login is tagged with an ewho
133 return $login->{activity_who} if $login->{activity_who};
135 # 3. if all else fails, see if there is an institution-wide ewho
136 return $config->{activity_who} if $config->{activity_who};
141 # grab patron penalties. Only grab non-archived penalties that are for fines,
142 # excessive overdues, or otherwise block circluation activity
143 sub flesh_user_penalties {
144 my ($self, $user, $e) = @_;
146 $user->standing_penalties(
147 $e->search_actor_user_standing_penalty([
152 # ignore "archived" penalties
153 {stop_date => undef},
154 {stop_date => {'>' => 'now'}}
162 transform => 'actor.org_unit_ancestors',
168 # at this point, there is no concept of "here", so fetch penalties
169 # for the patron's home lib plus ancestors
170 where => {id => $user->home_ou},
175 # in addition to fines and excessive overdue penalties,
176 # we only care about penalties that result in blocks
177 standing_penalty => {
179 select => {csp => ['id']},
183 {id => [1,2]}, # fines / overdues
184 {block_list => {'!=' => undef}}
201 return format_name($self->{user});
206 return OpenILS::SIP::clean_text(
208 ($u->first_given_name || ''),
209 ($u->second_given_name || ''),
210 ($u->family_name || '')));
215 my $lib = OpenILS::SIP::shortname_from_id($self->{user}->home_ou);
216 syslog('LOG_DEBUG', "OILS: Patron->home_library() = $lib");
222 return "" unless $addr;
223 my $return = OpenILS::SIP::clean_text(
224 join( ' ', map {$_ || ''} (
235 $return =~ s/\s+/ /sg; # Compress any run of of whitespace to one space
241 return $self->{user}->id;
246 my $u = $self->{user};
247 my $str = __addr_string($u->billing_address || $u->mailing_address);
248 syslog('LOG_DEBUG', "OILS: Patron address: $str");
254 return OpenILS::SIP::clean_text($self->{user}->email);
259 return $self->{user}->day_phone;
264 my $dob = OpenILS::SIP->format_date($self->{user}->dob);
265 syslog('LOG_DEBUG', "OILS: Patron DOB = $dob");
271 my $expire = OpenILS::SIP->format_date($self->{user}->expire_date);
272 syslog('LOG_DEBUG', "OILS: Patron Expire = $expire");
279 my $use_code = OpenILS::SIP->get_option_value('patron_type_uses_code') || '';
281 # should we use the no_i18n version of patron profile name (as a 'code')?
282 return $self->{editor}->retrieve_permission_grp_tree(
283 [$self->{user}->profile->id, {no_i18n => 1}])->name
284 if $use_code =~ /true/io;
286 return OpenILS::SIP::clean_text($self->{user}->profile->name);
291 return '000'; # Unspecified
294 # How much more detail do we need to check here?
295 # sec: adding logic to return false if user is barred, has a circulation block
299 my $u = $self->{user};
301 # compute expiration date for borrowing privileges
302 my $expire = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($u->expire_date));
304 # determine whether patron should be allowed to circulate materials:
305 # not barred, doesn't owe too much wrt fines/fees, privileges haven't
307 my $circ_is_blocked =
308 (($u->barred eq 't') or
309 ($u->standing_penalties and @{$u->standing_penalties}) or
310 (CORE::time > $expire->epoch));
313 !$circ_is_blocked and
314 $u->active eq 't' and
315 $u->card->active eq 't';
320 # How much more detail do we need to check here?
323 return $self->charge_ok;
328 return $self->charge_ok if
329 OpenILS::SIP->get_option_value('patron_calculate_recal_ok');
335 return $self->charge_ok;
338 # return true if the card provided is marked as lost
341 return $self->{user}->card->active eq 'f';
344 sub recall_overdue { # not implemented
350 my ($self, $pwd) = @_;
351 syslog('LOG_DEBUG', 'OILS: Patron->check_password()');
352 return 0 unless (defined $pwd and $self->{user});
353 return md5_hex($pwd) eq $self->{user}->passwd;
356 sub currency { # not really implemented
358 syslog('LOG_DEBUG', 'OILS: Patron->currency()');
364 syslog('LOG_DEBUG', 'OILS: Patron->fee_amount()');
365 my $user_id = $self->{user}->id;
367 my $e = $self->{editor};
369 my $summary = $e->retrieve_money_open_user_summary($user_id);
370 $e->rollback; # xact_rollback + disconnect
372 my $total = ($summary) ? $summary->balance_owed : 0;
373 syslog('LOG_INFO', "User ".$self->{id} .":$user_id has a fee amount of \$$total");
379 my $u = $self->{user};
381 return 'barred' if $u->barred eq 't';
385 return $b if $u->active eq 'f';
386 return $b if $u->card->active eq 'f';
388 # if we have any penalties at this point, they are blocking penalties
389 return $b if $u->standing_penalties and @{$u->standing_penalties};
391 # has the patron account expired?
392 my $expire = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($u->expire_date));
393 return $b if CORE::time > $expire->epoch;
398 sub print_line { # not implemented
403 sub too_many_charged { # not implemented
408 sub too_many_overdue {
410 return scalar( # PATRON_EXCEEDS_OVERDUE_COUNT
411 grep { $_->standing_penalty == 2 } @{$self->{user}->standing_penalties}
415 # not completely sure what this means
416 sub too_many_renewal {
421 # not relevant, handled by fines/fees
422 sub too_many_claim_return {
427 # not relevant, handled by fines/fees
433 sub excessive_fines {
435 return scalar( # PATRON_EXCEEDS_FINES
436 grep { $_->standing_penalty == 1 } @{$self->{user}->standing_penalties}
440 # Until someone suggests otherwise, fees and fines are the same
444 return $self->excessive_fines;
447 # not relevant, handled by fines/fees
448 sub too_many_billed {
456 # List of outstanding holds placed
459 my ($self, $start, $end) = @_;
460 syslog('LOG_DEBUG', 'OILS: Patron->hold_items()');
462 my $holds = $self->{editor}->search_action_hold_request(
463 { usr => $self->{user}->id, fulfillment_time => undef, cancel_time => undef }
467 push( @holds, OpenILS::SIP::clean_text($self->__hold_to_title($_)) ) for @$holds;
469 return (defined $start and defined $end) ?
470 [ $holds[($start-1)..($end-1)] ] :
474 sub __hold_to_title {
477 my $e = $self->{editor};
479 my( $id, $mods, $title, $volume, $copy );
481 return __copy_to_title($e,
482 $e->retrieve_asset_copy($hold->target))
483 if $hold->hold_type eq 'C' or $hold->hold_type eq 'F' or $hold->hold_type eq 'R';
485 return __volume_to_title($e,
486 $e->retrieve_asset_call_number($hold->target))
487 if $hold->hold_type eq 'V';
489 return __record_to_title(
490 $e, $hold->target) if $hold->hold_type eq 'T';
492 return __metarecord_to_title(
493 $e, $hold->target) if $hold->hold_type eq 'M';
496 sub __copy_to_title {
497 my( $e, $copy ) = @_;
498 #syslog('LOG_DEBUG', "OILS: copy_to_title(%s)", $copy->id);
499 return $copy->dummy_title if $copy->call_number == -1;
501 my $vol = (ref $copy->call_number) ?
503 $e->retrieve_asset_call_number($copy->call_number);
505 return __volume_to_title($e, $vol);
509 sub __volume_to_title {
510 my( $e, $volume ) = @_;
511 #syslog('LOG_DEBUG', "OILS: volume_to_title(%s)", $volume->id);
512 return __record_to_title($e, $volume->record);
516 sub __record_to_title {
517 my( $e, $title_id ) = @_;
518 #syslog('LOG_DEBUG', "OILS: record_to_title($title_id)");
519 my $mods = $U->simplereq(
521 'open-ils.search.biblio.record.mods_slim.retrieve', $title_id );
522 return ($mods) ? $mods->title : "";
525 sub __metarecord_to_title {
526 my( $e, $m_id ) = @_;
527 #syslog('LOG_DEBUG', "OILS: metarecord_to_title($m_id)");
528 my $mods = $U->simplereq(
530 'open-ils.search.biblio.metarecord.mods_slim.retrieve', $m_id);
531 return ($U->event_code($mods)) ? "<unknown>" : $mods->title;
536 # remove the hold on item item_id from my hold queue.
537 # return true if I was holding the item, false otherwise.
540 my ($self, $item_id) = @_;
544 sub __patron_items_info {
546 return if $self->{item_info};
548 OpenILS::Application::Actor::_checked_out(
549 0, $self->{editor}, $self->{user}->id);;
555 my ($self, $start, $end) = @_;
557 $self->__patron_items_info();
558 my @overdues = @{$self->{item_info}->{overdue}};
559 #$overdues[$_] = __circ_to_title($self->{editor}, $overdues[$_]) for @overdues;
562 syslog('LOG_DEBUG', "OILS: overdue_items() fleshing circs @overdues");
564 my $return_datatype = OpenILS::SIP->get_option_value('msg64_summary_datatype') || '';
566 for my $circid (@overdues) {
568 if($return_datatype eq 'barcode') {
569 push( @o, __circ_to_barcode($self->{editor}, $circid));
571 push( @o, OpenILS::SIP::clean_text(__circ_to_title($self->{editor}, $circid)));
576 return (defined $start and defined $end) ?
577 [ $overdues[($start-1)..($end-1)] ] : \@overdues;
580 sub __circ_to_barcode {
583 $circ = $e->retrieve_action_circulation($circ);
584 my $copy = $e->retrieve_asset_copy($circ->target_copy);
585 return $copy->barcode;
588 sub __circ_to_title {
589 my( $e, $circ ) = @_;
591 $circ = $e->retrieve_action_circulation($circ);
592 return __copy_to_title( $e,
593 $e->retrieve_asset_copy($circ->target_copy) );
597 my ($self, $start, $end) = shift;
599 $self->__patron_items_info();
602 @{$self->{item_info}->{out}},
603 @{$self->{item_info}->{overdue}}
606 #$charges[$_] = __circ_to_title($self->{editor}, $charges[$_]) for @charges;
609 syslog('LOG_DEBUG', "OILS: charged_items() fleshing circs @charges");
611 my $return_datatype = OpenILS::SIP->get_option_value('msg64_summary_datatype') || '';
613 for my $circid (@charges) {
615 if($return_datatype eq 'barcode') {
616 push( @c, __circ_to_barcode($self->{editor}, $circid));
618 push( @c, OpenILS::SIP::clean_text(__circ_to_title($self->{editor}, $circid)));
624 return (defined $start and defined $end) ?
625 [ $charges[($start-1)..($end-1)] ] :
630 my ($self, $start, $end) = @_;
633 my $xacts = $U->simplereq('open-ils.actor', 'open-ils.actor.user.transactions.history.have_balance', $self->{authtoken}, $self->{user}->id);
634 foreach my $xact (@{$xacts}) {
635 my $line = $xact->balance_owed . " " . $xact->last_billing_type . " ";
636 if ($xact->xact_type eq 'circulation') {
637 my $mods = $U->simplereq('open-ils.circ', 'open-ils.circ.circ_transaction.find_title', $self->{authtoken}, $xact->id);
638 $line .= $mods->title . ' / ' . $mods->author;
640 $line .= $xact->last_billing_note;
642 push @fines, OpenILS::SIP::clean_text($line);
645 my $log_status = $@ ? 'ERROR: ' . $@ : 'OK';
646 syslog('LOG_DEBUG', 'OILS: Patron->fine_items() ' . $log_status);
647 return (defined $start and defined $end) ?
648 [ $fines[($start-1)..($end-1)] ] : \@fines;
651 # not currently supported
653 my ($self, $start, $end) = @_;
658 my ($self, $start, $end) = @_;
659 syslog('LOG_DEBUG', 'OILS: Patron->unavail_holds()');
661 my $ids = $self->{editor}->json_query({
662 select => {ahr => ['id']},
665 usr => $self->{user}->id,
666 fulfillment_time => undef,
667 cancel_time => undef,
669 {current_shelf_lib => undef},
670 {current_shelf_lib => {'!=' => {'+ahr' => 'pickup_lib'}}}
675 my @holds_sip_output;
676 @holds_sip_output = map {
677 OpenILS::SIP::clean_text($self->__hold_to_title($_))
679 $self->{editor}->search_action_hold_request(
680 {id => [map {$_->{id}} @$ids]}
684 return (defined $start and defined $end) ?
685 [ @holds_sip_output[($start-1)..($end-1)] ] :
690 my ($self, $card_retained, $blocked_card_msg) = @_;
691 $blocked_card_msg ||= '';
693 my $e = $self->{editor};
694 my $u = $self->{user};
696 syslog('LOG_INFO', "OILS: Blocking user %s", $u->card->barcode );
698 return $self if $u->card->active eq 'f';
700 $e->xact_begin; # connect and start a new transaction
702 $u->card->active('f');
703 if( ! $e->update_actor_card($u->card) ) {
704 syslog('LOG_ERR', "OILS: Block card update failed: %s", $e->event->{textcode});
705 $e->rollback; # rollback + disconnect
709 # retrieve the un-fleshed user object for update
710 $u = $e->retrieve_actor_user($u->id);
711 my $note = OpenILS::SIP::clean_text($u->alert_message) || "";
712 $note = "<sip> CARD BLOCKED BY SELF-CHECK MACHINE. $blocked_card_msg</sip>\n$note"; # XXX Config option
713 $note =~ s/\s*$//; # kill trailng whitespace
714 $u->alert_message($note);
716 if( ! $e->update_actor_user($u) ) {
717 syslog('LOG_ERR', "OILS: Block: patron alert update failed: %s", $e->event->{textcode});
718 $e->rollback; # rollback + disconnect
723 $self->{user}->alert_message( $note );
725 $e->commit; # commits and disconnects
729 # Testing purposes only
731 my ($self, $card_retained) = @_;
732 $self->{screen_msg} = "All privileges restored.";
734 # Un-mark card as inactive, grep out the patron alert
735 my $e = $self->{editor};
736 my $u = $self->{user};
738 syslog('LOG_INFO', "OILS: Unblocking user %s", $u->card->barcode );
740 return $self if $u->card->active eq 't';
742 $e->xact_begin; # connect and start a new transaction
744 $u->card->active('t');
745 if( ! $e->update_actor_card($u->card) ) {
746 syslog('LOG_ERR', "OILS: Unblock card update failed: %s", $e->event->{textcode});
747 $e->rollback; # rollback + disconnect
751 # retrieve the un-fleshed user object for update
752 $u = $e->retrieve_actor_user($u->id);
753 my $note = OpenILS::SIP::clean_text($u->alert_message) || "";
754 $note =~ s#<sip>.*</sip>##;
755 $note =~ s/^\s*//; # kill leading whitespace
756 $note =~ s/\s*$//; # kill trailng whitespace
757 $u->alert_message($note);
759 if( ! $e->update_actor_user($u) ) {
760 syslog('LOG_ERR', "OILS: Unblock: patron alert update failed: %s", $e->event->{textcode});
761 $e->rollback; # rollback + disconnect
766 $self->{user}->alert_message( $note );
768 $e->commit; # commits and disconnects
777 return "Please contact library staff";
781 return "Please contact library staff";
784 sub inet_privileges {
786 my $e = OpenILS::SIP->editor();
787 $INET_PRIVS = $e->retrieve_all_config_net_access_level() unless $INET_PRIVS;
788 my ($level) = grep { $_->id eq $self->{user}->net_access_level } @$INET_PRIVS;
789 my $name = OpenILS::SIP::clean_text($level->name);
790 syslog('LOG_DEBUG', "OILS: Patron inet_privs = $name");
796 my $extra_fields = {};
797 my $u = $self->{user};
798 foreach my $stat_cat_entry (@{$u->stat_cat_entries}) {
799 my $stat_cat = $stat_cat_entry->stat_cat;
800 next unless ($stat_cat->sip_field);
801 my $value = $stat_cat_entry->stat_cat_entry;
802 if(defined $stat_cat->sip_format && length($stat_cat->sip_format) > 0) { # Has a format string?
803 if($stat_cat->sip_format =~ /^\|(.*)\|$/) { # Regex match?
804 if($value =~ /($1)/) { # If we have a match
805 if(defined $2) { # Check to see if they embedded a capture group
806 $value = $2; # If so, use it
808 else { # No embedded capture group?
809 $value = $1; # Use our outer one
813 $value = ''; # Empty string. Will be checked for below.
816 else { # Not a regex match - Try sprintf match (looking for a %s, if any)
817 $value = sprintf($stat_cat->sip_format, $value);
820 next unless length($value) > 0; # No value = no export
821 $value =~ s/\|//g; # Remove all lingering pipe chars for sane output purposes
822 $extra_fields->{ $stat_cat->sip_field } = [] unless (defined $extra_fields->{$stat_cat->sip_field});
823 push(@{$extra_fields->{ $stat_cat->sip_field}}, $value);
825 return $extra_fields;