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 }
 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     my $circ_is_blocked = 0;
 340
 341     # compute expiration date for borrowing privileges
 342     my $expire = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($u->expire_date));
 343
 344     $circ_is_blocked =
 345         (($u->barred eq 't') or
 346           (@{$u->standing_penalties} and grep { ( $_->block_list // '') =~ /CIRC/ } @{$u->standing_penalties}) or
 347           (CORE::time > $expire->epoch));
 348
 349     return
 350         !$circ_is_blocked &&
 351         $u->active eq 't' &&
 352         $u->card->active eq 't';
 353 }
 354
 355 sub renew_ok {
 356     my $self = shift;
 357     my $u = $self->{user};
 358     my $renew_is_blocked = 0;
 359
 360     # compute expiration date for borrowing privileges
 361     my $expire = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($u->expire_date));
 362
 363     $renew_is_blocked =
 364         (($u->barred eq 't') or
 365          (@{$u->standing_penalties} and grep { ( $_->block_list // '') =~ /RENEW/ } @{$u->standing_penalties}) or
 366          (CORE::time > $expire->epoch));
 367
 368     return
 369         !$renew_is_blocked &&
 370         $u->active eq 't' &&
 371         $u->card->active eq 't';
 372 }
 373
 374 sub recall_ok {
 375     my $self = shift;
 376     return $self->charge_ok if
 377         OpenILS::SIP->get_option_value('patron_calculate_recal_ok');
 378     return 0;
 379 }
 380
 381 sub hold_ok {
 382     my $self = shift;
 383     my $u = $self->{user};
 384     my $hold_is_blocked = 0;
 385
 386     # compute expiration date for borrowing privileges
 387     my $expire = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($u->expire_date));
 388
 389     $hold_is_blocked =
 390         (($u->barred eq 't') or
 391          (@{$u->standing_penalties} and grep { ( $_->block_list // '') =~ /HOLD/ } @{$u->standing_penalties}) or
 392          (CORE::time > $expire->epoch));
 393
 394     return
 395         !$hold_is_blocked &&
 396         $u->active eq 't' &&
 397         $u->card->active eq 't';
 398 }
 399
 400 # return true if the card provided is marked as lost
 401 sub card_lost {
 402     my $self = shift;
 403     return $self->{user}->card->active eq 'f';
 404 }
 405
 406 sub recall_overdue {        # not implemented
 407     my $self = shift;
 408     return 0;
 409 }
 410
 411 sub check_password {
 412     my ($self, $pwd) = @_;
 413     syslog('LOG_DEBUG', 'OILS: Patron->check_password()');
 414     return 0 unless (defined $pwd and $self->{user});
 415     return $U->verify_migrated_user_password(
 416         $self->{editor},$self->{user}->id, $pwd);
 417 }
 418
 419 sub currency {
 420     my $self = shift;
 421     syslog('LOG_DEBUG', 'OILS: Patron->currency()');
 422     return OpenILS::SIP->config()->{implementation_config}->{currency} || 'USD';
 423 }
 424
 425 sub fee_amount {
 426     my $self = shift;
 427     syslog('LOG_DEBUG', 'OILS: Patron->fee_amount()');
 428     my $user_id = $self->{user}->id;
 429
 430     my $e = $self->{editor};
 431     $e->xact_begin;
 432     my $summary = $e->retrieve_money_open_user_summary($user_id);
 433     $e->rollback; # xact_rollback + disconnect
 434
 435     my $total = ($summary) ? $summary->balance_owed : 0;
 436     syslog('LOG_INFO', "User ".$self->{id} .":$user_id has a fee amount of \$$total");
 437     return $total;
 438 }
 439
 440 sub screen_msg {
 441     my $self = shift;
 442     my $u = $self->{user};
 443
 444     return 'barred' if $u->barred eq 't';
 445
 446     my $b = 'blocked';
 447
 448     return $b if $u->active eq 'f';
 449     return $b if $u->card->active eq 'f';
 450
 451     # if we have any penalties at this point, they are blocking penalties
 452     return $b if $u->standing_penalties and @{$u->standing_penalties};
 453
 454     # has the patron account expired?
 455     my $expire = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($u->expire_date));
 456     return $b if CORE::time > $expire->epoch;
 457
 458     return '';
 459 }
 460
 461 sub print_line {            # not implemented
 462     my $self = shift;
 463     return '';
 464 }
 465
 466 sub too_many_charged {      # not implemented
 467     my $self = shift;
 468     return 0;
 469 }
 470
 471 sub too_many_overdue {
 472     my $self = shift;
 473     return scalar( # PATRON_EXCEEDS_OVERDUE_COUNT
 474         grep { $_ == OILS_PENALTY_PATRON_EXCEEDS_OVERDUE_COUNT } @{$self->{user}->standing_penalties}
 475     );
 476 }
 477
 478 # not completely sure what this means
 479 sub too_many_renewal {
 480     my $self = shift;
 481     return 0;
 482 }
 483
 484 # not relevant, handled by fines/fees
 485 sub too_many_claim_return {
 486     my $self = shift;
 487     return 0;
 488 }
 489
 490 # not relevant, handled by fines/fees
 491 sub too_many_lost {
 492     my $self = shift;
 493     return 0;
 494 }
 495
 496 sub excessive_fines {
 497     my $self = shift;
 498     return scalar( # PATRON_EXCEEDS_FINES
 499         grep { $_ == OILS_PENALTY_PATRON_EXCEEDS_FINES } @{$self->{user}->standing_penalties}
 500     );
 501 }
 502
 503 # Until someone suggests otherwise, fees and fines are the same
 504
 505 sub excessive_fees {
 506     my $self = shift;
 507     return $self->excessive_fines;
 508 }
 509
 510 # not relevant, handled by fines/fees
 511 sub too_many_billed {
 512     my $self = shift;
 513     return 0;
 514 }
 515
 516
 517
 518 #
 519 # List of outstanding holds placed
 520 #
 521 sub hold_items {
 522     my ($self, $start, $end, $ids_only) = @_;
 523     syslog('LOG_DEBUG', 'OILS: Patron->hold_items()');
 524
 525
 526     # all of my open holds
 527     my $holds = $self->{editor}->search_action_hold_request({
 528         usr => $self->{user}->id,
 529         fulfillment_time => undef,
 530         cancel_time => undef
 531     });
 532
 533     return $holds if $ids_only;
 534     return $self->__format_holds($holds, $start, $end);
 535 }
 536
 537 sub unavail_holds {
 538      my ($self, $start, $end, $ids_only) = @_;
 539      syslog('LOG_DEBUG', 'OILS: Patron->unavail_holds()');
 540
 541      my $holds = $self->{editor}->search_action_hold_request({
 542         usr => $self->{user}->id,
 543         fulfillment_time => undef,
 544         cancel_time => undef,
 545         '-or' => [
 546             {current_shelf_lib => undef},
 547             {current_shelf_lib => {'!=' => {'+ahr' => 'pickup_lib'}}}
 548         ]
 549     });
 550
 551     return $holds if $ids_only;
 552     return $self->__format_holds($holds, $start, $end);
 553 }
 554
 555
 556
 557 sub __format_holds {
 558     my ($self, $holds, $start, $end) = @_;
 559
 560     return [] unless @$holds;
 561
 562     my $return_datatype =
 563         OpenILS::SIP->get_option_value('msg64_hold_datatype') || '';
 564
 565     my @response;
 566
 567     for my $hold (@$holds) {
 568
 569         if ($return_datatype eq 'barcode') {
 570
 571             if (my $copy = $self->find_copy_for_hold($hold)) {
 572                 push(@response, $copy->barcode);
 573
 574             } else {
 575                 syslog('LOG_WARNING',
 576                     'OILS: No representative copy found for hold ' . $hold->id);
 577             }
 578
 579         } else {
 580             push(@response,
 581                 OpenILS::SIP::clean_text($self->__hold_to_title($hold)));
 582         }
 583     }
 584
 585     return (defined $start and defined $end) ?
 586         [ @response[($start-1)..($end-1)] ] :
 587         \@response;
 588 }
 589
 590 # Finds a representative copy for the given hold.
 591 # If no copy exists at all, undef is returned.
 592 # The only limit placed on what constitutes a
 593 # "representative" copy is that it cannot be deleted.
 594 # Otherwise, any copy that allows us to find the hold
 595 # later is good enough.
 596 sub find_copy_for_hold {
 597     my ($self, $hold) = @_;
 598     my $e = $self->{editor};
 599
 600     return $e->retrieve_asset_copy($hold->current_copy)
 601         if $hold->current_copy;
 602
 603     return $e->retrieve_asset_copy($hold->target)
 604         if $hold->hold_type =~ /C|R|F/;
 605
 606     return $e->search_asset_copy([
 607         {call_number => $hold->target, deleted => 'f'},
 608         {limit => 1}])->[0] if $hold->hold_type eq 'V';
 609
 610     my $bre_ids = [$hold->target];
 611
 612     if ($hold->hold_type eq 'M') {
 613         # find all of the bibs that link to the target metarecord
 614         my $maps = $e->search_metabib_metarecord_source_map(
 615             {metarecord => $hold->target});
 616         $bre_ids = [map {$_->record} @$maps];
 617     }
 618
 619     my $vol_ids = $e->search_asset_call_number(
 620         {record => $bre_ids, deleted => 'f'},
 621         {idlist => 1}
 622     );
 623
 624     return $e->search_asset_copy([
 625         {call_number => $vol_ids, deleted => 'f'},
 626         {limit => 1}
 627     ])->[0];
 628 }
 629
 630 # Given a "representative" copy, finds a matching hold
 631 sub find_hold_from_copy {
 632     my ($self, $barcode) = @_;
 633     my $e = $self->{editor};
 634     my $hold;
 635
 636     my $copy = $e->search_asset_copy([
 637         {barcode => $barcode, deleted => 'f'},
 638         {flesh => 1, flesh_fields => {acp => ['call_number']}}
 639     ])->[0];
 640
 641     return undef unless $copy;
 642
 643     my $run_hold_query = sub {
 644         my %filter = @_;
 645         return $e->search_action_hold_request([
 646             {   usr => $self->{user}->id,
 647                 cancel_time => undef,
 648                 fulfillment_time => undef,
 649                 %filter
 650             }, {
 651                 limit => 1,
 652                 order_by => {ahr => 'request_time DESC'}
 653             }
 654         ])->[0];
 655     };
 656
 657     # first see if there is a match on current_copy
 658     return $hold if $hold =
 659         $run_hold_query->(current_copy => $copy->id);
 660
 661     # next, assume bib-level holds are the most common
 662     return $hold if $hold = $run_hold_query->(
 663         target => $copy->call_number->record, hold_type => 'T');
 664
 665     # next try metarecord holds
 666     my $map = $e->search_metabib_metarecord_source_map(
 667         {source => $copy->call_number->record})->[0];
 668
 669     return $hold if $hold = $run_hold_query->(
 670         target => $map->metarecord, hold_type => 'M');
 671
 672     # volume holds
 673     return $hold if $hold = $run_hold_query->(
 674         target => $copy->call_number->id, hold_type => 'V');
 675
 676     # copy holds
 677     return $run_hold_query->(
 678         target => $copy->id, hold_type => ['C', 'F', 'R']);
 679 }
 680
 681 sub __hold_to_title {
 682     my $self = shift;
 683     my $hold = shift;
 684     my $e = $self->{editor};
 685
 686     my( $id, $mods, $title, $volume, $copy );
 687
 688     return __copy_to_title($e,
 689         $e->retrieve_asset_copy($hold->target))
 690         if $hold->hold_type eq 'C' or $hold->hold_type eq 'F' or $hold->hold_type eq 'R';
 691
 692     return __volume_to_title($e,
 693         $e->retrieve_asset_call_number($hold->target))
 694         if $hold->hold_type eq 'V';
 695
 696     return __record_to_title(
 697         $e, $hold->target) if $hold->hold_type eq 'T';
 698
 699     return __metarecord_to_title(
 700         $e, $hold->target) if $hold->hold_type eq 'M';
 701 }
 702
 703 sub __copy_to_title {
 704     my( $e, $copy ) = @_;
 705     #syslog('LOG_DEBUG', "OILS: copy_to_title(%s)", $copy->id);
 706     return $copy->dummy_title if $copy->call_number == -1;
 707
 708     my $vol = (ref $copy->call_number) ?
 709         $copy->call_number :
 710         $e->retrieve_asset_call_number($copy->call_number);
 711
 712     return __volume_to_title($e, $vol);
 713 }
 714
 715
 716 sub __volume_to_title {
 717     my( $e, $volume ) = @_;
 718     #syslog('LOG_DEBUG', "OILS: volume_to_title(%s)", $volume->id);
 719     return __record_to_title($e, $volume->record);
 720 }
 721
 722
 723 sub __record_to_title {
 724     my( $e, $title_id ) = @_;
 725     #syslog('LOG_DEBUG', "OILS: record_to_title($title_id)");
 726     my $mods = $U->simplereq(
 727         'open-ils.search',
 728         'open-ils.search.biblio.record.mods_slim.retrieve', $title_id );
 729     return ($mods) ? $mods->title : "";
 730 }
 731
 732 sub __metarecord_to_title {
 733     my( $e, $m_id ) = @_;
 734     #syslog('LOG_DEBUG', "OILS: metarecord_to_title($m_id)");
 735     my $mods = $U->simplereq(
 736         'open-ils.search',
 737         'open-ils.search.biblio.metarecord.mods_slim.retrieve', $m_id);
 738     return ($U->event_code($mods)) ? "<unknown>" : $mods->title;
 739 }
 740
 741
 742 #
 743 # remove the hold on item item_id from my hold queue.
 744 # return true if I was holding the item, false otherwise.
 745 #
 746 sub drop_hold {
 747     my ($self, $item_id) = @_;
 748     return 0;
 749 }
 750
 751 sub __patron_items_info {
 752     my $self = shift;
 753     return if $self->{item_info};
 754     $self->{item_info} =
 755         OpenILS::Application::Actor::_checked_out(
 756             0, $self->{editor}, $self->{user}->id);;
 757 }
 758
 759
 760
 761 sub overdue_items {
 762     my ($self, $start, $end, $ids_only) = @_;
 763
 764     $self->__patron_items_info();
 765     my @overdues = @{$self->{item_info}->{overdue}};
 766     #$overdues[$_] = __circ_to_title($self->{editor}, $overdues[$_]) for @overdues;
 767
 768     return \@overdues if $ids_only;
 769
 770     my @o;
 771     syslog('LOG_DEBUG', "OILS: overdue_items() fleshing circs @overdues");
 772
 773     my $return_datatype = OpenILS::SIP->get_option_value('msg64_summary_datatype') || '';
 774
 775     for my $circid (@overdues) {
 776         next unless $circid;
 777         if($return_datatype eq 'barcode') {
 778             push( @o, __circ_to_barcode($self->{editor}, $circid));
 779         } else {
 780             push( @o, OpenILS::SIP::clean_text(__circ_to_title($self->{editor}, $circid)));
 781         }
 782     }
 783     @overdues = @o;
 784
 785     return (defined $start and defined $end) ?
 786         [ @overdues[($start-1)..($end-1)] ] : \@overdues;
 787 }
 788
 789 sub __circ_to_barcode {
 790     my ($e, $circ) = @_;
 791     return unless $circ;
 792     $circ = $e->retrieve_action_circulation($circ);
 793     my $copy = $e->retrieve_asset_copy($circ->target_copy);
 794     return $copy->barcode;
 795 }
 796
 797 sub __circ_to_title {
 798     my( $e, $circ ) = @_;
 799     return unless $circ;
 800     $circ = $e->retrieve_action_circulation($circ);
 801     return __copy_to_title( $e,
 802         $e->retrieve_asset_copy($circ->target_copy) );
 803 }
 804
 805 sub charged_items {
 806     my ($self, $start, $end, $ids_only) = shift;
 807     return $self->charged_items_impl($start, $end, undef, $ids_only);
 808 }
 809
 810 # implementation method
 811 # force_bc -- return barcode data regardless of msg64_summary_datatype;
 812 #             this is used by the renew-all code
 813 sub charged_items_impl {
 814     my ($self, $start, $end, $force_bc, $ids_only) = shift;
 815
 816     $self->__patron_items_info();
 817
 818     my @charges = (
 819         @{$self->{item_info}->{out}},
 820         @{$self->{item_info}->{overdue}}
 821         );
 822
 823     #$charges[$_] = __circ_to_title($self->{editor}, $charges[$_]) for @charges;
 824
 825     return \@charges if $ids_only;
 826
 827     my @c;
 828     syslog('LOG_DEBUG', "OILS: charged_items() fleshing circs @charges");
 829
 830     my $return_datatype = OpenILS::SIP->get_option_value('msg64_summary_datatype') || '';
 831
 832     for my $circid (@charges) {
 833         next unless $circid;
 834         if($return_datatype eq 'barcode' or $force_bc) {
 835             push( @c, __circ_to_barcode($self->{editor}, $circid));
 836         } else {
 837             push( @c, OpenILS::SIP::clean_text(__circ_to_title($self->{editor}, $circid)));
 838         }
 839     }
 840
 841     @charges = @c;
 842
 843     return (defined $start and defined $end) ?
 844         [ @charges[($start-1)..($end-1)] ] :
 845         \@charges;
 846 }
 847
 848 sub fine_items {
 849     my ($self, $start, $end, $ids_only) = @_;
 850     my @fines;
 851     eval {
 852        my $xacts = $U->simplereq('open-ils.actor', 'open-ils.actor.user.transactions.history.have_balance', $self->{authtoken}, $self->{user}->id);
 853        foreach my $xact (@{$xacts}) {
 854            if ($ids_only) {
 855                push @fines, $xact;
 856                next;
 857            }
 858            my $line = $xact->balance_owed . " " . $xact->last_billing_type . " ";
 859            if ($xact->xact_type eq 'circulation') {
 860                my $mods = $U->simplereq('open-ils.circ', 'open-ils.circ.circ_transaction.find_title', $self->{authtoken}, $xact->id);
 861                $line .= $mods->title . ' / ' . $mods->author;
 862            } else {
 863                $line .= $xact->last_billing_note;
 864            }
 865            push @fines, OpenILS::SIP::clean_text($line);
 866        }
 867     };
 868     my $log_status = $@ ? 'ERROR: ' . $@ : 'OK';
 869     syslog('LOG_DEBUG', 'OILS: Patron->fine_items() ' . $log_status);
 870     return (defined $start and defined $end) ?
 871         [ @fines[($start-1)..($end-1)] ] : \@fines;
 872 }
 873
 874 # not currently supported
 875 sub recall_items {
 876     my ($self, $start, $end, $ids_only) = @_;
 877     return [];
 878 }
 879
 880 sub block {
 881     my ($self, $card_retained, $blocked_card_msg) = @_;
 882     $blocked_card_msg ||= '';
 883
 884     my $e = $self->{editor};
 885     my $u = $self->{user};
 886
 887     syslog('LOG_INFO', "OILS: Blocking user %s", $u->card->barcode );
 888
 889     return $self if $u->card->active eq 'f';
 890
 891     $e->xact_begin;    # connect and start a new transaction
 892
 893     $u->card->active('f');
 894     if( ! $e->update_actor_card($u->card) ) {
 895         syslog('LOG_ERR', "OILS: Block card update failed: %s", $e->event->{textcode});
 896         $e->rollback; # rollback + disconnect
 897         return $self;
 898     }
 899
 900     # retrieve the un-fleshed user object for update
 901     $u = $e->retrieve_actor_user($u->id);
 902     my $note = OpenILS::SIP::clean_text($u->alert_message) || "";
 903     $note = "<sip> CARD BLOCKED BY SELF-CHECK MACHINE. $blocked_card_msg</sip>\n$note"; # XXX Config option
 904     $note =~ s/\s*$//;  # kill trailng whitespace
 905     $u->alert_message($note);
 906
 907     if( ! $e->update_actor_user($u) ) {
 908         syslog('LOG_ERR', "OILS: Block: patron alert update failed: %s", $e->event->{textcode});
 909         $e->rollback; # rollback + disconnect
 910         return $self;
 911     }
 912
 913     # stay in synch
 914     $self->{user}->alert_message( $note );
 915
 916     $e->commit; # commits and disconnects
 917     return $self;
 918 }
 919
 920 # Testing purposes only
 921 sub enable {
 922     my ($self, $card_retained) = @_;
 923     $self->{screen_msg} = "All privileges restored.";
 924
 925     # Un-mark card as inactive, grep out the patron alert
 926     my $e = $self->{editor};
 927     my $u = $self->{user};
 928
 929     syslog('LOG_INFO', "OILS: Unblocking user %s", $u->card->barcode );
 930
 931     return $self if $u->card->active eq 't';
 932
 933     $e->xact_begin;    # connect and start a new transaction
 934
 935     $u->card->active('t');
 936     if( ! $e->update_actor_card($u->card) ) {
 937         syslog('LOG_ERR', "OILS: Unblock card update failed: %s", $e->event->{textcode});
 938         $e->rollback; # rollback + disconnect
 939         return $self;
 940     }
 941
 942     # retrieve the un-fleshed user object for update
 943     $u = $e->retrieve_actor_user($u->id);
 944     my $note = OpenILS::SIP::clean_text($u->alert_message) || "";
 945     $note =~ s#<sip>.*</sip>##;
 946     $note =~ s/^\s*//;  # kill leading whitespace
 947     $note =~ s/\s*$//;  # kill trailng whitespace
 948     $u->alert_message($note);
 949
 950     if( ! $e->update_actor_user($u) ) {
 951         syslog('LOG_ERR', "OILS: Unblock: patron alert update failed: %s", $e->event->{textcode});
 952         $e->rollback; # rollback + disconnect
 953         return $self;
 954     }
 955
 956     # stay in synch
 957     $self->{user}->alert_message( $note );
 958
 959     $e->commit; # commits and disconnects
 960     return $self;
 961 }
 962
 963 #
 964 # Messages
 965 #
 966
 967 sub invalid_patron {
 968     return "Please contact library staff";
 969 }
 970
 971 sub charge_denied {
 972     return "Please contact library staff";
 973 }
 974
 975 sub inet_privileges {
 976     my( $self ) = @_;
 977     my $e = OpenILS::SIP->editor();
 978     $INET_PRIVS = $e->retrieve_all_config_net_access_level() unless $INET_PRIVS;
 979     my ($level) = grep { $_->id eq $self->{user}->net_access_level } @$INET_PRIVS;
 980     my $name = OpenILS::SIP::clean_text($level->name);
 981     syslog('LOG_DEBUG', "OILS: Patron inet_privs = $name");
 982     return $name;
 983 }
 984
 985 sub extra_fields {
 986     my( $self ) = @_;
 987     my $extra_fields = {};
 988     my $u = $self->{user};
 989     foreach my $stat_cat_entry (@{$u->stat_cat_entries}) {
 990         my $stat_cat = $stat_cat_entry->stat_cat;
 991         next unless ($stat_cat->sip_field);
 992         my $value = $stat_cat_entry->stat_cat_entry;
 993         if(defined $stat_cat->sip_format && length($stat_cat->sip_format) > 0) { # Has a format string?
 994             if($stat_cat->sip_format =~ /^\|(.*)\|$/) { # Regex match?
 995                 if($value =~ /($1)/) { # If we have a match
 996                     if(defined $2) { # Check to see if they embedded a capture group
 997                         $value = $2; # If so, use it
 998                     }
 999                     else { # No embedded capture group?
1000                         $value = $1; # Use our outer one
1001                     }
1002                 }
1003                 else { # No match?
1004                     $value = ''; # Empty string. Will be checked for below.
1005                 }
1006             }
1007             else { # Not a regex match - Try sprintf match (looking for a %s, if any)
1008                 $value = sprintf($stat_cat->sip_format, $value);
1009             }
1010         }
1011         next unless length($value) > 0; # No value = no export
1012         $value =~ s/\|//g; # Remove all lingering pipe chars for sane output purposes
1013         $extra_fields->{ $stat_cat->sip_field } = [] unless (defined $extra_fields->{$stat_cat->sip_field});
1014         push(@{$extra_fields->{ $stat_cat->sip_field}}, $value);
1015     }
1016     return $extra_fields;
1017 }
1018
1019 1;