3 # A Class for hiding the ILS's concept of the patron from the OpenSIP
7 package OpenILS::SIP::Patron;
13 use Sys::Syslog qw(syslog);
15 use Digest::MD5 qw(md5_hex);
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';
24 our (@ISA, @EXPORT_OK);
28 @EXPORT_OK = qw(invalid_patron);
33 my ($class, $patron_id) = @_;
34 my $type = ref($class) || $class;
37 syslog("LOG_DEBUG", "OILS: new OpenILS Patron(%s): searching...", $patron_id);
39 my $e = OpenILS::SIP->editor();
41 my $c = $e->search_actor_card({barcode => $patron_id}, {idlist=>1});
46 $user = $e->search_actor_user(
67 $user = (@$user) ? $$user[0] : undef;
71 syslog("LOG_WARNING", "OILS: Unable to find patron %s", $patron_id);
75 $self->{user} = $user;
76 $self->{id} = $patron_id;
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 );
94 my $u = $self->{user};
95 return $u->first_given_name . ' ' .
96 $u->second_given_name . ' ' . $u->family_name;
101 return "" unless $addr;
102 return $addr->street1 .' '.
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 #my $maddr = $u->mailing_address;
119 #$str .= "\n" . __addr_string($maddr)
120 #if $maddr and $maddr->id ne $addr->id;
126 return $self->{user}->email;
131 return $self->{user}->day_phone;
136 my $dob = $self->{user}->dob;
137 return "" unless $dob;
139 $dob = DateTime::Format::ISO8601->new->
140 parse_datetime(OpenSRF::Utils::clense_ISO8601($dob));
141 my @time = localtime($dob->epoch);
143 my $year = $time[5]+1900;
144 my $mon = $time[4]+1;
147 $mon =~ s/^(\d)$/0$1/;
148 $day =~ s/^(\d)$/0$1/;
149 $dob = "$year$mon$day";
151 syslog('LOG_DEBUG', "OILS: Patron DOB = $dob");
158 return $self->{user}->profile->name;
163 return '000'; # Unspecified
166 # How much more detail do we need to check here?
169 my $u = $self->{user};
170 return (($u->barred eq 'f') and ($u->card->active eq 't'));
173 # How much more detail do we need to check here?
176 return $self->charge_ok;
189 # return true if the card provided is marked as lost
202 my ($self, $pwd) = @_;
203 return md5_hex($pwd) eq $self->{user}->passwd;
227 sub too_many_charged {
232 sub too_many_overdue {
234 if( $self->{user}->standing_penalties ) {
235 return grep { $_->penalty_type eq 'PATRON_EXCEEDS_OVERDUE_COUNT' }
236 @{$self->{user}->standing_penalties};
241 # not completely sure what this means
242 sub too_many_renewal {
247 # not relevant, handled by fines/fees
248 sub too_many_claim_return {
253 # not relevant, handled by fines/fees
259 sub excessive_fines {
261 if( $self->{user}->standing_penalties ) {
262 return grep { $_->penalty_type eq 'PATRON_EXCEEDS_FINES' }
263 @{$self->{user}->standing_penalties};
269 # Until someone suggests otherwise, fees and fines are the same
273 if( $self->{user}->standing_penalties ) {
274 return grep { $_->penalty_type eq 'PATRON_EXCEEDS_FINES' }
275 @{$self->{user}->standing_penalties};
280 # not relevant, handled by fines/fees
281 sub too_many_billed {
289 # List of outstanding holds placed
292 my ($self, $start, $end) = @_;
294 my $holds = $self->{editor}->search_action_hold_request(
295 { usr => $self->{user}->id, fulfillment_time => undef }
299 push( @holds, $self->__hold_to_title($_) ) for @$holds;
301 return (defined $start and defined $end) ?
302 [ $holds[($start-1)..($end-1)] ] :
306 sub __hold_to_title {
309 my $e = $self->{editor};
311 my( $id, $mods, $title, $volume, $copy );
313 return __copy_to_title($e,
314 $e->retrieve_asset_copy($hold->target))
315 if $hold->hold_type eq 'C';
317 return __volume_to_title($e,
318 $e->retrieve_asset_call_number($hold->target))
319 if $hold->hold_type eq 'V';
321 return __record_to_title(
322 $e, $hold->target) if $hold->hold_type eq 'T';
324 return __metarecord_to_title(
325 $e, $hold->target) if $hold->hold_type eq 'M';
328 sub __copy_to_title {
329 my( $e, $copy ) = @_;
330 syslog('LOG_DEBUG', "OILS: copy_to_title(%s)", $copy->id);
331 return $copy->dummy_title if $copy->call_number == -1;
332 my $vol = $e->retrieve_asset_call_number($copy->call_number);
333 return __volume_to_title($e, $vol);
337 sub __volume_to_title {
338 my( $e, $volume ) = @_;
339 syslog('LOG_DEBUG', "OILS: volume_to_title(%s)", $volume->id);
340 return __record_to_title($e, $volume->record);
344 sub __record_to_title {
345 my( $e, $title_id ) = @_;
346 syslog('LOG_DEBUG', "OILS: record_to_title($title_id)");
347 my $mods = $U->simplereq(
349 'open-ils.search.biblio.record.mods_slim.retrieve', $title_id );
350 return ($mods) ? $mods->title : "";
353 sub __metarecord_to_title {
354 my( $e, $m_id ) = @_;
355 syslog('LOG_DEBUG', "OILS: metarecord_to_title($m_id)");
356 my $mods = $U->simplereq(
358 'open-ils.search.biblio.metarecord.mods_slim.retrieve', $m_id);
359 return ($U->event_code($mods)) ? "<unknown>" : $mods->title;
364 # remove the hold on item item_id from my hold queue.
365 # return true if I was holding the item, false otherwise.
368 my ($self, $item_id) = @_;
372 sub __patron_items_info {
374 return if $self->{items_info};
376 OpenILS::Application::Actor::_checked_out(
377 0, $self->{editor}, $self->{user}->id);;
381 my ($self, $start, $end) = @_;
383 $self->__patron_items_info();
384 my @overdues = @{$self->{item_info}->{overdue}};
385 #$overdues[$_] = __circ_to_title($self->{editor}, $overdues[$_]) for @overdues;
388 for my $circid (@overdues) {
390 syslog('LOG_DEBUG', "OILS: overdue_items() fleshing circ $circid");
391 push( @o, __circ_to_title($self->{editor}, $circid) );
395 return (defined $start and defined $end) ?
396 [ $overdues[($start-1)..($end-1)] ] : \@overdues;
399 sub __circ_to_title {
400 my( $e, $circ ) = @_;
402 $circ = $e->retrieve_action_circulation($circ);
403 return __copy_to_title( $e,
404 $e->retrieve_asset_copy($circ->target_copy) );
408 my ($self, $start, $end) = shift;
410 $self->__patron_items_info();
413 @{$self->{item_info}->{out}},
414 @{$self->{item_info}->{overdue}}
417 #$charges[$_] = __circ_to_title($self->{editor}, $charges[$_]) for @charges;
420 for my $circid (@charges) {
422 syslog('LOG_DEBUG', "OILS: charged_items() fleshing circ $circid");
423 push( @c, __circ_to_title($self->{editor}, $circid) );
427 return (defined $start and defined $end) ?
428 [ $charges[($start-1)..($end-1)] ] :
433 my ($self, $start, $end) = @_;
435 return (defined $start and defined $end) ?
436 [ $fines[($start-1)..($end-1)] ] : \@fines;
439 # not currently supported
441 my ($self, $start, $end) = @_;
446 my ($self, $start, $end) = @_;
448 return (defined $start and defined $end) ?
449 [ $holds[($start-1)..($end-1)] ] : \@holds;
453 my ($self, $card_retained, $blocked_card_msg) = @_;
455 my $u = $self->{user};
456 my $e = $self->{editor} = OpenILS::SIP->reset_editor();
458 syslog('LOG_INFO', "OILS: Blocking user %s", $u->card->barcode );
460 return $self if $u->card->active eq 'f';
462 $u->card->active('f');
463 if( ! $e->update_actor_card($u->card) ) {
464 syslog('LOG_ERR', "OILS: Block card update failed: %s", $e->event->{textcode});
469 # retrieve the un-fleshed user object for update
470 $u = $e->retrieve_actor_user($u->id);
471 my $note = $u->alert_message || "";
472 $note = "CARD BLOCKED BY SELF-CHECK MACHINE\n$note"; # XXX Config option
474 $u->alert_message($note);
476 if( ! $e->update_actor_user($u) ) {
477 syslog('LOG_ERR', "OILS: Block: patron alert update failed: %s", $e->event->{textcode});
483 $self->{user}->alert_message( $note );
485 $e->commit; # commits and resets
486 $self->{editor} = OpenILS::SIP->reset_editor();
490 # Testing purposes only
493 # Un-mark card as inactive, grep out the patron alert
494 $self->{screen_msg} = "All privileges restored.";
503 return "Please contact library staff";
507 return "Please contact library staff";
510 sub inet_privileges {
512 my $e = OpenILS::SIP->editor();
513 $INET_PRIVS = $e->retrieve_all_config_net_access_level() unless $INET_PRIVS;
514 my ($level) = grep { $_->id eq $self->{user}->net_access_level } @$INET_PRIVS;
515 my $name = $level->name;
516 syslog('LOG_DEBUG', "OILS: Patron inet_privs = $name");