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 0;
 329 }
 330
 331 sub hold_ok {
 332     my $self = shift;
 333     return $self->charge_ok;
 334 }
 335
 336 # return true if the card provided is marked as lost
 337 sub card_lost {
 338     my $self = shift;
 339     return $self->{user}->card->active eq 'f';
 340 }
 341
 342 sub recall_overdue {        # not implemented
 343     my $self = shift;
 344     return 0;
 345 }
 346
 347 sub check_password {
 348         my ($self, $pwd) = @_;
 349         syslog('LOG_DEBUG', 'OILS: Patron->check_password()');
 350     return 0 unless (defined $pwd and $self->{user});
 351         return md5_hex($pwd) eq $self->{user}->passwd;
 352 }
 353
 354 sub currency {              # not really implemented
 355         my $self = shift;
 356         syslog('LOG_DEBUG', 'OILS: Patron->currency()');
 357         return 'USD';
 358 }
 359
 360 sub fee_amount {
 361         my $self = shift;
 362         syslog('LOG_DEBUG', 'OILS: Patron->fee_amount()');
 363     my $user_id = $self->{user}->id;
 364
 365     my $e = $self->{editor};
 366     $e->xact_begin;
 367     my $summary = $e->retrieve_money_open_user_summary($user_id);
 368     $e->rollback; # xact_rollback + disconnect
 369
 370     my $total = ($summary) ? $summary->balance_owed : 0;
 371         syslog('LOG_INFO', "User ".$self->{id} .":$user_id has a fee amount of \$$total");
 372         return $total;
 373 }
 374
 375 sub screen_msg {
 376         my $self = shift;
 377         my $u = $self->{user};
 378
 379         return 'barred' if $u->barred eq 't';
 380
 381         my $b = 'blocked';
 382
 383         return $b if $u->active eq 'f';
 384         return $b if $u->card->active eq 'f';
 385
 386     # if we have any penalties at this point, they are blocking penalties
 387     return $b if $u->standing_penalties and @{$u->standing_penalties};
 388
 389     # has the patron account expired?
 390         my $expire = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($u->expire_date));
 391         return $b if CORE::time > $expire->epoch;
 392
 393         return 'OK';
 394 }
 395
 396 sub print_line {            # not implemented
 397     my $self = shift;
 398         return '';
 399 }
 400
 401 sub too_many_charged {      # not implemented
 402     my $self = shift;
 403         return 0;
 404 }
 405
 406 sub too_many_overdue {
 407         my $self = shift;
 408     return scalar( # PATRON_EXCEEDS_OVERDUE_COUNT
 409         grep { $_->standing_penalty == 2 } @{$self->{user}->standing_penalties}
 410     );
 411 }
 412
 413 # not completely sure what this means
 414 sub too_many_renewal {
 415     my $self = shift;
 416     return 0;
 417 }
 418
 419 # not relevant, handled by fines/fees
 420 sub too_many_claim_return {
 421     my $self = shift;
 422     return 0;
 423 }
 424
 425 # not relevant, handled by fines/fees
 426 sub too_many_lost {
 427     my $self = shift;
 428     return 0;
 429 }
 430
 431 sub excessive_fines {
 432     my $self = shift;
 433     return scalar( # PATRON_EXCEEDS_FINES
 434         grep { $_->standing_penalty == 1 } @{$self->{user}->standing_penalties}
 435     );
 436 }
 437
 438 # Until someone suggests otherwise, fees and fines are the same
 439
 440 sub excessive_fees {
 441         my $self = shift;
 442     return $self->excessive_fines;
 443 }
 444
 445 # not relevant, handled by fines/fees
 446 sub too_many_billed {
 447     my $self = shift;
 448         return 0;
 449 }
 450
 451
 452
 453 #
 454 # List of outstanding holds placed
 455 #
 456 sub hold_items {
 457     my ($self, $start, $end) = @_;
 458         syslog('LOG_DEBUG', 'OILS: Patron->hold_items()');
 459
 460          my $holds = $self->{editor}->search_action_hold_request(
 461                 { usr => $self->{user}->id, fulfillment_time => undef, cancel_time => undef }
 462          );
 463
 464         my @holds;
 465         push( @holds, OpenILS::SIP::clean_text($self->__hold_to_title($_)) ) for @$holds;
 466
 467         return (defined $start and defined $end) ?
 468                 [ $holds[($start-1)..($end-1)] ] :
 469                 \@holds;
 470 }
 471
 472 sub __hold_to_title {
 473         my $self = shift;
 474         my $hold = shift;
 475         my $e = $self->{editor};
 476
 477         my( $id, $mods, $title, $volume, $copy );
 478
 479         return __copy_to_title($e,
 480                 $e->retrieve_asset_copy($hold->target))
 481                 if $hold->hold_type eq 'C' or $hold->hold_type eq 'F' or $hold->hold_type eq 'R';
 482
 483         return __volume_to_title($e,
 484                 $e->retrieve_asset_call_number($hold->target))
 485                 if $hold->hold_type eq 'V';
 486
 487         return __record_to_title(
 488                 $e, $hold->target) if $hold->hold_type eq 'T';
 489
 490         return __metarecord_to_title(
 491                 $e, $hold->target) if $hold->hold_type eq 'M';
 492 }
 493
 494 sub __copy_to_title {
 495         my( $e, $copy ) = @_;
 496         #syslog('LOG_DEBUG', "OILS: copy_to_title(%s)", $copy->id);
 497         return $copy->dummy_title if $copy->call_number == -1;
 498
 499         my $vol = (ref $copy->call_number) ?
 500                 $copy->call_number :
 501                 $e->retrieve_asset_call_number($copy->call_number);
 502
 503         return __volume_to_title($e, $vol);
 504 }
 505
 506
 507 sub __volume_to_title {
 508         my( $e, $volume ) = @_;
 509         #syslog('LOG_DEBUG', "OILS: volume_to_title(%s)", $volume->id);
 510         return __record_to_title($e, $volume->record);
 511 }
 512
 513
 514 sub __record_to_title {
 515         my( $e, $title_id ) = @_;
 516         #syslog('LOG_DEBUG', "OILS: record_to_title($title_id)");
 517         my $mods = $U->simplereq(
 518                 'open-ils.search',
 519                 'open-ils.search.biblio.record.mods_slim.retrieve', $title_id );
 520         return ($mods) ? $mods->title : "";
 521 }
 522
 523 sub __metarecord_to_title {
 524         my( $e, $m_id ) = @_;
 525         #syslog('LOG_DEBUG', "OILS: metarecord_to_title($m_id)");
 526         my $mods = $U->simplereq(
 527                 'open-ils.search',
 528                 'open-ils.search.biblio.metarecord.mods_slim.retrieve', $m_id);
 529         return ($U->event_code($mods)) ? "<unknown>" : $mods->title;
 530 }
 531
 532
 533 #
 534 # remove the hold on item item_id from my hold queue.
 535 # return true if I was holding the item, false otherwise.
 536 #
 537 sub drop_hold {
 538     my ($self, $item_id) = @_;
 539     return 0;
 540 }
 541
 542 sub __patron_items_info {
 543         my $self = shift;
 544         return if $self->{item_info};
 545         $self->{item_info} =
 546                 OpenILS::Application::Actor::_checked_out(
 547                         0, $self->{editor}, $self->{user}->id);;
 548 }
 549
 550
 551
 552 sub overdue_items {
 553         my ($self, $start, $end) = @_;
 554
 555         $self->__patron_items_info();
 556         my @overdues = @{$self->{item_info}->{overdue}};
 557         #$overdues[$_] = __circ_to_title($self->{editor}, $overdues[$_]) for @overdues;
 558
 559         my @o;
 560         syslog('LOG_DEBUG', "OILS: overdue_items() fleshing circs @overdues");
 561
 562         my $return_datatype = OpenILS::SIP->get_option_value('msg64_summary_datatype') || '';
 563
 564         for my $circid (@overdues) {
 565                 next unless $circid;
 566                 if($return_datatype eq 'barcode') {
 567                         push( @o, __circ_to_barcode($self->{editor}, $circid));
 568                 } else {
 569                         push( @o, OpenILS::SIP::clean_text(__circ_to_title($self->{editor}, $circid)));
 570                 }
 571         }
 572         @overdues = @o;
 573
 574         return (defined $start and defined $end) ?
 575                 [ $overdues[($start-1)..($end-1)] ] : \@overdues;
 576 }
 577
 578 sub __circ_to_barcode {
 579         my ($e, $circ) = @_;
 580         return unless $circ;
 581         $circ = $e->retrieve_action_circulation($circ);
 582         my $copy = $e->retrieve_asset_copy($circ->target_copy);
 583         return $copy->barcode;
 584 }
 585
 586 sub __circ_to_title {
 587         my( $e, $circ ) = @_;
 588         return unless $circ;
 589         $circ = $e->retrieve_action_circulation($circ);
 590         return __copy_to_title( $e,
 591                 $e->retrieve_asset_copy($circ->target_copy) );
 592 }
 593
 594 sub charged_items {
 595         my ($self, $start, $end) = shift;
 596
 597         $self->__patron_items_info();
 598
 599         my @charges = (
 600                 @{$self->{item_info}->{out}},
 601                 @{$self->{item_info}->{overdue}}
 602                 );
 603
 604         #$charges[$_] = __circ_to_title($self->{editor}, $charges[$_]) for @charges;
 605
 606         my @c;
 607         syslog('LOG_DEBUG', "OILS: charged_items() fleshing circs @charges");
 608
 609         my $return_datatype = OpenILS::SIP->get_option_value('msg64_summary_datatype') || '';
 610
 611         for my $circid (@charges) {
 612                 next unless $circid;
 613                 if($return_datatype eq 'barcode') {
 614                         push( @c, __circ_to_barcode($self->{editor}, $circid));
 615                 } else {
 616                         push( @c, OpenILS::SIP::clean_text(__circ_to_title($self->{editor}, $circid)));
 617                 }
 618         }
 619
 620         @charges = @c;
 621
 622         return (defined $start and defined $end) ?
 623                 [ $charges[($start-1)..($end-1)] ] :
 624                 \@charges;
 625 }
 626
 627 sub fine_items {
 628         my ($self, $start, $end) = @_;
 629         my @fines;
 630     eval {
 631            my $xacts = $U->simplereq('open-ils.actor', 'open-ils.actor.user.transactions.history.have_balance', $self->{authtoken}, $self->{user}->id);
 632            foreach my $xact (@{$xacts}) {
 633                 my $line = $xact->balance_owed . " " . $xact->last_billing_type . " ";
 634                 if ($xact->xact_type eq 'circulation') {
 635                     my $mods = $U->simplereq('open-ils.circ', 'open-ils.circ.circ_transaction.find_title', $self->{authtoken}, $xact->id);
 636                     $line .= $mods->title . ' / ' . $mods->author;
 637                 } else {
 638                     $line .= $xact->last_billing_note;
 639                 }
 640                 push @fines, OpenILS::SIP::clean_text($line);
 641            }
 642     };
 643     my $log_status = $@ ? 'ERROR: ' . $@ : 'OK';
 644         syslog('LOG_DEBUG', 'OILS: Patron->fine_items() ' . $log_status);
 645         return (defined $start and defined $end) ?
 646                 [ $fines[($start-1)..($end-1)] ] : \@fines;
 647 }
 648
 649 # not currently supported
 650 sub recall_items {
 651     my ($self, $start, $end) = @_;
 652     return [];
 653 }
 654
 655 sub unavail_holds {
 656      my ($self, $start, $end) = @_;
 657      syslog('LOG_DEBUG', 'OILS: Patron->unavail_holds()');
 658
 659      my $ids = $self->{editor}->json_query({
 660         select => {ahr => ['id']},
 661         from => 'ahr',
 662         where => {
 663             usr => $self->{user}->id,
 664             fulfillment_time => undef,
 665             cancel_time => undef,
 666             '-or' => [
 667                 {current_shelf_lib => undef},
 668                 {current_shelf_lib => {'!=' => {'+ahr' => 'pickup_lib'}}}
 669             ]
 670         }
 671     });
 672
 673      my @holds_sip_output;
 674      @holds_sip_output = map {
 675         OpenILS::SIP::clean_text($self->__hold_to_title($_))
 676      } @{
 677         $self->{editor}->search_action_hold_request(
 678             {id => [map {$_->{id}} @$ids]}
 679         )
 680      } if (@$ids > 0);
 681
 682      return (defined $start and defined $end) ?
 683          [ @holds_sip_output[($start-1)..($end-1)] ] :
 684          \@holds_sip_output;
 685 }
 686
 687 sub block {
 688         my ($self, $card_retained, $blocked_card_msg) = @_;
 689     $blocked_card_msg ||= '';
 690
 691     my $e = $self->{editor};
 692         my $u = $self->{user};
 693
 694         syslog('LOG_INFO', "OILS: Blocking user %s", $u->card->barcode );
 695
 696         return $self if $u->card->active eq 'f';
 697
 698     $e->xact_begin;    # connect and start a new transaction
 699
 700         $u->card->active('f');
 701         if( ! $e->update_actor_card($u->card) ) {
 702                 syslog('LOG_ERR', "OILS: Block card update failed: %s", $e->event->{textcode});
 703                 $e->rollback; # rollback + disconnect
 704                 return $self;
 705         }
 706
 707         # retrieve the un-fleshed user object for update
 708         $u = $e->retrieve_actor_user($u->id);
 709         my $note = OpenILS::SIP::clean_text($u->alert_message) || "";
 710         $note = "<sip> CARD BLOCKED BY SELF-CHECK MACHINE. $blocked_card_msg</sip>\n$note"; # XXX Config option
 711     $note =~ s/\s*$//;  # kill trailng whitespace
 712         $u->alert_message($note);
 713
 714         if( ! $e->update_actor_user($u) ) {
 715                 syslog('LOG_ERR', "OILS: Block: patron alert update failed: %s", $e->event->{textcode});
 716                 $e->rollback; # rollback + disconnect
 717                 return $self;
 718         }
 719
 720         # stay in synch
 721         $self->{user}->alert_message( $note );
 722
 723         $e->commit; # commits and disconnects
 724         return $self;
 725 }
 726
 727 # Testing purposes only
 728 sub enable {
 729     my ($self, $card_retained) = @_;
 730     $self->{screen_msg} = "All privileges restored.";
 731
 732     # Un-mark card as inactive, grep out the patron alert
 733     my $e = $self->{editor};
 734     my $u = $self->{user};
 735
 736     syslog('LOG_INFO', "OILS: Unblocking user %s", $u->card->barcode );
 737
 738     return $self if $u->card->active eq 't';
 739
 740     $e->xact_begin;    # connect and start a new transaction
 741
 742     $u->card->active('t');
 743     if( ! $e->update_actor_card($u->card) ) {
 744         syslog('LOG_ERR', "OILS: Unblock card update failed: %s", $e->event->{textcode});
 745         $e->rollback; # rollback + disconnect
 746         return $self;
 747     }
 748
 749     # retrieve the un-fleshed user object for update
 750     $u = $e->retrieve_actor_user($u->id);
 751     my $note = OpenILS::SIP::clean_text($u->alert_message) || "";
 752     $note =~ s#<sip>.*</sip>##;
 753     $note =~ s/^\s*//;  # kill leading whitespace
 754     $note =~ s/\s*$//;  # kill trailng whitespace
 755     $u->alert_message($note);
 756
 757     if( ! $e->update_actor_user($u) ) {
 758         syslog('LOG_ERR', "OILS: Unblock: patron alert update failed: %s", $e->event->{textcode});
 759         $e->rollback; # rollback + disconnect
 760         return $self;
 761     }
 762
 763     # stay in synch
 764     $self->{user}->alert_message( $note );
 765
 766     $e->commit; # commits and disconnects
 767     return $self;
 768 }
 769
 770 #
 771 # Messages
 772 #
 773
 774 sub invalid_patron {
 775     return "Please contact library staff";
 776 }
 777
 778 sub charge_denied {
 779     return "Please contact library staff";
 780 }
 781
 782 sub inet_privileges {
 783     my( $self ) = @_;
 784     my $e = OpenILS::SIP->editor();
 785     $INET_PRIVS = $e->retrieve_all_config_net_access_level() unless $INET_PRIVS;
 786     my ($level) = grep { $_->id eq $self->{user}->net_access_level } @$INET_PRIVS;
 787     my $name = OpenILS::SIP::clean_text($level->name);
 788     syslog('LOG_DEBUG', "OILS: Patron inet_privs = $name");
 789     return $name;
 790 }
 791
 792 sub extra_fields {
 793     my( $self ) = @_;
 794     my $extra_fields = {};
 795         my $u = $self->{user};
 796     foreach my $stat_cat_entry (@{$u->stat_cat_entries}) {
 797         my $stat_cat = $stat_cat_entry->stat_cat;
 798         next unless ($stat_cat->sip_field);
 799         my $value = $stat_cat_entry->stat_cat_entry;
 800         if(defined $stat_cat->sip_format && length($stat_cat->sip_format) > 0) { # Has a format string?
 801             if($stat_cat->sip_format =~ /^\|(.*)\|$/) { # Regex match?
 802                 if($value =~ /($1)/) { # If we have a match
 803                     if(defined $2) { # Check to see if they embedded a capture group
 804                         $value = $2; # If so, use it
 805                     }
 806                     else { # No embedded capture group?
 807                         $value = $1; # Use our outer one
 808                     }
 809                 }
 810                 else { # No match?
 811                     $value = ''; # Empty string. Will be checked for below.
 812                 }
 813             }
 814             else { # Not a regex match - Try sprintf match (looking for a %s, if any)
 815                 $value = sprintf($stat_cat->sip_format, $value);
 816             }
 817         }
 818         next unless length($value) > 0; # No value = no export
 819         $value =~ s/\|//g; # Remove all lingering pipe chars for sane output purposes
 820         $extra_fields->{ $stat_cat->sip_field } = [] unless (defined $extra_fields->{$stat_cat->sip_field});
 821         push(@{$extra_fields->{ $stat_cat->sip_field}}, $value);
 822     }
 823     return $extra_fields;
 824 }
 825
 826 1;