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 OpenILS::Const qw/:const/;
  21 use OpenSRF::Utils qw/:datetime/;
  22 use DateTime::Format::ISO8601;
  23 my $U = 'OpenILS::Application::AppUtils';
  24
  25 our (@ISA, @EXPORT_OK);
  26
  27 @ISA = qw(Exporter);
  28
  29 @EXPORT_OK = qw(invalid_patron);
  30
  31 my $INET_PRIVS;
  32
  33 sub new {
  34     my $class = shift;
  35     my $key   = shift;
  36     my $patron_id = shift;
  37     my %args = @_;
  38
  39     if ($key ne 'usr' and $key ne 'barcode') {
  40         syslog("LOG_ERROR", "Patron (card) lookup requested by illegeal key '$key'");
  41         return undef;
  42     }
  43
  44     unless(defined $patron_id) {
  45         syslog("LOG_WARNING", "No patron ID provided to ILS::Patron->new");
  46         return undef;
  47     }
  48
  49     my $type = ref($class) || $class;
  50     my $self = bless({}, $type);
  51
  52     syslog("LOG_DEBUG", "OILS: new OpenILS Patron(%s => %s): searching...", $key, $patron_id);
  53
  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});
  60     }
  61
  62     my $usr_flesh = {
  63         flesh => 2,
  64         flesh_fields => {
  65             au => [
  66                 "card",
  67                 "addresses",
  68                 "billing_address",
  69                 "mailing_address",
  70                 'profile',
  71                 "stat_cat_entries",
  72             ],
  73             actscecm => [
  74                 "stat_cat",
  75             ],
  76         }
  77     };
  78
  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};
  81
  82     my $user;
  83     if($key eq 'barcode') { # retrieve user by barcode
  84
  85         $$usr_flesh{flesh} += 1;
  86         $$usr_flesh{flesh_fields}{ac} = ['usr'];
  87
  88         my $card = $e->search_actor_card([{barcode => $patron_id}, $usr_flesh])->[0];
  89
  90         if(!$card or !$U->is_true($card->active)) {
  91             syslog("LOG_WARNING", "No such patron barcode: $patron_id");
  92             return undef;
  93         }
  94
  95         $user = $card->usr;
  96
  97     } else {
  98         $user = $e->retrieve_actor_user([$patron_id, $usr_flesh]);
  99     }
 100
 101     if(!$user or $U->is_true($user->deleted)) {
 102         syslog("LOG_WARNING", "OILS: Unable to find patron %s => %s", $key, $patron_id);
 103         return undef;
 104     }
 105
 106     if(!$U->is_true($user->active)) {
 107         syslog("LOG_WARNING", "OILS: Patron is inactive %s => %s", $key, $patron_id);
 108         return undef;
 109     }
 110
 111     # now grab the user's penalties
 112
 113     $self->flesh_user_penalties($user, $e) unless $args{slim_user};
 114
 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.
 120
 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 );
 123
 124     $U->log_user_activity($user->id, $self->get_act_who, 'verify');
 125
 126     return $self;
 127 }
 128
 129 sub get_act_who {
 130     my $self = shift;
 131     my $config = OpenILS::SIP->config();
 132     my $login = OpenILS::SIP->login_account();
 133
 134     my $act_who = $config->{implementation_config}->{default_activity_who};
 135     my $force_who = $config->{implementation_config}->{force_activity_who};
 136
 137     # 1. future: test sip extension for caller-provided ewho and !$force_who
 138
 139     # 2. See if the login is tagged with an ewho
 140     return $login->{activity_who} if $login->{activity_who};
 141
 142     # 3. if all else fails, see if there is an institution-wide ewho
 143     return $config->{activity_who} if $config->{activity_who};
 144
 145     return undef;
 146 }
 147
 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) = @_;
 152
 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.
 155     my $here;
 156     if ($e->authtoken()) {
 157         my $auth_usr = $e->checkauth();
 158         if ($auth_usr) {
 159             $here = $auth_usr->ws_ou() || $auth_usr->home_ou();
 160         }
 161     }
 162
 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.
 166     my $raw_penalties =
 167         $e->search_actor_user_standing_penalty([
 168             {
 169                 usr => $user->id,
 170                 '-or' => [
 171
 172                     # ignore "archived" penalties
 173                     {stop_date => undef},
 174                     {stop_date => {'>' => 'now'}}
 175                 ],
 176
 177                 org_unit => {
 178                     in  => {
 179                         select => {
 180                             aou => [{
 181                                 column => 'id',
 182                                 transform => 'actor.org_unit_ancestors',
 183                                 result_field => 'id'
 184                             }]
 185                         },
 186                         from => 'aou',
 187
 188                         # Use "here" or user's home_ou.
 189                         where => {id => ($here) ? $here : $user->home_ou},
 190                         distinct => 1
 191                     }
 192                 },
 193
 194                 # in addition to fines and excessive overdue penalties,
 195                 # we only care about penalties that result in blocks
 196                 standing_penalty => {
 197                     in => {
 198                         select => {csp => ['id']},
 199                         from => 'csp',
 200                         where => {
 201                             '-or' => [
 202                                 {id => [1,2]}, # fines / overdues
 203                                 {block_list => {'!=' => undef}}
 204                             ]
 205                         },
 206                     }
 207                 }
 208             },
 209             {
 210                 flesh => 1,
 211                 flesh_fields => {ausp => ['standing_penalty']}
 212             }
 213         ]);
 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())
 218             : undef;
 219         # Filter out those that do not apply and deflesh the standing_penalty.
 220         $applied_penalties = [map
 221             { $_->standing_penalty($_->standing_penalty->id()) }
 222                 grep {
 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()))
 228                 } @$raw_penalties];
 229     }
 230     $user->standing_penalties($applied_penalties);
 231 }
 232
 233 sub id {
 234     my $self = shift;
 235     return $self->{id};
 236 }
 237
 238 sub name {
 239     my $self = shift;
 240     return format_name($self->{user});
 241 }
 242
 243 sub format_name {
 244     my $u = shift;
 245     return OpenILS::SIP::clean_text(
 246         sprintf('%s %s %s',
 247             ($u->first_given_name || ''),
 248             ($u->second_given_name || ''),
 249             ($u->family_name || '')));
 250 }
 251
 252 sub home_library {
 253     my $self = shift;
 254     my $lib = OpenILS::SIP::shortname_from_id($self->{user}->home_ou);
 255     syslog('LOG_DEBUG', "OILS: Patron->home_library() = $lib");
 256     return $lib;
 257 }
 258
 259 sub __addr_string {
 260     my $addr = shift;
 261     return "" unless $addr;
 262     my $return = OpenILS::SIP::clean_text(
 263         join( ' ', map {$_ || ''} (
 264             $addr->street1,
 265             $addr->street2,
 266             $addr->city . ',',
 267             $addr->county,
 268             $addr->state,
 269             $addr->country,
 270             $addr->post_code
 271             )
 272         )
 273     );
 274     $return =~ s/\s+/ /sg;     # Compress any run of of whitespace to one space
 275     return $return;
 276 }
 277
 278 sub internal_id {
 279     my $self = shift;
 280     return $self->{user}->id;
 281 }
 282
 283 sub address {
 284     my $self = shift;
 285     my $u    = $self->{user};
 286     my $str  = __addr_string($u->billing_address || $u->mailing_address);
 287     syslog('LOG_DEBUG', "OILS: Patron address: $str");
 288     return $str;
 289 }
 290
 291 sub email_addr {
 292     my $self = shift;
 293     return OpenILS::SIP::clean_text($self->{user}->email);
 294 }
 295
 296 sub home_phone {
 297     my $self = shift;
 298     return $self->{user}->day_phone;
 299 }
 300
 301 sub sip_birthdate {
 302     my $self = shift;
 303     my $dob = OpenILS::SIP->format_date($self->{user}->dob, 'dob');
 304     syslog('LOG_DEBUG', "OILS: Patron DOB = $dob");
 305     return $dob;
 306 }
 307
 308 sub sip_expire {
 309     my $self = shift;
 310     my $expire = OpenILS::SIP->format_date($self->{user}->expire_date);
 311     syslog('LOG_DEBUG', "OILS: Patron Expire = $expire");
 312     return $expire;
 313 }
 314
 315 sub ptype {
 316     my $self = shift;
 317
 318     my $use_code = OpenILS::SIP->get_option_value('patron_type_uses_code') || '';
 319
 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;
 324
 325     return OpenILS::SIP::clean_text($self->{user}->profile->name);
 326 }
 327
 328 sub language {
 329     my $self = shift;
 330     return '000'; # Unspecified
 331 }
 332
 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
 335 # or an expired card
 336 sub charge_ok {
 337     my $self = shift;
 338     my $u = $self->{user};
 339
 340     # compute expiration date for borrowing privileges
 341     my $expire = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($u->expire_date));
 342
 343     # determine whether patron should be allowed to circulate materials:
 344     # not barred, doesn't owe too much wrt fines/fees, privileges haven't
 345     # expired
 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));
 350
 351     return
 352         !$circ_is_blocked and
 353         $u->active eq 't' and
 354         $u->card->active eq 't';
 355 }
 356
 357
 358
 359 # How much more detail do we need to check here?
 360 sub renew_ok {
 361     my $self = shift;
 362     return $self->charge_ok;
 363 }
 364
 365 sub recall_ok {
 366     my $self = shift;
 367     return $self->charge_ok if
 368         OpenILS::SIP->get_option_value('patron_calculate_recal_ok');
 369     return 0;
 370 }
 371
 372 sub hold_ok {
 373     my $self = shift;
 374     return $self->charge_ok;
 375 }
 376
 377 # return true if the card provided is marked as lost
 378 sub card_lost {
 379     my $self = shift;
 380     return $self->{user}->card->active eq 'f';
 381 }
 382
 383 sub recall_overdue {        # not implemented
 384     my $self = shift;
 385     return 0;
 386 }
 387
 388 sub check_password {
 389     my ($self, $pwd) = @_;
 390     syslog('LOG_DEBUG', 'OILS: Patron->check_password()');
 391     return 0 unless (defined $pwd and $self->{user});
 392     return $U->verify_migrated_user_password(
 393         $self->{editor},$self->{user}->id, $pwd);
 394 }
 395
 396 sub currency {              # not really implemented
 397     my $self = shift;
 398     syslog('LOG_DEBUG', 'OILS: Patron->currency()');
 399     return 'USD';
 400 }
 401
 402 sub fee_amount {
 403     my $self = shift;
 404     syslog('LOG_DEBUG', 'OILS: Patron->fee_amount()');
 405     my $user_id = $self->{user}->id;
 406
 407     my $e = $self->{editor};
 408     $e->xact_begin;
 409     my $summary = $e->retrieve_money_open_user_summary($user_id);
 410     $e->rollback; # xact_rollback + disconnect
 411
 412     my $total = ($summary) ? $summary->balance_owed : 0;
 413     syslog('LOG_INFO', "User ".$self->{id} .":$user_id has a fee amount of \$$total");
 414     return $total;
 415 }
 416
 417 sub screen_msg {
 418     my $self = shift;
 419     my $u = $self->{user};
 420
 421     return 'barred' if $u->barred eq 't';
 422
 423     my $b = 'blocked';
 424
 425     return $b if $u->active eq 'f';
 426     return $b if $u->card->active eq 'f';
 427
 428     # if we have any penalties at this point, they are blocking penalties
 429     return $b if $u->standing_penalties and @{$u->standing_penalties};
 430
 431     # has the patron account expired?
 432     my $expire = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($u->expire_date));
 433     return $b if CORE::time > $expire->epoch;
 434
 435     return '';
 436 }
 437
 438 sub print_line {            # not implemented
 439     my $self = shift;
 440     return '';
 441 }
 442
 443 sub too_many_charged {      # not implemented
 444     my $self = shift;
 445     return 0;
 446 }
 447
 448 sub too_many_overdue {
 449     my $self = shift;
 450     return scalar( # PATRON_EXCEEDS_OVERDUE_COUNT
 451         grep { $_ == OILS_PENALTY_PATRON_EXCEEDS_OVERDUE_COUNT } @{$self->{user}->standing_penalties}
 452     );
 453 }
 454
 455 # not completely sure what this means
 456 sub too_many_renewal {
 457     my $self = shift;
 458     return 0;
 459 }
 460
 461 # not relevant, handled by fines/fees
 462 sub too_many_claim_return {
 463     my $self = shift;
 464     return 0;
 465 }
 466
 467 # not relevant, handled by fines/fees
 468 sub too_many_lost {
 469     my $self = shift;
 470     return 0;
 471 }
 472
 473 sub excessive_fines {
 474     my $self = shift;
 475     return scalar( # PATRON_EXCEEDS_FINES
 476         grep { $_ == OILS_PENALTY_PATRON_EXCEEDS_FINES } @{$self->{user}->standing_penalties}
 477     );
 478 }
 479
 480 # Until someone suggests otherwise, fees and fines are the same
 481
 482 sub excessive_fees {
 483     my $self = shift;
 484     return $self->excessive_fines;
 485 }
 486
 487 # not relevant, handled by fines/fees
 488 sub too_many_billed {
 489     my $self = shift;
 490     return 0;
 491 }
 492
 493
 494
 495 #
 496 # List of outstanding holds placed
 497 #
 498 sub hold_items {
 499     my ($self, $start, $end, $ids_only) = @_;
 500     syslog('LOG_DEBUG', 'OILS: Patron->hold_items()');
 501
 502
 503     # all of my open holds
 504     my $holds = $self->{editor}->search_action_hold_request({
 505         usr => $self->{user}->id,
 506         fulfillment_time => undef,
 507         cancel_time => undef
 508     });
 509
 510     return $holds if $ids_only;
 511     return $self->__format_holds($holds, $start, $end);
 512 }
 513
 514 sub unavail_holds {
 515      my ($self, $start, $end, $ids_only) = @_;
 516      syslog('LOG_DEBUG', 'OILS: Patron->unavail_holds()');
 517
 518      my $holds = $self->{editor}->search_action_hold_request({
 519         usr => $self->{user}->id,
 520         fulfillment_time => undef,
 521         cancel_time => undef,
 522         '-or' => [
 523             {current_shelf_lib => undef},
 524             {current_shelf_lib => {'!=' => {'+ahr' => 'pickup_lib'}}}
 525         ]
 526     });
 527
 528     return $holds if $ids_only;
 529     return $self->__format_holds($holds, $start, $end);
 530 }
 531
 532
 533
 534 sub __format_holds {
 535     my ($self, $holds, $start, $end) = @_;
 536
 537     return [] unless @$holds;
 538
 539     my $return_datatype =
 540         OpenILS::SIP->get_option_value('msg64_hold_datatype') || '';
 541
 542     my @response;
 543
 544     for my $hold (@$holds) {
 545
 546         if ($return_datatype eq 'barcode') {
 547
 548             if (my $copy = $self->find_copy_for_hold($hold)) {
 549                 push(@response, $copy->barcode);
 550
 551             } else {
 552                 syslog('LOG_WARNING',
 553                     'OILS: No representative copy found for hold ' . $hold->id);
 554             }
 555
 556         } else {
 557             push(@response,
 558                 OpenILS::SIP::clean_text($self->__hold_to_title($hold)));
 559         }
 560     }
 561
 562     return (defined $start and defined $end) ?
 563         [ @response[($start-1)..($end-1)] ] :
 564         \@response;
 565 }
 566
 567 # Finds a representative copy for the given hold.
 568 # If no copy exists at all, undef is returned.
 569 # The only limit placed on what constitutes a
 570 # "representative" copy is that it cannot be deleted.
 571 # Otherwise, any copy that allows us to find the hold
 572 # later is good enough.
 573 sub find_copy_for_hold {
 574     my ($self, $hold) = @_;
 575     my $e = $self->{editor};
 576
 577     return $e->retrieve_asset_copy($hold->current_copy)
 578         if $hold->current_copy;
 579
 580     return $e->retrieve_asset_copy($hold->target)
 581         if $hold->hold_type =~ /C|R|F/;
 582
 583     return $e->search_asset_copy([
 584         {call_number => $hold->target, deleted => 'f'},
 585         {limit => 1}])->[0] if $hold->hold_type eq 'V';
 586
 587     my $bre_ids = [$hold->target];
 588
 589     if ($hold->hold_type eq 'M') {
 590         # find all of the bibs that link to the target metarecord
 591         my $maps = $e->search_metabib_metarecord_source_map(
 592             {metarecord => $hold->target});
 593         $bre_ids = [map {$_->record} @$maps];
 594     }
 595
 596     my $vol_ids = $e->search_asset_call_number(
 597         {record => $bre_ids, deleted => 'f'},
 598         {idlist => 1}
 599     );
 600
 601     return $e->search_asset_copy([
 602         {call_number => $vol_ids, deleted => 'f'},
 603         {limit => 1}
 604     ])->[0];
 605 }
 606
 607 # Given a "representative" copy, finds a matching hold
 608 sub find_hold_from_copy {
 609     my ($self, $barcode) = @_;
 610     my $e = $self->{editor};
 611     my $hold;
 612
 613     my $copy = $e->search_asset_copy([
 614         {barcode => $barcode, deleted => 'f'},
 615         {flesh => 1, flesh_fields => {acp => ['call_number']}}
 616     ])->[0];
 617
 618     return undef unless $copy;
 619
 620     my $run_hold_query = sub {
 621         my %filter = @_;
 622         return $e->search_action_hold_request([
 623             {   usr => $self->{user}->id,
 624                 cancel_time => undef,
 625                 fulfillment_time => undef,
 626                 %filter
 627             }, {
 628                 limit => 1,
 629                 order_by => {ahr => 'request_time DESC'}
 630             }
 631         ])->[0];
 632     };
 633
 634     # first see if there is a match on current_copy
 635     return $hold if $hold =
 636         $run_hold_query->(current_copy => $copy->id);
 637
 638     # next, assume bib-level holds are the most common
 639     return $hold if $hold = $run_hold_query->(
 640         target => $copy->call_number->record, hold_type => 'T');
 641
 642     # next try metarecord holds
 643     my $map = $e->search_metabib_metarecord_source_map(
 644         {source => $copy->call_number->record})->[0];
 645
 646     return $hold if $hold = $run_hold_query->(
 647         target => $map->metarecord, hold_type => 'M');
 648
 649     # volume holds
 650     return $hold if $hold = $run_hold_query->(
 651         target => $copy->call_number->id, hold_type => 'V');
 652
 653     # copy holds
 654     return $run_hold_query->(
 655         target => $copy->id, hold_type => ['C', 'F', 'R']);
 656 }
 657
 658 sub __hold_to_title {
 659     my $self = shift;
 660     my $hold = shift;
 661     my $e = $self->{editor};
 662
 663     my( $id, $mods, $title, $volume, $copy );
 664
 665     return __copy_to_title($e,
 666         $e->retrieve_asset_copy($hold->target))
 667         if $hold->hold_type eq 'C' or $hold->hold_type eq 'F' or $hold->hold_type eq 'R';
 668
 669     return __volume_to_title($e,
 670         $e->retrieve_asset_call_number($hold->target))
 671         if $hold->hold_type eq 'V';
 672
 673     return __record_to_title(
 674         $e, $hold->target) if $hold->hold_type eq 'T';
 675
 676     return __metarecord_to_title(
 677         $e, $hold->target) if $hold->hold_type eq 'M';
 678 }
 679
 680 sub __copy_to_title {
 681     my( $e, $copy ) = @_;
 682     #syslog('LOG_DEBUG', "OILS: copy_to_title(%s)", $copy->id);
 683     return $copy->dummy_title if $copy->call_number == -1;
 684
 685     my $vol = (ref $copy->call_number) ?
 686         $copy->call_number :
 687         $e->retrieve_asset_call_number($copy->call_number);
 688
 689     return __volume_to_title($e, $vol);
 690 }
 691
 692
 693 sub __volume_to_title {
 694     my( $e, $volume ) = @_;
 695     #syslog('LOG_DEBUG', "OILS: volume_to_title(%s)", $volume->id);
 696     return __record_to_title($e, $volume->record);
 697 }
 698
 699
 700 sub __record_to_title {
 701     my( $e, $title_id ) = @_;
 702     #syslog('LOG_DEBUG', "OILS: record_to_title($title_id)");
 703     my $mods = $U->simplereq(
 704         'open-ils.search',
 705         'open-ils.search.biblio.record.mods_slim.retrieve', $title_id );
 706     return ($mods) ? $mods->title : "";
 707 }
 708
 709 sub __metarecord_to_title {
 710     my( $e, $m_id ) = @_;
 711     #syslog('LOG_DEBUG', "OILS: metarecord_to_title($m_id)");
 712     my $mods = $U->simplereq(
 713         'open-ils.search',
 714         'open-ils.search.biblio.metarecord.mods_slim.retrieve', $m_id);
 715     return ($U->event_code($mods)) ? "<unknown>" : $mods->title;
 716 }
 717
 718
 719 #
 720 # remove the hold on item item_id from my hold queue.
 721 # return true if I was holding the item, false otherwise.
 722 #
 723 sub drop_hold {
 724     my ($self, $item_id) = @_;
 725     return 0;
 726 }
 727
 728 sub __patron_items_info {
 729     my $self = shift;
 730     return if $self->{item_info};
 731     $self->{item_info} =
 732         OpenILS::Application::Actor::_checked_out(
 733             0, $self->{editor}, $self->{user}->id);;
 734 }
 735
 736
 737
 738 sub overdue_items {
 739     my ($self, $start, $end, $ids_only) = @_;
 740
 741     $self->__patron_items_info();
 742     my @overdues = @{$self->{item_info}->{overdue}};
 743     #$overdues[$_] = __circ_to_title($self->{editor}, $overdues[$_]) for @overdues;
 744
 745     return \@overdues if $ids_only;
 746
 747     my @o;
 748     syslog('LOG_DEBUG', "OILS: overdue_items() fleshing circs @overdues");
 749
 750     my $return_datatype = OpenILS::SIP->get_option_value('msg64_summary_datatype') || '';
 751
 752     for my $circid (@overdues) {
 753         next unless $circid;
 754         if($return_datatype eq 'barcode') {
 755             push( @o, __circ_to_barcode($self->{editor}, $circid));
 756         } else {
 757             push( @o, OpenILS::SIP::clean_text(__circ_to_title($self->{editor}, $circid)));
 758         }
 759     }
 760     @overdues = @o;
 761
 762     return (defined $start and defined $end) ?
 763         [ @overdues[($start-1)..($end-1)] ] : \@overdues;
 764 }
 765
 766 sub __circ_to_barcode {
 767     my ($e, $circ) = @_;
 768     return unless $circ;
 769     $circ = $e->retrieve_action_circulation($circ);
 770     my $copy = $e->retrieve_asset_copy($circ->target_copy);
 771     return $copy->barcode;
 772 }
 773
 774 sub __circ_to_title {
 775     my( $e, $circ ) = @_;
 776     return unless $circ;
 777     $circ = $e->retrieve_action_circulation($circ);
 778     return __copy_to_title( $e,
 779         $e->retrieve_asset_copy($circ->target_copy) );
 780 }
 781
 782 sub charged_items {
 783     my ($self, $start, $end, $ids_only) = shift;
 784     return $self->charged_items_impl($start, $end, undef, $ids_only);
 785 }
 786
 787 # implementation method
 788 # force_bc -- return barcode data regardless of msg64_summary_datatype;
 789 #             this is used by the renew-all code
 790 sub charged_items_impl {
 791     my ($self, $start, $end, $force_bc, $ids_only) = shift;
 792
 793     $self->__patron_items_info();
 794
 795     my @charges = (
 796         @{$self->{item_info}->{out}},
 797         @{$self->{item_info}->{overdue}}
 798         );
 799
 800     #$charges[$_] = __circ_to_title($self->{editor}, $charges[$_]) for @charges;
 801
 802     return \@charges if $ids_only;
 803
 804     my @c;
 805     syslog('LOG_DEBUG', "OILS: charged_items() fleshing circs @charges");
 806
 807     my $return_datatype = OpenILS::SIP->get_option_value('msg64_summary_datatype') || '';
 808
 809     for my $circid (@charges) {
 810         next unless $circid;
 811         if($return_datatype eq 'barcode' or $force_bc) {
 812             push( @c, __circ_to_barcode($self->{editor}, $circid));
 813         } else {
 814             push( @c, OpenILS::SIP::clean_text(__circ_to_title($self->{editor}, $circid)));
 815         }
 816     }
 817
 818     @charges = @c;
 819
 820     return (defined $start and defined $end) ?
 821         [ @charges[($start-1)..($end-1)] ] :
 822         \@charges;
 823 }
 824
 825 sub fine_items {
 826     my ($self, $start, $end, $ids_only) = @_;
 827     my @fines;
 828     eval {
 829        my $xacts = $U->simplereq('open-ils.actor', 'open-ils.actor.user.transactions.history.have_balance', $self->{authtoken}, $self->{user}->id);
 830        foreach my $xact (@{$xacts}) {
 831            if ($ids_only) {
 832                push @fines, $xact;
 833                next;
 834            }
 835            my $line = $xact->balance_owed . " " . $xact->last_billing_type . " ";
 836            if ($xact->xact_type eq 'circulation') {
 837                my $mods = $U->simplereq('open-ils.circ', 'open-ils.circ.circ_transaction.find_title', $self->{authtoken}, $xact->id);
 838                $line .= $mods->title . ' / ' . $mods->author;
 839            } else {
 840                $line .= $xact->last_billing_note;
 841            }
 842            push @fines, OpenILS::SIP::clean_text($line);
 843        }
 844     };
 845     my $log_status = $@ ? 'ERROR: ' . $@ : 'OK';
 846     syslog('LOG_DEBUG', 'OILS: Patron->fine_items() ' . $log_status);
 847     return (defined $start and defined $end) ?
 848         [ @fines[($start-1)..($end-1)] ] : \@fines;
 849 }
 850
 851 # not currently supported
 852 sub recall_items {
 853     my ($self, $start, $end, $ids_only) = @_;
 854     return [];
 855 }
 856
 857 sub block {
 858     my ($self, $card_retained, $blocked_card_msg) = @_;
 859     $blocked_card_msg ||= '';
 860
 861     my $e = $self->{editor};
 862     my $u = $self->{user};
 863
 864     syslog('LOG_INFO', "OILS: Blocking user %s", $u->card->barcode );
 865
 866     return $self if $u->card->active eq 'f';
 867
 868     $e->xact_begin;    # connect and start a new transaction
 869
 870     $u->card->active('f');
 871     if( ! $e->update_actor_card($u->card) ) {
 872         syslog('LOG_ERR', "OILS: Block card update failed: %s", $e->event->{textcode});
 873         $e->rollback; # rollback + disconnect
 874         return $self;
 875     }
 876
 877     # retrieve the un-fleshed user object for update
 878     $u = $e->retrieve_actor_user($u->id);
 879     my $note = OpenILS::SIP::clean_text($u->alert_message) || "";
 880     $note = "<sip> CARD BLOCKED BY SELF-CHECK MACHINE. $blocked_card_msg</sip>\n$note"; # XXX Config option
 881     $note =~ s/\s*$//;  # kill trailng whitespace
 882     $u->alert_message($note);
 883
 884     if( ! $e->update_actor_user($u) ) {
 885         syslog('LOG_ERR', "OILS: Block: patron alert update failed: %s", $e->event->{textcode});
 886         $e->rollback; # rollback + disconnect
 887         return $self;
 888     }
 889
 890     # stay in synch
 891     $self->{user}->alert_message( $note );
 892
 893     $e->commit; # commits and disconnects
 894     return $self;
 895 }
 896
 897 # Testing purposes only
 898 sub enable {
 899     my ($self, $card_retained) = @_;
 900     $self->{screen_msg} = "All privileges restored.";
 901
 902     # Un-mark card as inactive, grep out the patron alert
 903     my $e = $self->{editor};
 904     my $u = $self->{user};
 905
 906     syslog('LOG_INFO', "OILS: Unblocking user %s", $u->card->barcode );
 907
 908     return $self if $u->card->active eq 't';
 909
 910     $e->xact_begin;    # connect and start a new transaction
 911
 912     $u->card->active('t');
 913     if( ! $e->update_actor_card($u->card) ) {
 914         syslog('LOG_ERR', "OILS: Unblock card update failed: %s", $e->event->{textcode});
 915         $e->rollback; # rollback + disconnect
 916         return $self;
 917     }
 918
 919     # retrieve the un-fleshed user object for update
 920     $u = $e->retrieve_actor_user($u->id);
 921     my $note = OpenILS::SIP::clean_text($u->alert_message) || "";
 922     $note =~ s#<sip>.*</sip>##;
 923     $note =~ s/^\s*//;  # kill leading whitespace
 924     $note =~ s/\s*$//;  # kill trailng whitespace
 925     $u->alert_message($note);
 926
 927     if( ! $e->update_actor_user($u) ) {
 928         syslog('LOG_ERR', "OILS: Unblock: patron alert update failed: %s", $e->event->{textcode});
 929         $e->rollback; # rollback + disconnect
 930         return $self;
 931     }
 932
 933     # stay in synch
 934     $self->{user}->alert_message( $note );
 935
 936     $e->commit; # commits and disconnects
 937     return $self;
 938 }
 939
 940 #
 941 # Messages
 942 #
 943
 944 sub invalid_patron {
 945     return "Please contact library staff";
 946 }
 947
 948 sub charge_denied {
 949     return "Please contact library staff";
 950 }
 951
 952 sub inet_privileges {
 953     my( $self ) = @_;
 954     my $e = OpenILS::SIP->editor();
 955     $INET_PRIVS = $e->retrieve_all_config_net_access_level() unless $INET_PRIVS;
 956     my ($level) = grep { $_->id eq $self->{user}->net_access_level } @$INET_PRIVS;
 957     my $name = OpenILS::SIP::clean_text($level->name);
 958     syslog('LOG_DEBUG', "OILS: Patron inet_privs = $name");
 959     return $name;
 960 }
 961
 962 sub extra_fields {
 963     my( $self ) = @_;
 964     my $extra_fields = {};
 965     my $u = $self->{user};
 966     foreach my $stat_cat_entry (@{$u->stat_cat_entries}) {
 967         my $stat_cat = $stat_cat_entry->stat_cat;
 968         next unless ($stat_cat->sip_field);
 969         my $value = $stat_cat_entry->stat_cat_entry;
 970         if(defined $stat_cat->sip_format && length($stat_cat->sip_format) > 0) { # Has a format string?
 971             if($stat_cat->sip_format =~ /^\|(.*)\|$/) { # Regex match?
 972                 if($value =~ /($1)/) { # If we have a match
 973                     if(defined $2) { # Check to see if they embedded a capture group
 974                         $value = $2; # If so, use it
 975                     }
 976                     else { # No embedded capture group?
 977                         $value = $1; # Use our outer one
 978                     }
 979                 }
 980                 else { # No match?
 981                     $value = ''; # Empty string. Will be checked for below.
 982                 }
 983             }
 984             else { # Not a regex match - Try sprintf match (looking for a %s, if any)
 985                 $value = sprintf($stat_cat->sip_format, $value);
 986             }
 987         }
 988         next unless length($value) > 0; # No value = no export
 989         $value =~ s/\|//g; # Remove all lingering pipe chars for sane output purposes
 990         $extra_fields->{ $stat_cat->sip_field } = [] unless (defined $extra_fields->{$stat_cat->sip_field});
 991         push(@{$extra_fields->{ $stat_cat->sip_field}}, $value);
 992     }
 993     return $extra_fields;
 994 }
 995
 996 1;