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::Items qw( GetBarcodeFromItemnumber GetItemnumbersForBiblio);
26 use C4::Auth qw(checkpw);
31 our $kp; # koha patron
34 my ($class, $patron_id) = @_;
35 my $type = ref($class) || $class;
37 $kp = Koha::Patrons->find( { cardnumber => $patron_id } )
38 || Koha::Patrons->find( { userid => $patron_id } );
39 $debug and warn "new Patron: " . Dumper($kp->unblessed) if $kp;
41 syslog("LOG_DEBUG", "new ILS::Patron(%s): no such patron", $patron_id);
45 my $pw = $kp->{password};
46 my $flags = C4::Members::patronflags( $kp );
47 my $debarred = defined($flags->{DBARRED});
48 $debug and warn sprintf("Debarred = %s : ", ($debarred||'undef')) . Dumper(%$flags);
49 my ($day, $month, $year) = (localtime)[3,4,5];
50 my $today = sprintf '%04d-%02d-%02d', $year+1900, $month+1, $day;
51 my $expired = ($today gt $kp->{dateexpiry}) ? 1 : 0;
53 if ($kp->{opacnote} ) {
54 $kp->{opacnote} .= q{ };
56 $kp->{opacnote} .= 'PATRON EXPIRED';
59 my $adr = _get_address($kp);
60 my $dob = $kp->{dateofbirth};
61 $dob and $dob =~ s/-//g; # YYYYMMDD
62 my $dexpiry = $kp->{dateexpiry};
63 $dexpiry and $dexpiry =~ s/-//g; # YYYYMMDD
64 my $fines_amount = $flags->{CHARGES}->{amount};
65 $fines_amount = ($fines_amount and $fines_amount > 0) ? $fines_amount : 0;
66 my $fee_limit = _fee_limit();
67 my $fine_blocked = $fines_amount > $fee_limit;
68 my $circ_blocked =( C4::Context->preference('OverduesBlockCirc') ne "noblock" && defined $flags->{ODUES}->{itemlist} ) ? 1 : 0;
70 no warnings; # any of these $kp->{fields} being concat'd could be undef
72 name => $kp->{firstname} . " " . $kp->{surname},
73 id => $kp->{cardnumber}, # to SIP, the id is the BARCODE, not userid
75 ptype => $kp->{categorycode}, # 'A'dult. Whatever.
76 dateexpiry => $dexpiry,
77 dateexpiry_iso => $kp->{dateexpiry},
79 birthdate_iso => $kp->{dateofbirth},
80 branchcode => $kp->{branchcode},
81 library_name => "", # only populated if needed, cached here
82 borrowernumber => $kp->{borrowernumber},
84 home_phone => $kp->{phone},
85 email_addr => $kp->{email},
86 charge_ok => ( !$debarred && !$expired && !$fine_blocked && !$circ_blocked),
87 renew_ok => ( !$debarred && !$expired && !$fine_blocked),
88 recall_ok => ( !$debarred && !$expired && !$fine_blocked),
89 hold_ok => ( !$debarred && !$expired && !$fine_blocked),
90 card_lost => ( $kp->{lost} || $kp->{gonenoaddress} || $flags->{LOST} ),
92 fines => $fines_amount,
93 fees => 0, # currently not distinct from fines
96 screen_msg => 'Greetings from Koha. ' . $kp->{opacnote},
99 hold_items => $flags->{WAITING}->{itemlist},
100 overdue_items => $flags->{ODUES}->{itemlist},
104 inet => ( !$debarred && !$expired ),
106 fee_limit => $fee_limit,
107 userid => $kp->{userid},
110 $debug and warn "patron fines: $ilspatron{fines} ... amountoutstanding: $kp->{amountoutstanding} ... CHARGES->amount: $flags->{CHARGES}->{amount}";
111 for (qw(EXPIRED CHARGES CREDITS GNA LOST DBARRED NOTES)) {
112 ($flags->{$_}) or next;
113 if ($_ ne 'NOTES' and $flags->{$_}->{message}) {
114 $ilspatron{screen_msg} .= " -- " . $flags->{$_}->{message}; # show all but internal NOTES
116 if ($flags->{$_}->{noissues}) {
117 foreach my $toggle (qw(charge_ok renew_ok recall_ok hold_ok inet)) {
118 $ilspatron{$toggle} = 0; # if we get noissues, disable everything
123 # FIXME: populate fine_items recall_items
124 $ilspatron{unavail_holds} = _get_outstanding_holds($kp->{borrowernumber});
125 $ilspatron{items} = GetPendingIssues($kp->{borrowernumber});
127 $debug and warn Dumper($self);
128 syslog("LOG_DEBUG", "new ILS::Patron(%s): found patron '%s'", $patron_id,$self->{id});
148 charge_ok => 0, # for patron_status[0] (inverted)
149 renew_ok => 0, # for patron_status[1] (inverted)
150 recall_ok => 0, # for patron_status[2] (inverted)
151 hold_ok => 0, # for patron_status[3] (inverted)
152 card_lost => 0, # for patron_status[4]
158 too_many_charged => 0, # for patron_status[5]
159 too_many_overdue => 0, # for patron_status[6]
160 too_many_renewal => 0, # for patron_status[7]
161 too_many_claim_return => 0, # for patron_status[8]
162 too_many_lost => 0, # for patron_status[9]
163 # excessive_fines => 0, # for patron_status[10]
164 # excessive_fees => 0, # for patron_status[11]
165 recall_overdue => 0, # for patron_status[12]
166 too_many_billed => 0, # for patron_status[13]
167 inet => 0, # EnvisionWare extension
173 # be cool. needed for AUTOLOAD(?)
178 my $class = ref($self) or croak "$self is not an object";
179 my $name = $AUTOLOAD;
183 unless (exists $fields{$name}) {
184 croak "Cannot access '$name' field of class '$class'";
188 $fields{$name} or croak "Field '$name' of class '$class' is READ ONLY.";
189 return $self->{$name} = shift;
191 return $self->{$name};
196 my ( $self, $template ) = @_;
200 require Koha::Patrons;
202 my $tt = Template->new();
204 my $patron = Koha::Patrons->find( $self->{borrowernumber} );
207 $tt->process( \$template, { patron => $patron }, \$output );
211 return $self->{name};
216 my ( $self, $pwd ) = @_;
218 # you gotta give me something (at least ''), or no deal
219 return 0 unless defined $pwd;
221 # If the record has a NULL password, accept '' as match
222 return $pwd eq q{} unless $self->{password};
224 my $dbh = C4::Context->dbh;
226 ($ret) = checkpw( $dbh, $self->{userid}, $pwd, undef, undef, 1 ); # dbh, userid, query, type, no_set_userenv
230 # A few special cases, not in AUTOLOADed %fields
233 if ( $self->{fines} ) {
234 return $self->{fines};
241 return $self->fee_amount;
246 return $self->{language} || '000'; # Unspecified
251 return $self->{expired};
255 # remove the hold on item item_id from my hold queue.
256 # return true if I was holding the item, false otherwise.
259 my ($self, $item_id) = @_;
262 foreach (qw(hold_items unavail_holds)) {
264 for (my $i = 0; $i < scalar @{$self->{$_}}; $i++) {
265 my $held_item = $self->{$_}[$i]->{item_id} or next;
266 if ($held_item eq $item_id) {
267 splice @{$self->{$_}}, $i, 1;
275 # Accessor method for array_ref values, designed to get the "start" and "end" values
276 # from the SIP request. Note those incoming values are 1-indexed, not 0-indexed.
280 my $array_var = shift or return;
281 my ($start, $end) = @_;
284 if ($self->{$array_var}) {
285 if ($start && $start > 1) {
291 if ( $end && $end < @{$self->{$array_var}} ) {
294 $end = @{$self->{$array_var}};
297 @{$item_list} = @{$self->{$array_var}}[ $start .. $end ];
304 # List of outstanding holds placed
308 my $item_arr = $self->x_items('hold_items', @_);
309 foreach my $item (@{$item_arr}) {
310 $item->{barcode} = GetBarcodeFromItemnumber($item->{itemnumber});
317 return $self->x_items('overdue_items', @_);
321 return $self->x_items('items', @_);
324 require Koha::Database;
332 my @fees = Koha::Database->new()->schema()->resultset('Accountline')->search(
334 borrowernumber => $self->{borrowernumber},
335 amountoutstanding => { '>' => '0' },
339 $start = $start ? $start - 1 : 0;
340 $end = $end ? $end : scalar @fees - 1;
342 my $av_field_template = $server ? $server->{account}->{av_field_template} : undef;
343 $av_field_template ||= "[% accountline.description %] [% accountline.amountoutstanding | format('%.2f') %]";
345 my $tt = Template->new();
348 for ( my $i = $start; $i <= $end; $i++ ) {
352 $tt->process( \$av_field_template, { accountline => $fee }, \$output );
353 push( @return_values, { barcode => $output } );
356 return \@return_values;
360 return $self->x_items('recall_items', @_);
364 return $self->x_items('unavail_holds', @_);
368 my ($self, $card_retained, $blocked_card_msg) = @_;
369 foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
372 $self->{screen_msg} = "Block feature not implemented"; # $blocked_card_msg || "Card Blocked. Please contact library staff";
373 # TODO: not really affecting patron record
379 foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
382 syslog("LOG_DEBUG", "Patron(%s)->enable: charge: %s, renew:%s, recall:%s, hold:%s",
383 $self->{id}, $self->{charge_ok}, $self->{renew_ok},
384 $self->{recall_ok}, $self->{hold_ok});
385 $self->{screen_msg} = "Enable feature not implemented."; # "All privileges restored."; # TODO: not really affecting patron record
389 sub inet_privileges {
391 return $self->{inet} ? 'Y' : 'N';
395 return C4::Context->preference('noissuescharge') || 5;
400 return ($self->fee_amount and $self->fee_amount > $self->fee_limit);
403 sub excessive_fines {
405 return $self->excessive_fees; # excessive_fines is the same thing as excessive_fees for Koha
408 sub holds_blocked_by_excessive_fees {
410 return ( $self->fee_amount
411 && $self->fee_amount > C4::Context->preference("maxoutstanding") );
416 unless ($self->{library_name}) {
417 my $library = Koha::Libraries->find( $self->{branchcode} );
418 $self->{library_name} = $library ? $library->branchname : '';
420 return $self->{library_name};
428 return "Please contact library staff";
433 return "Please contact library staff";
439 my $address = $patron->{streetnumber} || q{};
440 for my $field (qw( roaddetails address address2 city state zipcode country))
442 next unless $patron->{$field};
445 $address .= $patron->{$field};
448 $address .= $patron->{$field};
454 sub _get_outstanding_holds {
455 my $borrowernumber = shift;
457 my $patron = Koha::Patrons->find( $borrowernumber );
458 my $holds = $patron->holds->search( { -or => [ { found => undef }, { found => { '!=' => 'W' } } ] } );
460 while ( my $hold = $holds->next ) {
462 if ($hold->itemnumber) {
463 $item = $hold->itemnumber;
466 # We need to return a barcode for the biblio so the client
467 # can request the biblio info
468 $item = ( GetItemnumbersForBiblio($hold->biblionumber) )->[0];
470 my $unblessed_hold = $hold->unblessed;
471 $unblessed_hold->{barcode} = GetBarcodeFromItemnumber($item);
472 push @holds, $unblessed_hold;
477 sub build_patron_attributes_string {
478 my ( $self, $server ) = @_;
482 if ( $server->{account}->{patron_attribute} ) {
483 my @attributes_to_send =
484 ref $server->{account}->{patron_attribute} eq "ARRAY"
485 ? @{ $server->{account}->{patron_attribute} }
486 : ( $server->{account}->{patron_attribute} );
488 foreach my $a ( @attributes_to_send ) {
489 my @attributes = Koha::Patron::Attributes->search(
491 borrowernumber => $self->{borrowernumber},
496 foreach my $attribute ( @attributes ) {
497 my $value = $attribute->attribute();
498 $string .= add_field( $a->{field}, $value );
511 our %patron_example = (
513 name => "David J. Fiander",
516 ptype => 'A', # 'A'dult. Whatever.
517 birthdate => '19640925',
518 address => '2 Meadowvale Dr. St Thomas, ON',
519 home_phone => '(519) 555 1234',
520 email_addr => 'djfiander@hotmail.com',
526 claims_returned => 0,
536 fine_items => ['Computer Time'],
543 From borrowers table:
544 +---------------------+--------------+------+-----+---------+----------------+
545 | Field | Type | Null | Key | Default | Extra |
546 +---------------------+--------------+------+-----+---------+----------------+
547 | borrowernumber | int(11) | NO | PRI | NULL | auto_increment |
548 | cardnumber | varchar(16) | YES | UNI | NULL | |
549 | surname | mediumtext | NO | | NULL | |
550 | firstname | text | YES | | NULL | |
551 | title | mediumtext | YES | | NULL | |
552 | othernames | mediumtext | YES | | NULL | |
553 | initials | text | YES | | NULL | |
554 | streetnumber | varchar(10) | YES | | NULL | |
555 | streettype | varchar(50) | YES | | NULL | |
556 | address | mediumtext | NO | | NULL | |
557 | address2 | text | YES | | NULL | |
558 | city | mediumtext | NO | | NULL | |
559 | state | mediumtext | YES | | NULL | |
560 | zipcode | varchar(25) | YES | | NULL | |
561 | country | text | YES | | NULL | |
562 | email | mediumtext | YES | | NULL | |
563 | phone | text | YES | | NULL | |
564 | mobile | varchar(50) | YES | | NULL | |
565 | fax | mediumtext | YES | | NULL | |
566 | emailpro | text | YES | | NULL | |
567 | phonepro | text | YES | | NULL | |
568 | B_streetnumber | varchar(10) | YES | | NULL | |
569 | B_streettype | varchar(50) | YES | | NULL | |
570 | B_address | varchar(100) | YES | | NULL | |
571 | B_address2 | text | YES | | NULL | |
572 | B_city | mediumtext | YES | | NULL | |
573 | B_state | mediumtext | YES | | NULL | |
574 | B_zipcode | varchar(25) | YES | | NULL | |
575 | B_country | text | YES | | NULL | |
576 | B_email | text | YES | | NULL | |
577 | B_phone | mediumtext | YES | | NULL | |
578 | dateofbirth | date | YES | | NULL | |
579 | branchcode | varchar(10) | NO | MUL | | |
580 | categorycode | varchar(10) | NO | MUL | | |
581 | dateenrolled | date | YES | | NULL | |
582 | dateexpiry | date | YES | | NULL | |
583 | gonenoaddress | tinyint(1) | YES | | NULL | |
584 | lost | tinyint(1) | YES | | NULL | |
585 | debarred | tinyint(1) | YES | | NULL | |
586 | contactname | mediumtext | YES | | NULL | |
587 | contactfirstname | text | YES | | NULL | |
588 | contacttitle | text | YES | | NULL | |
589 | guarantorid | int(11) | YES | MUL | NULL | |
590 | borrowernotes | mediumtext | YES | | NULL | |
591 | relationship | varchar(100) | YES | | NULL | |
592 | ethnicity | varchar(50) | YES | | NULL | |
593 | ethnotes | varchar(255) | YES | | NULL | |
594 | sex | varchar(1) | YES | | NULL | |
595 | password | varchar(30) | YES | | NULL | |
596 | flags | int(11) | YES | | NULL | |
597 | userid | varchar(30) | YES | MUL | NULL | |
598 | opacnote | mediumtext | YES | | NULL | |
599 | contactnote | varchar(255) | YES | | NULL | |
600 | sort1 | varchar(80) | YES | | NULL | |
601 | sort2 | varchar(80) | YES | | NULL | |
602 | altcontactfirstname | varchar(255) | YES | | NULL | |
603 | altcontactsurname | varchar(255) | YES | | NULL | |
604 | altcontactaddress1 | varchar(255) | YES | | NULL | |
605 | altcontactaddress2 | varchar(255) | YES | | NULL | |
606 | altcontactaddress3 | varchar(255) | YES | | NULL | |
607 | altcontactstate | mediumtext | YES | | NULL | |
608 | altcontactzipcode | varchar(50) | YES | | NULL | |
609 | altcontactcountry | text | YES | | NULL | |
610 | altcontactphone | varchar(50) | YES | | NULL | |
611 | smsalertnumber | varchar(50) | YES | | NULL | |
612 | privacy | int(11) | NO | | 1 | |
613 +---------------------+--------------+------+-----+---------+----------------+
620 {message} Message showing patron's credit or debt
621 {noissues} Set if patron owes >$5.00
622 {GNA} Set if patron gone w/o address
623 {message} "Borrower has no valid address"
625 {LOST} Set if patron's card reported lost
626 {message} Message to this effect
628 {DBARRED} Set if patron is debarred
629 {message} Message to this effect
631 {NOTES} Set if patron has notes
632 {message} Notes about patron
633 {ODUES} Set if patron has overdue books
635 {itemlist} ref-to-array: list of overdue books
636 {itemlisttext} Text list of overdue items
637 {WAITING} Set if there are items available that the patron reserved
638 {message} Message to this effect
639 {itemlist} ref-to-array: list of available items