4 # A Class for hiding the ILS's concept of the patron from the OpenSIP
8 package C4::SIP::ILS::Patron;
15 use Sys::Syslog qw(syslog);
18 use C4::SIP::Sip qw(add_field);
25 use C4::Auth qw(checkpw);
31 our $kp; # koha patron
38 my ($class, $patron_id) = @_;
39 my $type = ref($class) || $class;
41 my $patron = Koha::Patrons->find( { cardnumber => $patron_id } )
42 || Koha::Patrons->find( { userid => $patron_id } );
43 $debug and warn "new Patron: " . Dumper($patron->unblessed) if $patron;
45 syslog("LOG_DEBUG", "new ILS::Patron(%s): no such patron", $patron_id);
48 $kp = $patron->unblessed;
49 my $pw = $kp->{password};
50 my $flags = C4::Members::patronflags( $kp );
51 my $debarred = $patron->is_debarred;
52 $debug and warn sprintf("Debarred = %s : ", ($debarred||'undef')); # Do we need more debug info here?
53 my ($day, $month, $year) = (localtime)[3,4,5];
54 my $today = sprintf '%04d-%02d-%02d', $year+1900, $month+1, $day;
55 my $expired = ($today gt $kp->{dateexpiry}) ? 1 : 0;
57 if ($kp->{opacnote} ) {
58 $kp->{opacnote} .= q{ };
60 $kp->{opacnote} .= 'PATRON EXPIRED';
63 my $adr = _get_address($kp);
64 my $dob = $kp->{dateofbirth};
65 $dob and $dob =~ s/-//g; # YYYYMMDD
66 my $dexpiry = $kp->{dateexpiry};
67 $dexpiry and $dexpiry =~ s/-//g; # YYYYMMDD
69 # Get fines and add fines for guarantees (depends on preference NoIssuesChargeGuarantees)
70 my $fines_amount = $flags->{CHARGES}->{amount};
71 $fines_amount = ($fines_amount and $fines_amount > 0) ? $fines_amount : 0;
72 my $guarantees_fines_amount = $flags->{CHARGES_GUARANTEES} ? $flags->{CHARGES_GUARANTEES}->{amount} : 0;
73 $fines_amount += $guarantees_fines_amount;
75 my $fee_limit = _fee_limit();
76 my $fine_blocked = $fines_amount > $fee_limit;
77 my $circ_blocked =( C4::Context->preference('OverduesBlockCirc') ne "noblock" && defined $flags->{ODUES}->{itemlist} ) ? 1 : 0;
79 no warnings; # any of these $kp->{fields} being concat'd could be undef
81 name => $kp->{firstname} . " " . $kp->{surname},
82 id => $kp->{cardnumber}, # to SIP, the id is the BARCODE, not userid
84 ptype => $kp->{categorycode}, # 'A'dult. Whatever.
85 dateexpiry => $dexpiry,
86 dateexpiry_iso => $kp->{dateexpiry},
88 birthdate_iso => $kp->{dateofbirth},
89 branchcode => $kp->{branchcode},
90 library_name => "", # only populated if needed, cached here
91 borrowernumber => $kp->{borrowernumber},
93 home_phone => $kp->{phone},
94 email_addr => $kp->{email},
95 charge_ok => ( !$debarred && !$expired && !$fine_blocked && !$circ_blocked),
96 renew_ok => ( !$debarred && !$expired && !$fine_blocked),
97 recall_ok => ( !$debarred && !$expired && !$fine_blocked),
98 hold_ok => ( !$debarred && !$expired && !$fine_blocked),
99 card_lost => ( $kp->{lost} || $kp->{gonenoaddress} || $flags->{LOST} ),
100 claims_returned => 0,
101 fines => $fines_amount,
102 fees => 0, # currently not distinct from fines
105 screen_msg => 'Greetings from Koha. ' . $kp->{opacnote},
108 hold_items => $flags->{WAITING}->{itemlist},
109 overdue_items => $flags->{ODUES}->{itemlist},
110 too_many_overdue => $circ_blocked,
114 inet => ( !$debarred && !$expired ),
116 fee_limit => $fee_limit,
117 userid => $kp->{userid},
120 $debug and warn "patron fines: $ilspatron{fines} ... amountoutstanding: $kp->{amountoutstanding} ... CHARGES->amount: $flags->{CHARGES}->{amount}";
122 if ( $patron->is_debarred and $patron->debarredcomment ) {
123 $ilspatron{screen_msg} .= " -- " . $patron->debarredcomment;
125 if ( $circ_blocked ) {
126 $ilspatron{screen_msg} .= " -- " . "Patron has overdues";
128 for (qw(EXPIRED CHARGES CREDITS GNA LOST NOTES)) {
129 ($flags->{$_}) or next;
130 if ($_ ne 'NOTES' and $flags->{$_}->{message}) {
131 $ilspatron{screen_msg} .= " -- " . $flags->{$_}->{message}; # show all but internal NOTES
133 if ($flags->{$_}->{noissues}) {
134 foreach my $toggle (qw(charge_ok renew_ok recall_ok hold_ok inet)) {
135 $ilspatron{$toggle} = 0; # if we get noissues, disable everything
140 # FIXME: populate fine_items recall_items
141 $ilspatron{unavail_holds} = _get_outstanding_holds($kp->{borrowernumber});
143 my $pending_checkouts = $patron->pending_checkouts;
145 while ( my $c = $pending_checkouts->next ) {
146 push @barcodes, { barcode => $c->item->barcode };
148 $ilspatron{items} = \@barcodes;
151 $debug and warn Dumper($self);
152 syslog("LOG_DEBUG", "new ILS::Patron(%s): found patron '%s'", $patron_id,$self->{id});
172 charge_ok => 0, # for patron_status[0] (inverted)
173 renew_ok => 0, # for patron_status[1] (inverted)
174 recall_ok => 0, # for patron_status[2] (inverted)
175 hold_ok => 0, # for patron_status[3] (inverted)
176 card_lost => 0, # for patron_status[4]
182 too_many_charged => 0, # for patron_status[5]
183 too_many_overdue => 0, # for patron_status[6]
184 too_many_renewal => 0, # for patron_status[7]
185 too_many_claim_return => 0, # for patron_status[8]
186 too_many_lost => 0, # for patron_status[9]
187 # excessive_fines => 0, # for patron_status[10]
188 # excessive_fees => 0, # for patron_status[11]
189 recall_overdue => 0, # for patron_status[12]
190 too_many_billed => 0, # for patron_status[13]
191 inet => 0, # EnvisionWare extension
197 # be cool. needed for AUTOLOAD(?)
202 my $class = ref($self) or croak "$self is not an object";
203 my $name = $AUTOLOAD;
207 unless (exists $fields{$name}) {
208 croak "Cannot access '$name' field of class '$class'";
212 $fields{$name} or croak "Field '$name' of class '$class' is READ ONLY.";
213 return $self->{$name} = shift;
215 return $self->{$name};
220 my ( $self, $template ) = @_;
224 require Koha::Patrons;
226 my $tt = Template->new();
228 my $patron = Koha::Patrons->find( $self->{borrowernumber} );
231 $tt->process( \$template, { patron => $patron }, \$output );
235 return $self->{name};
240 my ( $self, $pwd ) = @_;
242 # you gotta give me something (at least ''), or no deal
243 return 0 unless defined $pwd;
245 # If the record has a NULL password, accept '' as match
246 return $pwd eq q{} unless $self->{password};
248 my $dbh = C4::Context->dbh;
250 ($ret) = checkpw( $dbh, $self->{userid}, $pwd, undef, undef, 1 ); # dbh, userid, query, type, no_set_userenv
254 # A few special cases, not in AUTOLOADed %fields
257 if ( $self->{fines} ) {
258 return $self->{fines};
265 return $self->fee_amount;
270 return $self->{language} || '000'; # Unspecified
275 return $self->{expired};
279 # remove the hold on item item_id from my hold queue.
280 # return true if I was holding the item, false otherwise.
283 my ($self, $item_id) = @_;
286 foreach (qw(hold_items unavail_holds)) {
288 for (my $i = 0; $i < scalar @{$self->{$_}}; $i++) {
289 my $held_item = $self->{$_}[$i]->{item_id} or next;
290 if ($held_item eq $item_id) {
291 splice @{$self->{$_}}, $i, 1;
299 # Accessor method for array_ref values, designed to get the "start" and "end" values
300 # from the SIP request. Note those incoming values are 1-indexed, not 0-indexed.
304 my $array_var = shift or return;
305 my ($start, $end) = @_;
308 if ($self->{$array_var}) {
309 if ($start && $start > 1) {
315 if ( $end && $end < @{$self->{$array_var}} ) {
318 $end = @{$self->{$array_var}};
321 @{$item_list} = @{$self->{$array_var}}[ $start .. $end ];
328 # List of outstanding holds placed
332 my $item_arr = $self->x_items('hold_items', @_);
333 foreach my $item (@{$item_arr}) {
334 my $item_obj = Koha::Items->find($item->{itemnumber});
335 $item->{barcode} = $item_obj ? $item_obj->barcode : undef;
342 return $self->x_items('overdue_items', @_);
346 return $self->x_items('items', @_);
349 require Koha::Database;
357 my @fees = Koha::Database->new()->schema()->resultset('Accountline')->search(
359 borrowernumber => $self->{borrowernumber},
360 amountoutstanding => { '>' => '0' },
364 $start = $start ? $start - 1 : 0;
365 $end = $end ? $end : scalar @fees - 1;
367 my $av_field_template = $server ? $server->{account}->{av_field_template} : undef;
368 $av_field_template ||= "[% accountline.description %] [% accountline.amountoutstanding | format('%.2f') %]";
370 my $tt = Template->new();
373 for ( my $i = $start; $i <= $end; $i++ ) {
377 $tt->process( \$av_field_template, { accountline => $fee }, \$output );
378 push( @return_values, { barcode => $output } );
381 return \@return_values;
385 return $self->x_items('recall_items', @_);
389 return $self->x_items('unavail_holds', @_);
393 my ($self, $card_retained, $blocked_card_msg) = @_;
394 foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
397 $self->{screen_msg} = "Block feature not implemented"; # $blocked_card_msg || "Card Blocked. Please contact library staff";
398 # TODO: not really affecting patron record
404 foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
407 syslog("LOG_DEBUG", "Patron(%s)->enable: charge: %s, renew:%s, recall:%s, hold:%s",
408 $self->{id}, $self->{charge_ok}, $self->{renew_ok},
409 $self->{recall_ok}, $self->{hold_ok});
410 $self->{screen_msg} = "Enable feature not implemented."; # "All privileges restored."; # TODO: not really affecting patron record
414 sub inet_privileges {
416 return $self->{inet} ? 'Y' : 'N';
420 return C4::Context->preference('noissuescharge') || 5;
425 return ($self->fee_amount and $self->fee_amount > $self->fee_limit);
428 sub excessive_fines {
430 return $self->excessive_fees; # excessive_fines is the same thing as excessive_fees for Koha
433 sub holds_blocked_by_excessive_fees {
435 return ( $self->fee_amount
436 && $self->fee_amount > C4::Context->preference("maxoutstanding") );
441 unless ($self->{library_name}) {
442 my $library = Koha::Libraries->find( $self->{branchcode} );
443 $self->{library_name} = $library ? $library->branchname : '';
445 return $self->{library_name};
453 return "Please contact library staff";
458 return "Please contact library staff";
461 =head2 update_lastseen
463 $patron->update_lastseen();
465 Patron method to update lastseen field in borrower
466 to record that patron has been seen via sip connection
470 sub update_lastseen {
472 my $kohaobj = Koha::Patrons->find( $self->{borrowernumber} );
473 $kohaobj->track_login if $kohaobj; # track_login checks the pref
479 my $address = $patron->{streetnumber} || q{};
480 for my $field (qw( roaddetails address address2 city state zipcode country))
482 next unless $patron->{$field};
485 $address .= $patron->{$field};
488 $address .= $patron->{$field};
494 sub _get_outstanding_holds {
495 my $borrowernumber = shift;
497 my $patron = Koha::Patrons->find( $borrowernumber );
498 my $holds = $patron->holds->search( { -or => [ { found => undef }, { found => { '!=' => 'W' } } ] } );
500 while ( my $hold = $holds->next ) {
502 if ($hold->itemnumber) {
506 # We need to return a barcode for the biblio so the client
507 # can request the biblio info
508 my $items = $hold->biblio->items;
509 $item = $items->count ? $items->next : undef;
511 my $unblessed_hold = $hold->unblessed;
513 $unblessed_hold->{barcode} = $item ? $item->barcode : undef;
515 push @holds, $unblessed_hold;
520 =head2 build_patron_attributes_string
522 This method builds the part of the sip message for extended patron
523 attributes as defined in the sip config
527 sub build_patron_attributes_string {
528 my ( $self, $server ) = @_;
532 if ( $server->{account}->{patron_attribute} ) {
533 my @attributes_to_send =
534 ref $server->{account}->{patron_attribute} eq "ARRAY"
535 ? @{ $server->{account}->{patron_attribute} }
536 : ( $server->{account}->{patron_attribute} );
538 foreach my $a ( @attributes_to_send ) {
539 my @attributes = Koha::Patron::Attributes->search(
541 borrowernumber => $self->{borrowernumber},
546 foreach my $attribute ( @attributes ) {
547 my $value = $attribute->attribute();
548 $string .= add_field( $a->{field}, $value );
561 our %patron_example = (
563 name => "David J. Fiander",
566 ptype => 'A', # 'A'dult. Whatever.
567 birthdate => '19640925',
568 address => '2 Meadowvale Dr. St Thomas, ON',
569 home_phone => '(519) 555 1234',
570 email_addr => 'djfiander@hotmail.com',
576 claims_returned => 0,
586 fine_items => ['Computer Time'],
593 From borrowers table:
594 +---------------------+--------------+------+-----+---------+----------------+
595 | Field | Type | Null | Key | Default | Extra |
596 +---------------------+--------------+------+-----+---------+----------------+
597 | borrowernumber | int(11) | NO | PRI | NULL | auto_increment |
598 | cardnumber | varchar(16) | YES | UNI | NULL | |
599 | surname | mediumtext | NO | | NULL | |
600 | firstname | text | YES | | NULL | |
601 | title | mediumtext | YES | | NULL | |
602 | othernames | mediumtext | YES | | NULL | |
603 | initials | text | YES | | NULL | |
604 | streetnumber | varchar(10) | YES | | NULL | |
605 | streettype | varchar(50) | YES | | NULL | |
606 | address | mediumtext | NO | | NULL | |
607 | address2 | text | YES | | NULL | |
608 | city | mediumtext | NO | | NULL | |
609 | state | mediumtext | YES | | NULL | |
610 | zipcode | varchar(25) | YES | | NULL | |
611 | country | text | YES | | NULL | |
612 | email | mediumtext | YES | | NULL | |
613 | phone | text | YES | | NULL | |
614 | mobile | varchar(50) | YES | | NULL | |
615 | fax | mediumtext | YES | | NULL | |
616 | emailpro | text | YES | | NULL | |
617 | phonepro | text | YES | | NULL | |
618 | B_streetnumber | varchar(10) | YES | | NULL | |
619 | B_streettype | varchar(50) | YES | | NULL | |
620 | B_address | varchar(100) | YES | | NULL | |
621 | B_address2 | text | YES | | NULL | |
622 | B_city | mediumtext | YES | | NULL | |
623 | B_state | mediumtext | YES | | NULL | |
624 | B_zipcode | varchar(25) | YES | | NULL | |
625 | B_country | text | YES | | NULL | |
626 | B_email | text | YES | | NULL | |
627 | B_phone | mediumtext | YES | | NULL | |
628 | dateofbirth | date | YES | | NULL | |
629 | branchcode | varchar(10) | NO | MUL | | |
630 | categorycode | varchar(10) | NO | MUL | | |
631 | dateenrolled | date | YES | | NULL | |
632 | dateexpiry | date | YES | | NULL | |
633 | gonenoaddress | tinyint(1) | YES | | NULL | |
634 | lost | tinyint(1) | YES | | NULL | |
635 | debarred | tinyint(1) | YES | | NULL | |
636 | contactname | mediumtext | YES | | NULL | |
637 | contactfirstname | text | YES | | NULL | |
638 | contacttitle | text | YES | | NULL | |
639 | borrowernotes | mediumtext | YES | | NULL | |
640 | relationship | varchar(100) | YES | | NULL | |
641 | ethnicity | varchar(50) | YES | | NULL | |
642 | ethnotes | varchar(255) | YES | | NULL | |
643 | sex | varchar(1) | YES | | NULL | |
644 | password | varchar(30) | YES | | NULL | |
645 | flags | int(11) | YES | | NULL | |
646 | userid | varchar(30) | YES | MUL | NULL | |
647 | opacnote | mediumtext | YES | | NULL | |
648 | contactnote | varchar(255) | YES | | NULL | |
649 | sort1 | varchar(80) | YES | | NULL | |
650 | sort2 | varchar(80) | YES | | NULL | |
651 | altcontactfirstname | varchar(255) | YES | | NULL | |
652 | altcontactsurname | varchar(255) | YES | | NULL | |
653 | altcontactaddress1 | varchar(255) | YES | | NULL | |
654 | altcontactaddress2 | varchar(255) | YES | | NULL | |
655 | altcontactaddress3 | varchar(255) | YES | | NULL | |
656 | altcontactstate | mediumtext | YES | | NULL | |
657 | altcontactzipcode | varchar(50) | YES | | NULL | |
658 | altcontactcountry | text | YES | | NULL | |
659 | altcontactphone | varchar(50) | YES | | NULL | |
660 | smsalertnumber | varchar(50) | YES | | NULL | |
661 | privacy | int(11) | NO | | 1 | |
662 +---------------------+--------------+------+-----+---------+----------------+
669 {message} Message showing patron's credit or debt
670 {noissues} Set if patron owes >$5.00
671 {GNA} Set if patron gone w/o address
672 {message} "Borrower has no valid address"
674 {LOST} Set if patron's card reported lost
675 {message} Message to this effect
677 {DBARRED} Set if patron is debarred
678 {message} Message to this effect
680 {NOTES} Set if patron has notes
681 {message} Notes about patron
682 {ODUES} Set if patron has overdue books
684 {itemlist} ref-to-array: list of overdue books
685 {itemlisttext} Text list of overdue items
686 {WAITING} Set if there are items available that the patron reserved
687 {message} Message to this effect
688 {itemlist} ref-to-array: list of available items