Open-ILS/src/perlmods/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, $patron_id) = @_;
  34     my $type = ref($class) || $class;
  35     my $self = {};
  36
  37         syslog("LOG_DEBUG", "OILS: new OpenILS Patron(%s): searching...", $patron_id);
  38
  39         my $e = OpenILS::SIP->editor();
  40
  41         my $c = $e->search_actor_card({barcode => $patron_id}, {idlist=>1});
  42         my $user;
  43
  44         if( @$c ) {
  45
  46                 $user = $e->search_actor_user(
  47                         [
  48                                 { card => $$c[0] },
  49                                 {
  50                                         flesh => 1,
  51                                         flesh_fields => {
  52                                                 "au" => [
  53                                                         #"cards",
  54                                                         "card",
  55                                                         "standing_penalties",
  56                                                         "addresses",
  57                                                         "billing_address",
  58                                                         "mailing_address",
  59                                                         #"stat_cat_entries",
  60                                                         'profile',
  61                                                 ]
  62                                         }
  63                                 }
  64                         ]
  65                 );
  66
  67                 $user = (@$user) ? $$user[0] : undef;
  68          }
  69
  70          if(!$user) {
  71                 syslog("LOG_WARNING", "OILS: Unable to find patron %s", $patron_id);
  72                 return undef;
  73          }
  74
  75         $self->{user}           = $user;
  76         $self->{id}                     = $patron_id;
  77         $self->{editor} = $e;
  78
  79         syslog("LOG_DEBUG", "OILS: new OpenILS Patron(%s): found patron : barred=%s, card:active=%s",
  80                 $patron_id, $self->{user}->barred, $self->{user}->card->active );
  81
  82
  83         bless $self, $type;
  84         return $self;
  85 }
  86
  87 sub id {
  88     my $self = shift;
  89     return $self->{id};
  90 }
  91
  92 sub name {
  93     my $self = shift;
  94          my $u = $self->{user};
  95          return $u->first_given_name . ' ' .
  96                 $u->second_given_name . ' ' . $u->family_name;
  97 }
  98
  99 sub __addr_string {
 100         my $addr = shift;
 101         return "" unless $addr;
 102         return $addr->street1 .' '.
 103                 $addr->street2 .' '.
 104                 $addr->city .' '.
 105                 $addr->county .' '.
 106                 $addr->state .' '.
 107                 $addr->country .' '.
 108                 $addr->post_code;
 109 }
 110
 111 sub address {
 112         my $self = shift;
 113         my $u = $self->{user};
 114         my $addr = $u->billing_address;
 115         $addr = $u->mailing_address unless $addr;
 116         my $str = __addr_string($addr);
 117         syslog('LOG_DEBUG', "OILS: Patron address: $str");
 118         return $str;
 119 }
 120
 121 sub email_addr {
 122     my $self = shift;
 123         return $self->{user}->email;
 124 }
 125
 126 sub home_phone {
 127     my $self = shift;
 128         return $self->{user}->day_phone;
 129 }
 130
 131 sub sip_birthdate {
 132         my $self = shift;
 133         my $dob = OpenILS::SIP->format_date($self->{user}->dob);
 134         syslog('LOG_DEBUG', "OILS: Patron DOB = $dob");
 135         return $dob;
 136 }
 137
 138 sub ptype {
 139     my $self = shift;
 140         return $self->{user}->profile->name;
 141 }
 142
 143 sub language {
 144     my $self = shift;
 145     return '000'; # Unspecified
 146 }
 147
 148 # How much more detail do we need to check here?
 149 sub charge_ok {
 150     my $self = shift;
 151          my $u = $self->{user};
 152          return (($u->barred eq 'f') and ($u->card->active eq 't'));
 153 }
 154
 155 # How much more detail do we need to check here?
 156 sub renew_ok {
 157     my $self = shift;
 158          return $self->charge_ok;
 159 }
 160
 161 sub recall_ok {
 162     my $self = shift;
 163     return 0;
 164 }
 165
 166 sub hold_ok {
 167     my $self = shift;
 168          return $self->charge_ok;
 169 }
 170
 171 # return true if the card provided is marked as lost
 172 sub card_lost {
 173     my $self = shift;
 174          return $self->{user}->card->active eq 'f';
 175 }
 176
 177 sub recall_overdue {
 178     my $self = shift;
 179     return 0;
 180 }
 181
 182
 183 sub check_password {
 184         my ($self, $pwd) = @_;
 185         syslog('LOG_DEBUG', 'OILS: Patron->check_password()');
 186         return md5_hex($pwd) eq $self->{user}->passwd;
 187 }
 188
 189
 190 sub currency {
 191         my $self = shift;
 192         syslog('LOG_DEBUG', 'OILS: Patron->currency()');
 193         return 'USD';
 194 }
 195
 196 sub fee_amount {
 197         my $self = shift;
 198         syslog('LOG_DEBUG', 'OILS: Patron->fee_amount()');
 199
 200         my $total = 0;
 201         my $e = OpenILS::SIP->editor();
 202         my $xacts = $e->search_money_open_billable_transaction_summary(
 203                 { usr => $self->{user}->id, balance_owed => { '!=' => 0 } } );
 204
 205         $total += $_->balance_owed for @$xacts;
 206         syslog('LOG_INFO', "User ".$self->{user}->id." has a fee amount of \$$total");
 207         return $total;
 208 }
 209
 210 sub screen_msg {
 211         my $self = shift;
 212         my $u = $self->{user};
 213         return 'barred' if $u->barred eq 't';
 214
 215         my $b = 'blocked';
 216
 217         return $b if $u->active eq 'f';
 218         return $b if $u->card->active eq 'f';
 219
 220         if( $u->standing_penalties ) {
 221                 return $b if
 222                         grep { $_->penalty_type eq 'PATRON_EXCEEDS_OVERDUE_COUNT' }
 223                                 @{$u->standing_penalties};
 224
 225                 return $b if
 226                         grep { $_->penalty_type eq 'PATRON_EXCEEDS_FINES' }
 227                                 @{$u->standing_penalties};
 228         }
 229
 230         my $expire = DateTime::Format::ISO8601->new->parse_datetime(
 231                 clense_ISO8601($u->expire_date));
 232
 233         return $b if CORE::time > $expire->epoch;
 234
 235         return 'OK';
 236 }
 237
 238 sub print_line {
 239     my $self = shift;
 240         return '';
 241 }
 242
 243 sub too_many_charged {
 244     my $self = shift;
 245         return 0;
 246 }
 247
 248 sub too_many_overdue {
 249         my $self = shift;
 250         if( $self->{user}->standing_penalties ) {
 251                 return grep { $_->penalty_type eq 'PATRON_EXCEEDS_OVERDUE_COUNT' }
 252                         @{$self->{user}->standing_penalties};
 253         }
 254         return 0;
 255 }
 256
 257 # not completely sure what this means
 258 sub too_many_renewal {
 259     my $self = shift;
 260         return 0;
 261 }
 262
 263 # not relevant, handled by fines/fees
 264 sub too_many_claim_return {
 265     my $self = shift;
 266         return 0;
 267 }
 268
 269 # not relevant, handled by fines/fees
 270 sub too_many_lost {
 271     my $self = shift;
 272         return 0;
 273 }
 274
 275 sub excessive_fines {
 276     my $self = shift;
 277         syslog('LOG_DEBUG', 'OILS: Patron->excessive_fines()');
 278         if( $self->{user}->standing_penalties ) {
 279                 return grep { $_->penalty_type eq 'PATRON_EXCEEDS_FINES' }
 280                         @{$self->{user}->standing_penalties};
 281         }
 282         return 0;
 283 }
 284
 285
 286 # Until someone suggests otherwise, fees and fines are the same
 287
 288 sub excessive_fees {
 289         my $self = shift;
 290         syslog('LOG_DEBUG', 'OILS: Patron->excessive_fees()');
 291         if( $self->{user}->standing_penalties ) {
 292                 return grep { $_->penalty_type eq 'PATRON_EXCEEDS_FINES' }
 293                         @{$self->{user}->standing_penalties};
 294         }
 295         return 0;
 296 }
 297
 298 # not relevant, handled by fines/fees
 299 sub too_many_billed {
 300     my $self = shift;
 301         return 0;
 302 }
 303
 304
 305
 306 #
 307 # List of outstanding holds placed
 308 #
 309 sub hold_items {
 310     my ($self, $start, $end) = @_;
 311
 312          my $holds = $self->{editor}->search_action_hold_request(
 313                 { usr => $self->{user}->id, fulfillment_time => undef }
 314          );
 315
 316         my @holds;
 317         push( @holds, $self->__hold_to_title($_) ) for @$holds;
 318
 319         return (defined $start and defined $end) ?
 320                 [ $holds[($start-1)..($end-1)] ] :
 321                 \@holds;
 322 }
 323
 324 sub __hold_to_title {
 325         my $self = shift;
 326         my $hold = shift;
 327         my $e = $self->{editor};
 328
 329         my( $id, $mods, $title, $volume, $copy );
 330
 331         return __copy_to_title($e,
 332                 $e->retrieve_asset_copy($hold->target))
 333                 if $hold->hold_type eq 'C';
 334
 335         return __volume_to_title($e,
 336                 $e->retrieve_asset_call_number($hold->target))
 337                 if $hold->hold_type eq 'V';
 338
 339         return __record_to_title(
 340                 $e, $hold->target) if $hold->hold_type eq 'T';
 341
 342         return __metarecord_to_title(
 343                 $e, $hold->target) if $hold->hold_type eq 'M';
 344 }
 345
 346 sub __copy_to_title {
 347         my( $e, $copy ) = @_;
 348         #syslog('LOG_DEBUG', "OILS: copy_to_title(%s)", $copy->id);
 349         return $copy->dummy_title if $copy->call_number == -1;
 350         my $vol = $e->retrieve_asset_call_number($copy->call_number);
 351         return __volume_to_title($e, $vol);
 352 }
 353
 354
 355 sub __volume_to_title {
 356         my( $e, $volume ) = @_;
 357         #syslog('LOG_DEBUG', "OILS: volume_to_title(%s)", $volume->id);
 358         return __record_to_title($e, $volume->record);
 359 }
 360
 361
 362 sub __record_to_title {
 363         my( $e, $title_id ) = @_;
 364         #syslog('LOG_DEBUG', "OILS: record_to_title($title_id)");
 365         my $mods = $U->simplereq(
 366                 'open-ils.search',
 367                 'open-ils.search.biblio.record.mods_slim.retrieve', $title_id );
 368         return ($mods) ? $mods->title : "";
 369 }
 370
 371 sub __metarecord_to_title {
 372         my( $e, $m_id ) = @_;
 373         #syslog('LOG_DEBUG', "OILS: metarecord_to_title($m_id)");
 374         my $mods = $U->simplereq(
 375                 'open-ils.search',
 376                 'open-ils.search.biblio.metarecord.mods_slim.retrieve', $m_id);
 377         return ($U->event_code($mods)) ? "<unknown>" : $mods->title;
 378 }
 379
 380
 381 #
 382 # remove the hold on item item_id from my hold queue.
 383 # return true if I was holding the item, false otherwise.
 384 #
 385 sub drop_hold {
 386     my ($self, $item_id) = @_;
 387     return 0;
 388 }
 389
 390 sub __patron_items_info {
 391         my $self = shift;
 392         return if $self->{items_info};
 393         $self->{item_info} =
 394                 OpenILS::Application::Actor::_checked_out(
 395                         0, $self->{editor}, $self->{user}->id);;
 396 }
 397
 398 sub overdue_items {
 399         my ($self, $start, $end) = @_;
 400
 401         $self->__patron_items_info();
 402         my @overdues = @{$self->{item_info}->{overdue}};
 403         #$overdues[$_] = __circ_to_title($self->{editor}, $overdues[$_]) for @overdues;
 404
 405         my @o;
 406         syslog('LOG_DEBUG', "OILS: overdue_items() fleshing circs @overdues");
 407         for my $circid (@overdues) {
 408                 next unless $circid;
 409                 push( @o, __circ_to_title($self->{editor}, $circid) );
 410         }
 411         @overdues = @o;
 412
 413         return (defined $start and defined $end) ?
 414                 [ $overdues[($start-1)..($end-1)] ] : \@overdues;
 415 }
 416
 417 sub __circ_to_title {
 418         my( $e, $circ ) = @_;
 419         return unless $circ;
 420         $circ = $e->retrieve_action_circulation($circ);
 421         return __copy_to_title( $e,
 422                 $e->retrieve_asset_copy($circ->target_copy) );
 423 }
 424
 425 sub charged_items {
 426         my ($self, $start, $end) = shift;
 427
 428         $self->__patron_items_info();
 429
 430         my @charges = (
 431                 @{$self->{item_info}->{out}},
 432                 @{$self->{item_info}->{overdue}}
 433                 );
 434
 435         #$charges[$_] = __circ_to_title($self->{editor}, $charges[$_]) for @charges;
 436
 437         my @c;
 438         syslog('LOG_DEBUG', "OILS: charged_items() fleshing circs @charges");
 439         for my $circid (@charges) {
 440                 next unless $circid;
 441                 push( @c, __circ_to_title($self->{editor}, $circid) );
 442         }
 443         @charges = @c;
 444
 445         return (defined $start and defined $end) ?
 446                 [ $charges[($start-1)..($end-1)] ] :
 447                 \@charges;
 448 }
 449
 450 sub fine_items {
 451         my ($self, $start, $end) = @_;
 452         my @fines;
 453         syslog('LOG_DEBUG', 'OILS: Patron->fine_items()');
 454         return (defined $start and defined $end) ?
 455                 [ $fines[($start-1)..($end-1)] ] : \@fines;
 456 }
 457
 458 # not currently supported
 459 sub recall_items {
 460     my ($self, $start, $end) = @_;
 461          return [];
 462 }
 463
 464 sub unavail_holds {
 465         my ($self, $start, $end) = @_;
 466         my @holds;
 467         return (defined $start and defined $end) ?
 468                 [ $holds[($start-1)..($end-1)] ] : \@holds;
 469 }
 470
 471 sub block {
 472         my ($self, $card_retained, $blocked_card_msg) = @_;
 473
 474         my $u = $self->{user};
 475         my $e = $self->{editor} = OpenILS::SIP->reset_editor();
 476
 477         syslog('LOG_INFO', "OILS: Blocking user %s", $u->card->barcode );
 478
 479         return $self if $u->card->active eq 'f';
 480
 481         $u->card->active('f');
 482         if( ! $e->update_actor_card($u->card) ) {
 483                 syslog('LOG_ERR', "OILS: Block card update failed: %s", $e->event->{textcode});
 484                 $e->xact_rollback;
 485                 return $self;
 486         }
 487
 488         # retrieve the un-fleshed user object for update
 489         $u = $e->retrieve_actor_user($u->id);
 490         my $note = $u->alert_message || "";
 491         $note = "CARD BLOCKED BY SELF-CHECK MACHINE\n$note"; # XXX Config option
 492
 493         $u->alert_message($note);
 494
 495         if( ! $e->update_actor_user($u) ) {
 496                 syslog('LOG_ERR', "OILS: Block: patron alert update failed: %s", $e->event->{textcode});
 497                 $e->xact_rollback;
 498                 return $self;
 499         }
 500
 501         # stay in synch
 502         $self->{user}->alert_message( $note );
 503
 504         $e->commit; # commits and resets
 505         $self->{editor} = OpenILS::SIP->reset_editor();
 506         return $self;
 507 }
 508
 509 # Testing purposes only
 510 sub enable {
 511     my $self = shift;
 512          # Un-mark card as inactive, grep out the patron alert
 513     $self->{screen_msg} = "All privileges restored.";
 514     return $self;
 515 }
 516
 517 #
 518 # Messages
 519 #
 520
 521 sub invalid_patron {
 522     return "Please contact library staff";
 523 }
 524
 525 sub charge_denied {
 526     return "Please contact library staff";
 527 }
 528
 529 sub inet_privileges {
 530         my( $self ) = @_;
 531         my $e = OpenILS::SIP->editor();
 532         $INET_PRIVS = $e->retrieve_all_config_net_access_level() unless $INET_PRIVS;
 533         my ($level) = grep { $_->id eq $self->{user}->net_access_level } @$INET_PRIVS;
 534         my $name = $level->name;
 535         syslog('LOG_DEBUG', "OILS: Patron inet_privs = $name");
 536         return $name;
 537 }
 538
 539
 540 1;