4 # A Class for hiding the ILS's concept of the patron from the OpenSIP
15 use Sys::Syslog qw(syslog);
23 use C4::Branch qw(GetBranchName);
24 use Digest::MD5 qw(md5_base64);
26 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
31 @EXPORT_OK = qw(invalid_patron);
34 our $kp; # koha patron
37 my ($class, $patron_id) = @_;
38 my $type = ref($class) || $class;
40 $kp = GetMember(cardnumber=>$patron_id);
41 $debug and warn "new Patron (GetMember): " . Dumper($kp);
42 unless (defined $kp) {
43 syslog("LOG_DEBUG", "new ILS::Patron(%s): no such patron", $patron_id);
46 $kp = GetMemberDetails(undef,$patron_id);
47 $debug and warn "new Patron (GetMemberDetails): " . Dumper($kp);
48 my $pw = $kp->{password}; ### FIXME - md5hash -- deal with .
49 my $flags = $kp->{flags}; # or warn "Warning: No flags from patron object for '$patron_id'";
50 my $debarred = $kp->{debarred}; # 1 if ($kp->{flags}->{DBARRED}->{noissues});
51 $debug and warn sprintf("Debarred = %s : ", ($debarred||'undef')) . Dumper(%{$kp->{flags}});
52 my ($day, $month, $year) = (localtime)[3,4,5];
53 my $today = sprintf '%04d-%02d-%02d', $year+1900, $month+1, $day;
54 my $expired = ($today gt $kp->{dateexpiry}) ? 1 : 0;
56 if ($kp->{opacnote} ) {
57 $kp->{opacnote} .= q{ };
59 $kp->{opacnote} .= 'PATRON EXPIRED';
62 my $adr = $kp->{streetnumber} || '';
63 my $address = $kp->{address} || '';
64 my $dob = $kp->{dateofbirth};
65 $dob and $dob =~ s/-//g; # YYYYMMDD
66 my $dexpiry = $kp->{dateexpiry};
67 $dexpiry and $dexpiry =~ s/-//g; # YYYYMMDD
68 $adr .= ($adr && $address) ? " $address" : $address;
69 my $fines_amount = $flags->{CHARGES}->{amount};
70 $fines_amount = ($fines_amount and $fines_amount > 0) ? $fines_amount : 0;
72 no warnings; # any of these $kp->{fields} being concat'd could be undef
74 getmemberdetails_object => $kp,
75 name => $kp->{firstname} . " " . $kp->{surname},
76 id => $kp->{cardnumber}, # to SIP, the id is the BARCODE, not userid
78 ptype => $kp->{categorycode}, # 'A'dult. Whatever.
79 dateexpiry => $dexpiry,
80 dateexpiry_iso => $kp->{dateexpiry},
82 birthdate_iso => $kp->{dateofbirth},
83 branchcode => $kp->{branchcode},
84 library_name => "", # only populated if needed, cached here
85 borrowernumber => $kp->{borrowernumber},
87 home_phone => $kp->{phone},
88 email_addr => $kp->{email},
89 charge_ok => ( !$debarred && !$expired ),
90 renew_ok => ( !$debarred && !$expired ),
91 recall_ok => ( !$debarred && !$expired ),
92 hold_ok => ( !$debarred && !$expired ),
93 card_lost => ( $kp->{lost} || $kp->{gonenoaddress} || $flags->{LOST} ),
95 fines => $fines_amount, # GetMemberAccountRecords($kp->{borrowernumber})
96 fees => 0, # currently not distinct from fines
99 screen_msg => 'Greetings from Koha. ' . $kp->{opacnote},
102 hold_items => $flags->{WAITING}{itemlist},
103 overdue_items => $flags->{ODUES}{itemlist},
107 inet => ( !$debarred && !$expired ),
111 $debug and warn "patron fines: $ilspatron{fines} ... amountoutstanding: $kp->{amountoutstanding} ... CHARGES->amount: $flags->{CHARGES}->{amount}";
112 for (qw(EXPIRED CHARGES CREDITS GNA LOST DBARRED NOTES)) {
113 ($flags->{$_}) or next;
114 if ($_ ne 'NOTES' and $flags->{$_}->{message}) {
115 $ilspatron{screen_msg} .= " -- " . $flags->{$_}->{message}; # show all but internal NOTES
117 if ($flags->{$_}->{noissues}) {
118 foreach my $toggle (qw(charge_ok renew_ok recall_ok hold_ok inet)) {
119 $ilspatron{$toggle} = 0; # if we get noissues, disable everything
124 # FIXME: populate fine_items recall_items
125 # $ilspatron{hold_items} = (GetReservesFromBorrowernumber($kp->{borrowernumber},'F'));
126 $ilspatron{unavail_holds} = [(GetReservesFromBorrowernumber($kp->{borrowernumber}))];
127 $ilspatron{items} = GetPendingIssues($kp->{borrowernumber});
129 $debug and warn Dumper($self);
130 syslog("LOG_DEBUG", "new ILS::Patron(%s): found patron '%s'", $patron_id,$self->{id});
150 charge_ok => 0, # for patron_status[0] (inverted)
151 renew_ok => 0, # for patron_status[1] (inverted)
152 recall_ok => 0, # for patron_status[2] (inverted)
153 hold_ok => 0, # for patron_status[3] (inverted)
154 card_lost => 0, # for patron_status[4]
160 too_many_charged => 0, # for patron_status[5]
161 too_many_overdue => 0, # for patron_status[6]
162 too_many_renewal => 0, # for patron_status[7]
163 too_many_claim_return => 0, # for patron_status[8]
164 too_many_lost => 0, # for patron_status[9]
165 # excessive_fines => 0, # for patron_status[10]
166 # excessive_fees => 0, # for patron_status[11]
167 recall_overdue => 0, # for patron_status[12]
168 too_many_billed => 0, # for patron_status[13]
169 inet => 0, # EnvisionWare extension
170 getmemberdetails_object => 0,
176 # be cool. needed for AUTOLOAD(?)
181 my $class = ref($self) or croak "$self is not an object";
182 my $name = $AUTOLOAD;
186 unless (exists $fields{$name}) {
187 croak "Cannot access '$name' field of class '$class'";
191 $fields{$name} or croak "Field '$name' of class '$class' is READ ONLY.";
192 return $self->{$name} = shift;
194 return $self->{$name};
199 my ($self, $pwd) = @_;
200 my $md5pwd = $self->{password};
201 # warn sprintf "check_password for %s: '%s' vs. '%s'",($self->{name}||''),($self->{password}||''),($pwd||'');
202 (defined $pwd ) or return 0; # you gotta give me something (at least ''), or no deal
203 (defined $md5pwd) or return($pwd eq ''); # if the record has a NULL password, accept '' as match
204 return (md5_base64($pwd) eq $md5pwd);
207 # A few special cases, not in AUTOLOADed %fields
210 return $self->{fines} || undef;
215 return $self->fee_amount;
220 return $self->{language} || '000'; # Unspecified
225 return $self->{expired};
229 # remove the hold on item item_id from my hold queue.
230 # return true if I was holding the item, false otherwise.
233 my ($self, $item_id) = @_;
234 $item_id or return undef;
236 foreach (qw(hold_items unavail_holds)) {
238 for (my $i = 0; $i < scalar @{$self->{$_}}; $i++) {
239 my $held_item = $self->{$_}[$i]->{item_id} or next;
240 if ($held_item eq $item_id) {
241 splice @{$self->{$_}}, $i, 1;
249 # Accessor method for array_ref values, designed to get the "start" and "end" values
250 # from the SIP request. Note those incoming values are 1-indexed, not 0-indexed.
253 my $self = shift or return;
254 my $array_var = shift or return;
255 my ($start, $end) = @_;
256 $self->{$array_var} or return [];
257 $start = 1 unless defined($start);
258 $end = scalar @{$self->{$array_var}} unless defined($end);
259 # syslog("LOG_DEBUG", "$array_var: start = %d, end = %d; items(%s)", $start, $end, join(', ', @{$self->{items}}));
261 return [@{$self->{$array_var}}[$start-1 .. $end-1]];
265 # List of outstanding holds placed
268 my $self = shift or return;
269 return $self->x_items('hold_items', @_);
273 my $self = shift or return;
274 return $self->x_items('overdue_items', @_);
277 my $self = shift or return;
278 return $self->x_items('items', @_);
281 my $self = shift or return;
282 return $self->x_items('fine_items', @_);
285 my $self = shift or return;
286 return $self->x_items('recall_items', @_);
289 my $self = shift or return;
290 return $self->x_items('unavail_holds', @_);
294 my ($self, $card_retained, $blocked_card_msg) = @_;
295 foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
298 $self->{screen_msg} = "Block feature not implemented"; # $blocked_card_msg || "Card Blocked. Please contact library staff";
299 # TODO: not really affecting patron record
305 foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
308 syslog("LOG_DEBUG", "Patron(%s)->enable: charge: %s, renew:%s, recall:%s, hold:%s",
309 $self->{id}, $self->{charge_ok}, $self->{renew_ok},
310 $self->{recall_ok}, $self->{hold_ok});
311 $self->{screen_msg} = "Enable feature not implemented."; # "All privileges restored."; # TODO: not really affecting patron record
315 sub inet_privileges {
317 return $self->{inet} ? 'Y' : 'N';
322 return C4::Context->preference("noissuescharge") || 5;
326 my $self = shift or return;
327 return ($self->fee_amount and $self->fee_amount > $self->fee_limit);
329 sub excessive_fines {
330 my $self = shift or return;
331 return $self->excessive_fees; # excessive_fines is the same thing as excessive_fees for Koha
336 unless ($self->{library_name}) {
337 $self->{library_name} = GetBranchName($self->{branchcode});
339 return $self->{library_name};
346 return "Please contact library staff";
350 return "Please contact library staff";
358 our %patron_example = (
360 name => "David J. Fiander",
363 ptype => 'A', # 'A'dult. Whatever.
364 birthdate => '19640925',
365 address => '2 Meadowvale Dr. St Thomas, ON',
366 home_phone => '(519) 555 1234',
367 email_addr => 'djfiander@hotmail.com',
373 claims_returned => 0,
383 fine_items => ['Computer Time'],
390 From borrowers table:
391 +---------------------+--------------+------+-----+---------+----------------+
392 | Field | Type | Null | Key | Default | Extra |
393 +---------------------+--------------+------+-----+---------+----------------+
394 | borrowernumber | int(11) | NO | PRI | NULL | auto_increment |
395 | cardnumber | varchar(16) | YES | UNI | NULL | |
396 | surname | mediumtext | NO | | NULL | |
397 | firstname | text | YES | | NULL | |
398 | title | mediumtext | YES | | NULL | |
399 | othernames | mediumtext | YES | | NULL | |
400 | initials | text | YES | | NULL | |
401 | streetnumber | varchar(10) | YES | | NULL | |
402 | streettype | varchar(50) | YES | | NULL | |
403 | address | mediumtext | NO | | NULL | |
404 | address2 | text | YES | | NULL | |
405 | city | mediumtext | NO | | NULL | |
406 | state | mediumtext | YES | | NULL | |
407 | zipcode | varchar(25) | YES | | NULL | |
408 | country | text | YES | | NULL | |
409 | email | mediumtext | YES | | NULL | |
410 | phone | text | YES | | NULL | |
411 | mobile | varchar(50) | YES | | NULL | |
412 | fax | mediumtext | YES | | NULL | |
413 | emailpro | text | YES | | NULL | |
414 | phonepro | text | YES | | NULL | |
415 | B_streetnumber | varchar(10) | YES | | NULL | |
416 | B_streettype | varchar(50) | YES | | NULL | |
417 | B_address | varchar(100) | YES | | NULL | |
418 | B_address2 | text | YES | | NULL | |
419 | B_city | mediumtext | YES | | NULL | |
420 | B_state | mediumtext | YES | | NULL | |
421 | B_zipcode | varchar(25) | YES | | NULL | |
422 | B_country | text | YES | | NULL | |
423 | B_email | text | YES | | NULL | |
424 | B_phone | mediumtext | YES | | NULL | |
425 | dateofbirth | date | YES | | NULL | |
426 | branchcode | varchar(10) | NO | MUL | | |
427 | categorycode | varchar(10) | NO | MUL | | |
428 | dateenrolled | date | YES | | NULL | |
429 | dateexpiry | date | YES | | NULL | |
430 | gonenoaddress | tinyint(1) | YES | | NULL | |
431 | lost | tinyint(1) | YES | | NULL | |
432 | debarred | tinyint(1) | YES | | NULL | |
433 | contactname | mediumtext | YES | | NULL | |
434 | contactfirstname | text | YES | | NULL | |
435 | contacttitle | text | YES | | NULL | |
436 | guarantorid | int(11) | YES | MUL | NULL | |
437 | borrowernotes | mediumtext | YES | | NULL | |
438 | relationship | varchar(100) | YES | | NULL | |
439 | ethnicity | varchar(50) | YES | | NULL | |
440 | ethnotes | varchar(255) | YES | | NULL | |
441 | sex | varchar(1) | YES | | NULL | |
442 | password | varchar(30) | YES | | NULL | |
443 | flags | int(11) | YES | | NULL | |
444 | userid | varchar(30) | YES | MUL | NULL | |
445 | opacnote | mediumtext | YES | | NULL | |
446 | contactnote | varchar(255) | YES | | NULL | |
447 | sort1 | varchar(80) | YES | | NULL | |
448 | sort2 | varchar(80) | YES | | NULL | |
449 | altcontactfirstname | varchar(255) | YES | | NULL | |
450 | altcontactsurname | varchar(255) | YES | | NULL | |
451 | altcontactaddress1 | varchar(255) | YES | | NULL | |
452 | altcontactaddress2 | varchar(255) | YES | | NULL | |
453 | altcontactaddress3 | varchar(255) | YES | | NULL | |
454 | altcontactstate | mediumtext | YES | | NULL | |
455 | altcontactzipcode | varchar(50) | YES | | NULL | |
456 | altcontactcountry | text | YES | | NULL | |
457 | altcontactphone | varchar(50) | YES | | NULL | |
458 | smsalertnumber | varchar(50) | YES | | NULL | |
459 | privacy | int(11) | NO | | 1 | |
460 +---------------------+--------------+------+-----+---------+----------------+
467 {message} Message showing patron's credit or debt
468 {noissues} Set if patron owes >$5.00
469 {GNA} Set if patron gone w/o address
470 {message} "Borrower has no valid address"
472 {LOST} Set if patron's card reported lost
473 {message} Message to this effect
475 {DBARRED} Set if patron is debarred
476 {message} Message to this effect
478 {NOTES} Set if patron has notes
479 {message} Notes about patron
480 {ODUES} Set if patron has overdue books
482 {itemlist} ref-to-array: list of overdue books
483 {itemlisttext} Text list of overdue items
484 {WAITING} Set if there are items available that the patron reserved
485 {message} Message to this effect
486 {itemlist} ref-to-array: list of available items