Open-ILS/src/perlmods/lib/OpenILS/SIP/Patron.pm

   1 #
   2 #
   3 # A Class for hiding the ILS's concept of the patron from the OpenSIP
   4 # system
   5 #
   6
   7 package OpenILS::SIP::Patron;
   8
   9 use strict;
  10 use warnings;
  11 use Exporter;
  12
  13 use Sys::Syslog qw(syslog);
  14 use Data::Dumper;
  15 use Digest::MD5 qw(md5_hex);
  16
  17 use OpenILS::SIP;
  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';
  23
  24 our (@ISA, @EXPORT_OK);
  25
  26 @ISA = qw(Exporter);
  27
  28 @EXPORT_OK = qw(invalid_patron);
  29
  30 my $INET_PRIVS;
  31
  32 sub new {
  33     my $class = shift;
  34     my $key   = shift;
  35     my $patron_id = shift;
  36     my %args = @_;
  37
  38     if ($key ne 'usr' and $key ne 'barcode') {
  39         syslog("LOG_ERROR", "Patron (card) lookup requested by illegeal key '$key'");
  40         return undef;
  41     }
  42
  43     unless(defined $patron_id) {
  44         syslog("LOG_WARNING", "No patron ID provided to ILS::Patron->new");
  45         return undef;
  46     }
  47
  48     my $type = ref($class) || $class;
  49     my $self = bless({}, $type);
  50
  51     syslog("LOG_DEBUG", "OILS: new OpenILS Patron(%s => %s): searching...", $key, $patron_id);
  52
  53     my $e = OpenILS::SIP->editor();
  54
  55     my $usr_flesh = {
  56         flesh => 2,
  57         flesh_fields => {
  58             au => [
  59                 "card",
  60                 "addresses",
  61                 "billing_address",
  62                 "mailing_address",
  63                 'profile',
  64                 "stat_cat_entries",
  65             ],
  66             actscecm => [
  67                 "stat_cat",
  68             ],
  69         }
  70     };
  71
  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};
  74
  75     my $user;
  76     if($key eq 'barcode') { # retrieve user by barcode
  77
  78         $$usr_flesh{flesh} += 1;
  79         $$usr_flesh{flesh_fields}{ac} = ['usr'];
  80
  81         my $card = $e->search_actor_card([{barcode => $patron_id}, $usr_flesh])->[0];
  82
  83         if(!$card or !$U->is_true($card->active)) {
  84             syslog("LOG_WARNING", "No such patron barcode: $patron_id");
  85             return undef;
  86         }
  87
  88         $user = $card->usr;
  89
  90     } else {
  91         $user = $e->retrieve_actor_user([$patron_id, $usr_flesh]);
  92     }
  93
  94     if(!$user or $U->is_true($user->deleted)) {
  95         syslog("LOG_WARNING", "OILS: Unable to find patron %s => %s", $key, $patron_id);
  96         return undef;
  97     }
  98
  99     if(!$U->is_true($user->active)) {
 100         syslog("LOG_WARNING", "OILS: Patron is inactive %s => %s", $key, $patron_id);
 101         return undef;
 102     }
 103
 104     # now grab the user's penalties
 105
 106     $self->flesh_user_penalties($user, $e) unless $args{slim_user};
 107
 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.
 113
 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 );
 116
 117     $U->log_user_activity($user->id, $self->get_act_who, 'verify');
 118
 119     return $self;
 120 }
 121
 122 sub get_act_who {
 123     my $self = shift;
 124     my $config = OpenILS::SIP->config();
 125     my $login = OpenILS::SIP->login_account();
 126
 127     my $act_who = $config->{implementation_config}->{default_activity_who};
 128     my $force_who = $config->{implementation_config}->{force_activity_who};
 129
 130     # 1. future: test sip extension for caller-provided ewho and !$force_who
 131
 132     # 2. See if the login is tagged with an ewho
 133     return $login->{activity_who} if $login->{activity_who};
 134
 135     # 3. if all else fails, see if there is an institution-wide ewho
 136     return $config->{activity_who} if $config->{activity_who};
 137
 138     return undef;
 139 }
 140
 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) = @_;
 145
 146     $user->standing_penalties(
 147         $e->search_actor_user_standing_penalty([
 148             {
 149                 usr => $user->id,
 150                 '-or' => [
 151
 152                     # ignore "archived" penalties
 153                     {stop_date => undef},
 154                     {stop_date => {'>' => 'now'}}
 155                 ],
 156
 157                 org_unit => {
 158                     in  => {
 159                         select => {
 160                             aou => [{
 161                                 column => 'id',
 162                                 transform => 'actor.org_unit_ancestors',
 163                                 result_field => 'id'
 164                             }]
 165                         },
 166                         from => 'aou',
 167
 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},
 171                         distinct => 1
 172                     }
 173                 },
 174
 175                 # in addition to fines and excessive overdue penalties,
 176                 # we only care about penalties that result in blocks
 177                 standing_penalty => {
 178                     in => {
 179                         select => {csp => ['id']},
 180                         from => 'csp',
 181                         where => {
 182                             '-or' => [
 183                                 {id => [1,2]}, # fines / overdues
 184                                 {block_list => {'!=' => undef}}
 185                             ]
 186                         },
 187                     }
 188                 }
 189             },
 190         ])
 191     );
 192 }
 193
 194 sub id {
 195     my $self = shift;
 196     return $self->{id};
 197 }
 198
 199 sub name {
 200     my $self = shift;
 201     return format_name($self->{user});
 202 }
 203
 204 sub format_name {
 205     my $u = shift;
 206     return OpenILS::SIP::clean_text(
 207         sprintf('%s %s %s',
 208             ($u->first_given_name || ''),
 209             ($u->second_given_name || ''),
 210             ($u->family_name || '')));
 211 }
 212
 213 sub home_library {
 214     my $self = shift;
 215     my $lib = OpenILS::SIP::shortname_from_id($self->{user}->home_ou);
 216     syslog('LOG_DEBUG', "OILS: Patron->home_library() = $lib");
 217     return $lib;
 218 }
 219
 220 sub __addr_string {
 221     my $addr = shift;
 222     return "" unless $addr;
 223     my $return = OpenILS::SIP::clean_text(
 224         join( ' ', map {$_ || ''} (
 225             $addr->street1,
 226             $addr->street2,
 227             $addr->city . ',',
 228             $addr->county,
 229             $addr->state,
 230             $addr->country,
 231             $addr->post_code
 232             )
 233         )
 234     );
 235     $return =~ s/\s+/ /sg;     # Compress any run of of whitespace to one space
 236     return $return;
 237 }
 238
 239 sub internal_id {
 240     my $self = shift;
 241     return $self->{user}->id;
 242 }
 243
 244 sub address {
 245     my $self = shift;
 246     my $u    = $self->{user};
 247     my $str  = __addr_string($u->billing_address || $u->mailing_address);
 248     syslog('LOG_DEBUG', "OILS: Patron address: $str");
 249     return $str;
 250 }
 251
 252 sub email_addr {
 253     my $self = shift;
 254     return OpenILS::SIP::clean_text($self->{user}->email);
 255 }
 256
 257 sub home_phone {
 258     my $self = shift;
 259     return $self->{user}->day_phone;
 260 }
 261
 262 sub sip_birthdate {
 263     my $self = shift;
 264     my $dob = OpenILS::SIP->format_date($self->{user}->dob);
 265     syslog('LOG_DEBUG', "OILS: Patron DOB = $dob");
 266     return $dob;
 267 }
 268
 269 sub sip_expire {
 270     my $self = shift;
 271     my $expire = OpenILS::SIP->format_date($self->{user}->expire_date);
 272     syslog('LOG_DEBUG', "OILS: Patron Expire = $expire");
 273     return $expire;
 274 }
 275
 276 sub ptype {
 277     my $self = shift;
 278
 279     my $use_code = OpenILS::SIP->get_option_value('patron_type_uses_code') || '';
 280
 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;
 285
 286     return OpenILS::SIP::clean_text($self->{user}->profile->name);
 287 }
 288
 289 sub language {
 290     my $self = shift;
 291     return '000'; # Unspecified
 292 }
 293
 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
 296 # or an expired card
 297 sub charge_ok {
 298     my $self = shift;
 299     my $u = $self->{user};
 300
 301     # compute expiration date for borrowing privileges
 302     my $expire = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($u->expire_date));
 303
 304     # determine whether patron should be allowed to circulate materials:
 305     # not barred, doesn't owe too much wrt fines/fees, privileges haven't
 306     # expired
 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));
 311
 312     return
 313         !$circ_is_blocked and
 314         $u->active eq 't' and
 315         $u->card->active eq 't';
 316 }
 317
 318
 319
 320 # How much more detail do we need to check here?
 321 sub renew_ok {
 322     my $self = shift;
 323     return $self->charge_ok;
 324 }
 325
 326 sub recall_ok {
 327     my $self = shift;
 328     return $self->charge_ok if
 329         OpenILS::SIP->get_option_value('patron_calculate_recal_ok');
 330     return 0;
 331 }
 332
 333 sub hold_ok {
 334     my $self = shift;
 335     return $self->charge_ok;
 336 }
 337
 338 # return true if the card provided is marked as lost
 339 sub card_lost {
 340     my $self = shift;
 341     return $self->{user}->card->active eq 'f';
 342 }
 343
 344 sub recall_overdue {        # not implemented
 345     my $self = shift;
 346     return 0;
 347 }
 348
 349 sub check_password {
 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;
 354 }
 355
 356 sub currency {              # not really implemented
 357     my $self = shift;
 358     syslog('LOG_DEBUG', 'OILS: Patron->currency()');
 359     return 'USD';
 360 }
 361
 362 sub fee_amount {
 363     my $self = shift;
 364     syslog('LOG_DEBUG', 'OILS: Patron->fee_amount()');
 365     my $user_id = $self->{user}->id;
 366
 367     my $e = $self->{editor};
 368     $e->xact_begin;
 369     my $summary = $e->retrieve_money_open_user_summary($user_id);
 370     $e->rollback; # xact_rollback + disconnect
 371
 372     my $total = ($summary) ? $summary->balance_owed : 0;
 373     syslog('LOG_INFO', "User ".$self->{id} .":$user_id has a fee amount of \$$total");
 374     return $total;
 375 }
 376
 377 sub screen_msg {
 378     my $self = shift;
 379     my $u = $self->{user};
 380
 381     return 'barred' if $u->barred eq 't';
 382
 383     my $b = 'blocked';
 384
 385     return $b if $u->active eq 'f';
 386     return $b if $u->card->active eq 'f';
 387
 388     # if we have any penalties at this point, they are blocking penalties
 389     return $b if $u->standing_penalties and @{$u->standing_penalties};
 390
 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;
 394
 395     return 'OK';
 396 }
 397
 398 sub print_line {            # not implemented
 399     my $self = shift;
 400     return '';
 401 }
 402
 403 sub too_many_charged {      # not implemented
 404     my $self = shift;
 405     return 0;
 406 }
 407
 408 sub too_many_overdue {
 409     my $self = shift;
 410     return scalar( # PATRON_EXCEEDS_OVERDUE_COUNT
 411         grep { $_->standing_penalty == 2 } @{$self->{user}->standing_penalties}
 412     );
 413 }
 414
 415 # not completely sure what this means
 416 sub too_many_renewal {
 417     my $self = shift;
 418     return 0;
 419 }
 420
 421 # not relevant, handled by fines/fees
 422 sub too_many_claim_return {
 423     my $self = shift;
 424     return 0;
 425 }
 426
 427 # not relevant, handled by fines/fees
 428 sub too_many_lost {
 429     my $self = shift;
 430     return 0;
 431 }
 432
 433 sub excessive_fines {
 434     my $self = shift;
 435     return scalar( # PATRON_EXCEEDS_FINES
 436         grep { $_->standing_penalty == 1 } @{$self->{user}->standing_penalties}
 437     );
 438 }
 439
 440 # Until someone suggests otherwise, fees and fines are the same
 441
 442 sub excessive_fees {
 443     my $self = shift;
 444     return $self->excessive_fines;
 445 }
 446
 447 # not relevant, handled by fines/fees
 448 sub too_many_billed {
 449     my $self = shift;
 450     return 0;
 451 }
 452
 453
 454
 455 #
 456 # List of outstanding holds placed
 457 #
 458 sub hold_items {
 459     my ($self, $start, $end) = @_;
 460     syslog('LOG_DEBUG', 'OILS: Patron->hold_items()');
 461
 462      my $holds = $self->{editor}->search_action_hold_request(
 463         { usr => $self->{user}->id, fulfillment_time => undef, cancel_time => undef }
 464      );
 465
 466     my @holds;
 467     push( @holds, OpenILS::SIP::clean_text($self->__hold_to_title($_)) ) for @$holds;
 468
 469     return (defined $start and defined $end) ?
 470         [ $holds[($start-1)..($end-1)] ] :
 471         \@holds;
 472 }
 473
 474 sub __hold_to_title {
 475     my $self = shift;
 476     my $hold = shift;
 477     my $e = $self->{editor};
 478
 479     my( $id, $mods, $title, $volume, $copy );
 480
 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';
 484
 485     return __volume_to_title($e,
 486         $e->retrieve_asset_call_number($hold->target))
 487         if $hold->hold_type eq 'V';
 488
 489     return __record_to_title(
 490         $e, $hold->target) if $hold->hold_type eq 'T';
 491
 492     return __metarecord_to_title(
 493         $e, $hold->target) if $hold->hold_type eq 'M';
 494 }
 495
 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;
 500
 501     my $vol = (ref $copy->call_number) ?
 502         $copy->call_number :
 503         $e->retrieve_asset_call_number($copy->call_number);
 504
 505     return __volume_to_title($e, $vol);
 506 }
 507
 508
 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);
 513 }
 514
 515
 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(
 520         'open-ils.search',
 521         'open-ils.search.biblio.record.mods_slim.retrieve', $title_id );
 522     return ($mods) ? $mods->title : "";
 523 }
 524
 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(
 529         'open-ils.search',
 530         'open-ils.search.biblio.metarecord.mods_slim.retrieve', $m_id);
 531     return ($U->event_code($mods)) ? "<unknown>" : $mods->title;
 532 }
 533
 534
 535 #
 536 # remove the hold on item item_id from my hold queue.
 537 # return true if I was holding the item, false otherwise.
 538 #
 539 sub drop_hold {
 540     my ($self, $item_id) = @_;
 541     return 0;
 542 }
 543
 544 sub __patron_items_info {
 545     my $self = shift;
 546     return if $self->{item_info};
 547     $self->{item_info} =
 548         OpenILS::Application::Actor::_checked_out(
 549             0, $self->{editor}, $self->{user}->id);;
 550 }
 551
 552
 553
 554 sub overdue_items {
 555     my ($self, $start, $end) = @_;
 556
 557     $self->__patron_items_info();
 558     my @overdues = @{$self->{item_info}->{overdue}};
 559     #$overdues[$_] = __circ_to_title($self->{editor}, $overdues[$_]) for @overdues;
 560
 561     my @o;
 562     syslog('LOG_DEBUG', "OILS: overdue_items() fleshing circs @overdues");
 563
 564     my $return_datatype = OpenILS::SIP->get_option_value('msg64_summary_datatype') || '';
 565
 566     for my $circid (@overdues) {
 567         next unless $circid;
 568         if($return_datatype eq 'barcode') {
 569             push( @o, __circ_to_barcode($self->{editor}, $circid));
 570         } else {
 571             push( @o, OpenILS::SIP::clean_text(__circ_to_title($self->{editor}, $circid)));
 572         }
 573     }
 574     @overdues = @o;
 575
 576     return (defined $start and defined $end) ?
 577         [ $overdues[($start-1)..($end-1)] ] : \@overdues;
 578 }
 579
 580 sub __circ_to_barcode {
 581     my ($e, $circ) = @_;
 582     return unless $circ;
 583     $circ = $e->retrieve_action_circulation($circ);
 584     my $copy = $e->retrieve_asset_copy($circ->target_copy);
 585     return $copy->barcode;
 586 }
 587
 588 sub __circ_to_title {
 589     my( $e, $circ ) = @_;
 590     return unless $circ;
 591     $circ = $e->retrieve_action_circulation($circ);
 592     return __copy_to_title( $e,
 593         $e->retrieve_asset_copy($circ->target_copy) );
 594 }
 595
 596 sub charged_items {
 597     my ($self, $start, $end) = shift;
 598
 599     $self->__patron_items_info();
 600
 601     my @charges = (
 602         @{$self->{item_info}->{out}},
 603         @{$self->{item_info}->{overdue}}
 604         );
 605
 606     #$charges[$_] = __circ_to_title($self->{editor}, $charges[$_]) for @charges;
 607
 608     my @c;
 609     syslog('LOG_DEBUG', "OILS: charged_items() fleshing circs @charges");
 610
 611     my $return_datatype = OpenILS::SIP->get_option_value('msg64_summary_datatype') || '';
 612
 613     for my $circid (@charges) {
 614         next unless $circid;
 615         if($return_datatype eq 'barcode') {
 616             push( @c, __circ_to_barcode($self->{editor}, $circid));
 617         } else {
 618             push( @c, OpenILS::SIP::clean_text(__circ_to_title($self->{editor}, $circid)));
 619         }
 620     }
 621
 622     @charges = @c;
 623
 624     return (defined $start and defined $end) ?
 625         [ $charges[($start-1)..($end-1)] ] :
 626         \@charges;
 627 }
 628
 629 sub fine_items {
 630     my ($self, $start, $end) = @_;
 631     my @fines;
 632     eval {
 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;
 639            } else {
 640                $line .= $xact->last_billing_note;
 641            }
 642            push @fines, OpenILS::SIP::clean_text($line);
 643        }
 644     };
 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;
 649 }
 650
 651 # not currently supported
 652 sub recall_items {
 653     my ($self, $start, $end) = @_;
 654     return [];
 655 }
 656
 657 sub unavail_holds {
 658      my ($self, $start, $end) = @_;
 659      syslog('LOG_DEBUG', 'OILS: Patron->unavail_holds()');
 660
 661      my $ids = $self->{editor}->json_query({
 662         select => {ahr => ['id']},
 663         from => 'ahr',
 664         where => {
 665             usr => $self->{user}->id,
 666             fulfillment_time => undef,
 667             cancel_time => undef,
 668             '-or' => [
 669                 {current_shelf_lib => undef},
 670                 {current_shelf_lib => {'!=' => {'+ahr' => 'pickup_lib'}}}
 671             ]
 672         }
 673     });
 674
 675      my @holds_sip_output;
 676      @holds_sip_output = map {
 677         OpenILS::SIP::clean_text($self->__hold_to_title($_))
 678      } @{
 679         $self->{editor}->search_action_hold_request(
 680             {id => [map {$_->{id}} @$ids]}
 681         )
 682      } if (@$ids > 0);
 683
 684      return (defined $start and defined $end) ?
 685          [ @holds_sip_output[($start-1)..($end-1)] ] :
 686          \@holds_sip_output;
 687 }
 688
 689 sub block {
 690     my ($self, $card_retained, $blocked_card_msg) = @_;
 691     $blocked_card_msg ||= '';
 692
 693     my $e = $self->{editor};
 694     my $u = $self->{user};
 695
 696     syslog('LOG_INFO', "OILS: Blocking user %s", $u->card->barcode );
 697
 698     return $self if $u->card->active eq 'f';
 699
 700     $e->xact_begin;    # connect and start a new transaction
 701
 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
 706         return $self;
 707     }
 708
 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);
 715
 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
 719         return $self;
 720     }
 721
 722     # stay in synch
 723     $self->{user}->alert_message( $note );
 724
 725     $e->commit; # commits and disconnects
 726     return $self;
 727 }
 728
 729 # Testing purposes only
 730 sub enable {
 731     my ($self, $card_retained) = @_;
 732     $self->{screen_msg} = "All privileges restored.";
 733
 734     # Un-mark card as inactive, grep out the patron alert
 735     my $e = $self->{editor};
 736     my $u = $self->{user};
 737
 738     syslog('LOG_INFO', "OILS: Unblocking user %s", $u->card->barcode );
 739
 740     return $self if $u->card->active eq 't';
 741
 742     $e->xact_begin;    # connect and start a new transaction
 743
 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
 748         return $self;
 749     }
 750
 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);
 758
 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
 762         return $self;
 763     }
 764
 765     # stay in synch
 766     $self->{user}->alert_message( $note );
 767
 768     $e->commit; # commits and disconnects
 769     return $self;
 770 }
 771
 772 #
 773 # Messages
 774 #
 775
 776 sub invalid_patron {
 777     return "Please contact library staff";
 778 }
 779
 780 sub charge_denied {
 781     return "Please contact library staff";
 782 }
 783
 784 sub inet_privileges {
 785     my( $self ) = @_;
 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");
 791     return $name;
 792 }
 793
 794 sub extra_fields {
 795     my( $self ) = @_;
 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
 807                     }
 808                     else { # No embedded capture group?
 809                         $value = $1; # Use our outer one
 810                     }
 811                 }
 812                 else { # No match?
 813                     $value = ''; # Empty string. Will be checked for below.
 814                 }
 815             }
 816             else { # Not a regex match - Try sprintf match (looking for a %s, if any)
 817                 $value = sprintf($stat_cat->sip_format, $value);
 818             }
 819         }
 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);
 824     }
 825     return $extra_fields;
 826 }
 827
 828 1;