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 OpenILS::Const qw/:const/;
21 use OpenSRF::Utils qw/:datetime/;
22 use DateTime::Format::ISO8601;
23 my $U = 'OpenILS::Application::AppUtils';
25 our (@ISA, @EXPORT_OK);
29 @EXPORT_OK = qw(invalid_patron);
36 my $patron_id = shift;
39 if ($key ne 'usr' and $key ne 'barcode') {
40 syslog("LOG_ERROR", "Patron (card) lookup requested by illegeal key '$key'");
44 unless(defined $patron_id) {
45 syslog("LOG_WARNING", "No patron ID provided to ILS::Patron->new");
49 my $type = ref($class) || $class;
50 my $self = bless({}, $type);
52 syslog("LOG_DEBUG", "OILS: new OpenILS Patron(%s => %s): searching...", $key, $patron_id);
54 my $e = OpenILS::SIP->editor();
55 # Pass the authtoken, if any, to the editor so that we can use it
56 # to fake a context org_unit for the csp.ignore_proximity in
57 # flesh_user_penalties, below.
58 unless ($e->authtoken()) {
59 $e->authtoken($args{authtoken}) if ($args{authtoken});
79 # in some cases, we don't need all of this data. Only fetch the user + barcode
80 $usr_flesh = {flesh => 1, flesh_fields => {au => ['card']}} if $args{slim_user};
83 if($key eq 'barcode') { # retrieve user by barcode
85 $$usr_flesh{flesh} += 1;
86 $$usr_flesh{flesh_fields}{ac} = ['usr'];
88 my $card = $e->search_actor_card([{barcode => $patron_id}, $usr_flesh])->[0];
90 if(!$card or !$U->is_true($card->active)) {
91 syslog("LOG_WARNING", "No such patron barcode: $patron_id");
98 $user = $e->retrieve_actor_user([$patron_id, $usr_flesh]);
101 if(!$user or $U->is_true($user->deleted)) {
102 syslog("LOG_WARNING", "OILS: Unable to find patron %s => %s", $key, $patron_id);
106 if(!$U->is_true($user->active)) {
107 syslog("LOG_WARNING", "OILS: Patron is inactive %s => %s", $key, $patron_id);
111 # now grab the user's penalties
113 $self->flesh_user_penalties($user, $e) unless $args{slim_user};
115 $self->{authtoken} = $args{authtoken} if $args{authtoken};
116 $self->{editor} = $e;
117 $self->{user} = $user;
118 $self->{id} = ($key eq 'barcode') ? $patron_id : $user->card->barcode; # The barcode IS the ID to SIP.
119 # We give back the passed barcode if the key was indeed a barcode, just to be safe. Otherwise pull it from the card.
121 syslog("LOG_DEBUG", "OILS: new OpenILS Patron(%s => %s): found patron : barred=%s, card:active=%s",
122 $key, $patron_id, $user->barred, $user->card->active );
124 $U->log_user_activity($user->id, $self->get_act_who, 'verify');
131 my $config = OpenILS::SIP->config();
132 my $login = OpenILS::SIP->login_account();
134 my $act_who = $config->{implementation_config}->{default_activity_who};
135 my $force_who = $config->{implementation_config}->{force_activity_who};
137 # 1. future: test sip extension for caller-provided ewho and !$force_who
139 # 2. See if the login is tagged with an ewho
140 return $login->{activity_who} if $login->{activity_who};
142 # 3. if all else fails, see if there is an institution-wide ewho
143 return $config->{activity_who} if $config->{activity_who};
148 # grab patron penalties. Only grab non-archived penalties that are for fines,
149 # excessive overdues, or otherwise block circluation activity
150 sub flesh_user_penalties {
151 my ($self, $user, $e) = @_;
153 # Use the ws_ou or home_ou of the authsession user, if any, as a
154 # context org_unit for the penalties and the csp.ignore_proximity.
156 if ($e->authtoken()) {
157 my $auth_usr = $e->checkauth();
159 $here = $auth_usr->ws_ou() || $auth_usr->home_ou();
163 # Get the "raw" list of user's penalties and flesh the
164 # standing_penalty field, so we can filter them based on
165 # csp.ignore_proximity.
167 $e->search_actor_user_standing_penalty([
172 # ignore "archived" penalties
173 {stop_date => undef},
174 {stop_date => {'>' => 'now'}}
182 transform => 'actor.org_unit_ancestors',
188 # Use "here" or user's home_ou.
189 where => {id => ($here) ? $here : $user->home_ou},
194 # in addition to fines and excessive overdue penalties,
195 # we only care about penalties that result in blocks
196 standing_penalty => {
198 select => {csp => ['id']},
202 {id => [1,2]}, # fines / overdues
203 {block_list => {'!=' => undef}}
211 flesh_fields => {ausp => ['standing_penalty']}
214 # We filter the raw penalties that apply into this array.
215 my $applied_penalties = [];
216 if (ref($raw_penalties) eq 'ARRAY' && @$raw_penalties) {
217 my $here_prox = ($here) ? $U->get_org_unit_proximity($e, $here, $user->home_ou())
219 # Filter out those that do not apply and deflesh the standing_penalty.
220 $applied_penalties = [map
221 { $_->standing_penalty($_->standing_penalty->id()) }
223 !defined($_->standing_penalty->ignore_proximity())
224 || ((defined($here_prox))
225 ? $_->standing_penalty->ignore_proximity() < $here_prox
226 : $_->standing_penalty->ignore_proximity() <
227 $U->get_org_unit_proximity($e, $_->org_unit(), $user->home_ou()))
230 $user->standing_penalties($applied_penalties);
240 return format_name($self->{user});
245 return OpenILS::SIP::clean_text(
247 ($u->first_given_name || ''),
248 ($u->second_given_name || ''),
249 ($u->family_name || '')));
254 my $lib = OpenILS::SIP::shortname_from_id($self->{user}->home_ou);
255 syslog('LOG_DEBUG', "OILS: Patron->home_library() = $lib");
261 return "" unless $addr;
262 my $return = OpenILS::SIP::clean_text(
263 join( ' ', map {$_ || ''} (
274 $return =~ s/\s+/ /sg; # Compress any run of of whitespace to one space
280 return $self->{user}->id;
285 my $u = $self->{user};
286 my $str = __addr_string($u->billing_address || $u->mailing_address);
287 syslog('LOG_DEBUG', "OILS: Patron address: $str");
293 return OpenILS::SIP::clean_text($self->{user}->email);
298 return $self->{user}->day_phone;
303 my $dob = OpenILS::SIP->format_date($self->{user}->dob, 'dob');
304 syslog('LOG_DEBUG', "OILS: Patron DOB = $dob");
310 my $expire = OpenILS::SIP->format_date($self->{user}->expire_date);
311 syslog('LOG_DEBUG', "OILS: Patron Expire = $expire");
318 my $use_code = OpenILS::SIP->get_option_value('patron_type_uses_code') || '';
320 # should we use the no_i18n version of patron profile name (as a 'code')?
321 return $self->{editor}->retrieve_permission_grp_tree(
322 [$self->{user}->profile->id, {no_i18n => 1}])->name
323 if $use_code =~ /true/io;
325 return OpenILS::SIP::clean_text($self->{user}->profile->name);
330 return '000'; # Unspecified
333 # How much more detail do we need to check here?
334 # sec: adding logic to return false if user is barred, has a circulation block
338 my $u = $self->{user};
340 # compute expiration date for borrowing privileges
341 my $expire = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($u->expire_date));
343 # determine whether patron should be allowed to circulate materials:
344 # not barred, doesn't owe too much wrt fines/fees, privileges haven't
346 my $circ_is_blocked =
347 (($u->barred eq 't') or
348 ($u->standing_penalties and @{$u->standing_penalties}) or
349 (CORE::time > $expire->epoch));
352 !$circ_is_blocked and
353 $u->active eq 't' and
354 $u->card->active eq 't';
359 my $u = $self->{user};
360 my $e = $self->{editor};
361 my $renew_block_penalty = 'f';
363 # compute expiration date for borrowing privileges
364 my $expire = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($u->expire_date));
366 # if barred or expired, forget it and save us the CPU
367 return 0 if(($u->barred eq 't') or (CORE::time > $expire->epoch));
369 # flesh penalties so we can look close at the block list
370 my $penalty_flesh = {
374 "standing_penalties",
384 my $user = $e->retrieve_actor_user([ $u->id, $penalty_flesh ]);
385 foreach( @{ $user->standing_penalties } )
387 # archived penalty - ignore
388 next if ( $_->stop_date && ( CORE::time > DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($_->stop_date))->epoch ) );
389 # check to see if this penalty blocks renewals
390 $renew_block_penalty = 't' if $_->standing_penalty->block_list =~ /RENEW/;
395 $u->card->active eq 't' &&
396 $renew_block_penalty eq 'f';
401 return $self->charge_ok if
402 OpenILS::SIP->get_option_value('patron_calculate_recal_ok');
408 return $self->charge_ok;
411 # return true if the card provided is marked as lost
414 return $self->{user}->card->active eq 'f';
417 sub recall_overdue { # not implemented
423 my ($self, $pwd) = @_;
424 syslog('LOG_DEBUG', 'OILS: Patron->check_password()');
425 return 0 unless (defined $pwd and $self->{user});
426 return $U->verify_migrated_user_password(
427 $self->{editor},$self->{user}->id, $pwd);
430 sub currency { # not really implemented
432 syslog('LOG_DEBUG', 'OILS: Patron->currency()');
433 return OpenILS::SIP->config()->{implementation_config}->{currency} || 'USD';
438 syslog('LOG_DEBUG', 'OILS: Patron->fee_amount()');
439 my $user_id = $self->{user}->id;
441 my $e = $self->{editor};
443 my $summary = $e->retrieve_money_open_user_summary($user_id);
444 $e->rollback; # xact_rollback + disconnect
446 my $total = ($summary) ? $summary->balance_owed : 0;
447 syslog('LOG_INFO', "User ".$self->{id} .":$user_id has a fee amount of \$$total");
453 my $u = $self->{user};
455 return 'barred' if $u->barred eq 't';
459 return $b if $u->active eq 'f';
460 return $b if $u->card->active eq 'f';
462 # if we have any penalties at this point, they are blocking penalties
463 return $b if $u->standing_penalties and @{$u->standing_penalties};
465 # has the patron account expired?
466 my $expire = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($u->expire_date));
467 return $b if CORE::time > $expire->epoch;
472 sub print_line { # not implemented
477 sub too_many_charged { # not implemented
482 sub too_many_overdue {
484 return scalar( # PATRON_EXCEEDS_OVERDUE_COUNT
485 grep { $_ == OILS_PENALTY_PATRON_EXCEEDS_OVERDUE_COUNT } @{$self->{user}->standing_penalties}
489 # not completely sure what this means
490 sub too_many_renewal {
495 # not relevant, handled by fines/fees
496 sub too_many_claim_return {
501 # not relevant, handled by fines/fees
507 sub excessive_fines {
509 return scalar( # PATRON_EXCEEDS_FINES
510 grep { $_ == OILS_PENALTY_PATRON_EXCEEDS_FINES } @{$self->{user}->standing_penalties}
514 # Until someone suggests otherwise, fees and fines are the same
518 return $self->excessive_fines;
521 # not relevant, handled by fines/fees
522 sub too_many_billed {
530 # List of outstanding holds placed
533 my ($self, $start, $end, $ids_only) = @_;
534 syslog('LOG_DEBUG', 'OILS: Patron->hold_items()');
537 # all of my open holds
538 my $holds = $self->{editor}->search_action_hold_request({
539 usr => $self->{user}->id,
540 fulfillment_time => undef,
544 return $holds if $ids_only;
545 return $self->__format_holds($holds, $start, $end);
549 my ($self, $start, $end, $ids_only) = @_;
550 syslog('LOG_DEBUG', 'OILS: Patron->unavail_holds()');
552 my $holds = $self->{editor}->search_action_hold_request({
553 usr => $self->{user}->id,
554 fulfillment_time => undef,
555 cancel_time => undef,
557 {current_shelf_lib => undef},
558 {current_shelf_lib => {'!=' => {'+ahr' => 'pickup_lib'}}}
562 return $holds if $ids_only;
563 return $self->__format_holds($holds, $start, $end);
569 my ($self, $holds, $start, $end) = @_;
571 return [] unless @$holds;
573 my $return_datatype =
574 OpenILS::SIP->get_option_value('msg64_hold_datatype') || '';
578 for my $hold (@$holds) {
580 if ($return_datatype eq 'barcode') {
582 if (my $copy = $self->find_copy_for_hold($hold)) {
583 push(@response, $copy->barcode);
586 syslog('LOG_WARNING',
587 'OILS: No representative copy found for hold ' . $hold->id);
592 OpenILS::SIP::clean_text($self->__hold_to_title($hold)));
596 return (defined $start and defined $end) ?
597 [ @response[($start-1)..($end-1)] ] :
601 # Finds a representative copy for the given hold.
602 # If no copy exists at all, undef is returned.
603 # The only limit placed on what constitutes a
604 # "representative" copy is that it cannot be deleted.
605 # Otherwise, any copy that allows us to find the hold
606 # later is good enough.
607 sub find_copy_for_hold {
608 my ($self, $hold) = @_;
609 my $e = $self->{editor};
611 return $e->retrieve_asset_copy($hold->current_copy)
612 if $hold->current_copy;
614 return $e->retrieve_asset_copy($hold->target)
615 if $hold->hold_type =~ /C|R|F/;
617 return $e->search_asset_copy([
618 {call_number => $hold->target, deleted => 'f'},
619 {limit => 1}])->[0] if $hold->hold_type eq 'V';
621 my $bre_ids = [$hold->target];
623 if ($hold->hold_type eq 'M') {
624 # find all of the bibs that link to the target metarecord
625 my $maps = $e->search_metabib_metarecord_source_map(
626 {metarecord => $hold->target});
627 $bre_ids = [map {$_->record} @$maps];
630 my $vol_ids = $e->search_asset_call_number(
631 {record => $bre_ids, deleted => 'f'},
635 return $e->search_asset_copy([
636 {call_number => $vol_ids, deleted => 'f'},
641 # Given a "representative" copy, finds a matching hold
642 sub find_hold_from_copy {
643 my ($self, $barcode) = @_;
644 my $e = $self->{editor};
647 my $copy = $e->search_asset_copy([
648 {barcode => $barcode, deleted => 'f'},
649 {flesh => 1, flesh_fields => {acp => ['call_number']}}
652 return undef unless $copy;
654 my $run_hold_query = sub {
656 return $e->search_action_hold_request([
657 { usr => $self->{user}->id,
658 cancel_time => undef,
659 fulfillment_time => undef,
663 order_by => {ahr => 'request_time DESC'}
668 # first see if there is a match on current_copy
669 return $hold if $hold =
670 $run_hold_query->(current_copy => $copy->id);
672 # next, assume bib-level holds are the most common
673 return $hold if $hold = $run_hold_query->(
674 target => $copy->call_number->record, hold_type => 'T');
676 # next try metarecord holds
677 my $map = $e->search_metabib_metarecord_source_map(
678 {source => $copy->call_number->record})->[0];
680 return $hold if $hold = $run_hold_query->(
681 target => $map->metarecord, hold_type => 'M');
684 return $hold if $hold = $run_hold_query->(
685 target => $copy->call_number->id, hold_type => 'V');
688 return $run_hold_query->(
689 target => $copy->id, hold_type => ['C', 'F', 'R']);
692 sub __hold_to_title {
695 my $e = $self->{editor};
697 my( $id, $mods, $title, $volume, $copy );
699 return __copy_to_title($e,
700 $e->retrieve_asset_copy($hold->target))
701 if $hold->hold_type eq 'C' or $hold->hold_type eq 'F' or $hold->hold_type eq 'R';
703 return __volume_to_title($e,
704 $e->retrieve_asset_call_number($hold->target))
705 if $hold->hold_type eq 'V';
707 return __record_to_title(
708 $e, $hold->target) if $hold->hold_type eq 'T';
710 return __metarecord_to_title(
711 $e, $hold->target) if $hold->hold_type eq 'M';
714 sub __copy_to_title {
715 my( $e, $copy ) = @_;
716 #syslog('LOG_DEBUG', "OILS: copy_to_title(%s)", $copy->id);
717 return $copy->dummy_title if $copy->call_number == -1;
719 my $vol = (ref $copy->call_number) ?
721 $e->retrieve_asset_call_number($copy->call_number);
723 return __volume_to_title($e, $vol);
727 sub __volume_to_title {
728 my( $e, $volume ) = @_;
729 #syslog('LOG_DEBUG', "OILS: volume_to_title(%s)", $volume->id);
730 return __record_to_title($e, $volume->record);
734 sub __record_to_title {
735 my( $e, $title_id ) = @_;
736 #syslog('LOG_DEBUG', "OILS: record_to_title($title_id)");
737 my $mods = $U->simplereq(
739 'open-ils.search.biblio.record.mods_slim.retrieve', $title_id );
740 return ($mods) ? $mods->title : "";
743 sub __metarecord_to_title {
744 my( $e, $m_id ) = @_;
745 #syslog('LOG_DEBUG', "OILS: metarecord_to_title($m_id)");
746 my $mods = $U->simplereq(
748 'open-ils.search.biblio.metarecord.mods_slim.retrieve', $m_id);
749 return ($U->event_code($mods)) ? "<unknown>" : $mods->title;
754 # remove the hold on item item_id from my hold queue.
755 # return true if I was holding the item, false otherwise.
758 my ($self, $item_id) = @_;
762 sub __patron_items_info {
764 return if $self->{item_info};
766 OpenILS::Application::Actor::_checked_out(
767 0, $self->{editor}, $self->{user}->id);;
773 my ($self, $start, $end, $ids_only) = @_;
775 $self->__patron_items_info();
776 my @overdues = @{$self->{item_info}->{overdue}};
777 #$overdues[$_] = __circ_to_title($self->{editor}, $overdues[$_]) for @overdues;
779 return \@overdues if $ids_only;
782 syslog('LOG_DEBUG', "OILS: overdue_items() fleshing circs @overdues");
784 my $return_datatype = OpenILS::SIP->get_option_value('msg64_summary_datatype') || '';
786 for my $circid (@overdues) {
788 if($return_datatype eq 'barcode') {
789 push( @o, __circ_to_barcode($self->{editor}, $circid));
791 push( @o, OpenILS::SIP::clean_text(__circ_to_title($self->{editor}, $circid)));
796 return (defined $start and defined $end) ?
797 [ @overdues[($start-1)..($end-1)] ] : \@overdues;
800 sub __circ_to_barcode {
803 $circ = $e->retrieve_action_circulation($circ);
804 my $copy = $e->retrieve_asset_copy($circ->target_copy);
805 return $copy->barcode;
808 sub __circ_to_title {
809 my( $e, $circ ) = @_;
811 $circ = $e->retrieve_action_circulation($circ);
812 return __copy_to_title( $e,
813 $e->retrieve_asset_copy($circ->target_copy) );
817 my ($self, $start, $end, $ids_only) = shift;
818 return $self->charged_items_impl($start, $end, undef, $ids_only);
821 # implementation method
822 # force_bc -- return barcode data regardless of msg64_summary_datatype;
823 # this is used by the renew-all code
824 sub charged_items_impl {
825 my ($self, $start, $end, $force_bc, $ids_only) = shift;
827 $self->__patron_items_info();
830 @{$self->{item_info}->{out}},
831 @{$self->{item_info}->{overdue}}
834 #$charges[$_] = __circ_to_title($self->{editor}, $charges[$_]) for @charges;
836 return \@charges if $ids_only;
839 syslog('LOG_DEBUG', "OILS: charged_items() fleshing circs @charges");
841 my $return_datatype = OpenILS::SIP->get_option_value('msg64_summary_datatype') || '';
843 for my $circid (@charges) {
845 if($return_datatype eq 'barcode' or $force_bc) {
846 push( @c, __circ_to_barcode($self->{editor}, $circid));
848 push( @c, OpenILS::SIP::clean_text(__circ_to_title($self->{editor}, $circid)));
854 return (defined $start and defined $end) ?
855 [ @charges[($start-1)..($end-1)] ] :
860 my ($self, $start, $end, $ids_only) = @_;
863 my $xacts = $U->simplereq('open-ils.actor', 'open-ils.actor.user.transactions.history.have_balance', $self->{authtoken}, $self->{user}->id);
864 foreach my $xact (@{$xacts}) {
869 my $line = $xact->balance_owed . " " . $xact->last_billing_type . " ";
870 if ($xact->xact_type eq 'circulation') {
871 my $mods = $U->simplereq('open-ils.circ', 'open-ils.circ.circ_transaction.find_title', $self->{authtoken}, $xact->id);
872 $line .= $mods->title . ' / ' . $mods->author;
874 $line .= $xact->last_billing_note;
876 push @fines, OpenILS::SIP::clean_text($line);
879 my $log_status = $@ ? 'ERROR: ' . $@ : 'OK';
880 syslog('LOG_DEBUG', 'OILS: Patron->fine_items() ' . $log_status);
881 return (defined $start and defined $end) ?
882 [ @fines[($start-1)..($end-1)] ] : \@fines;
885 # not currently supported
887 my ($self, $start, $end, $ids_only) = @_;
892 my ($self, $card_retained, $blocked_card_msg) = @_;
893 $blocked_card_msg ||= '';
895 my $e = $self->{editor};
896 my $u = $self->{user};
898 syslog('LOG_INFO', "OILS: Blocking user %s", $u->card->barcode );
900 return $self if $u->card->active eq 'f';
902 $e->xact_begin; # connect and start a new transaction
904 $u->card->active('f');
905 if( ! $e->update_actor_card($u->card) ) {
906 syslog('LOG_ERR', "OILS: Block card update failed: %s", $e->event->{textcode});
907 $e->rollback; # rollback + disconnect
911 # retrieve the un-fleshed user object for update
912 $u = $e->retrieve_actor_user($u->id);
913 my $note = OpenILS::SIP::clean_text($u->alert_message) || "";
914 $note = "<sip> CARD BLOCKED BY SELF-CHECK MACHINE. $blocked_card_msg</sip>\n$note"; # XXX Config option
915 $note =~ s/\s*$//; # kill trailng whitespace
916 $u->alert_message($note);
918 if( ! $e->update_actor_user($u) ) {
919 syslog('LOG_ERR', "OILS: Block: patron alert update failed: %s", $e->event->{textcode});
920 $e->rollback; # rollback + disconnect
925 $self->{user}->alert_message( $note );
927 $e->commit; # commits and disconnects
931 # Testing purposes only
933 my ($self, $card_retained) = @_;
934 $self->{screen_msg} = "All privileges restored.";
936 # Un-mark card as inactive, grep out the patron alert
937 my $e = $self->{editor};
938 my $u = $self->{user};
940 syslog('LOG_INFO', "OILS: Unblocking user %s", $u->card->barcode );
942 return $self if $u->card->active eq 't';
944 $e->xact_begin; # connect and start a new transaction
946 $u->card->active('t');
947 if( ! $e->update_actor_card($u->card) ) {
948 syslog('LOG_ERR', "OILS: Unblock card update failed: %s", $e->event->{textcode});
949 $e->rollback; # rollback + disconnect
953 # retrieve the un-fleshed user object for update
954 $u = $e->retrieve_actor_user($u->id);
955 my $note = OpenILS::SIP::clean_text($u->alert_message) || "";
956 $note =~ s#<sip>.*</sip>##;
957 $note =~ s/^\s*//; # kill leading whitespace
958 $note =~ s/\s*$//; # kill trailng whitespace
959 $u->alert_message($note);
961 if( ! $e->update_actor_user($u) ) {
962 syslog('LOG_ERR', "OILS: Unblock: patron alert update failed: %s", $e->event->{textcode});
963 $e->rollback; # rollback + disconnect
968 $self->{user}->alert_message( $note );
970 $e->commit; # commits and disconnects
979 return "Please contact library staff";
983 return "Please contact library staff";
986 sub inet_privileges {
988 my $e = OpenILS::SIP->editor();
989 $INET_PRIVS = $e->retrieve_all_config_net_access_level() unless $INET_PRIVS;
990 my ($level) = grep { $_->id eq $self->{user}->net_access_level } @$INET_PRIVS;
991 my $name = OpenILS::SIP::clean_text($level->name);
992 syslog('LOG_DEBUG', "OILS: Patron inet_privs = $name");
998 my $extra_fields = {};
999 my $u = $self->{user};
1000 foreach my $stat_cat_entry (@{$u->stat_cat_entries}) {
1001 my $stat_cat = $stat_cat_entry->stat_cat;
1002 next unless ($stat_cat->sip_field);
1003 my $value = $stat_cat_entry->stat_cat_entry;
1004 if(defined $stat_cat->sip_format && length($stat_cat->sip_format) > 0) { # Has a format string?
1005 if($stat_cat->sip_format =~ /^\|(.*)\|$/) { # Regex match?
1006 if($value =~ /($1)/) { # If we have a match
1007 if(defined $2) { # Check to see if they embedded a capture group
1008 $value = $2; # If so, use it
1010 else { # No embedded capture group?
1011 $value = $1; # Use our outer one
1015 $value = ''; # Empty string. Will be checked for below.
1018 else { # Not a regex match - Try sprintf match (looking for a %s, if any)
1019 $value = sprintf($stat_cat->sip_format, $value);
1022 next unless length($value) > 0; # No value = no export
1023 $value =~ s/\|//g; # Remove all lingering pipe chars for sane output purposes
1024 $extra_fields->{ $stat_cat->sip_field } = [] unless (defined $extra_fields->{$stat_cat->sip_field});
1025 push(@{$extra_fields->{ $stat_cat->sip_field}}, $value);
1027 return $extra_fields;