4 # A Class for hiding the ILS's concept of the patron from the OpenSIP
15 use Sys::Syslog qw(syslog);
24 use C4::Branch qw(GetBranchName);
25 use Digest::MD5 qw(md5_base64);
27 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
32 @EXPORT_OK = qw(invalid_patron);
35 our $kp; # koha patron
38 my ($class, $patron_id) = @_;
39 my $type = ref($class) || $class;
41 $kp = GetMember($patron_id,'cardnumber');
42 $debug and warn "new Patron (GetMember): " . Dumper($kp);
43 unless (defined $kp) {
44 syslog("LOG_DEBUG", "new ILS::Patron(%s): no such patron", $patron_id);
47 $kp = GetMemberDetails(undef,$patron_id);
48 $debug and warn "new Patron (GetMemberDetails): " . Dumper($kp);
49 my $pw = $kp->{password}; ### FIXME - md5hash -- deal with .
50 my $flags = $kp->{flags}; # or warn "Warning: No flags from patron object for '$patron_id'";
51 my $debarred = $kp->{debarred}; # 1 if ($kp->{flags}->{DBARRED}->{noissues});
52 $debug and warn sprintf("Debarred = %s : ", ($debarred||'undef')) . Dumper(%{$kp->{flags}});
54 my $adr = $kp->{streetnumber} || '';
55 my $address = $kp->{address} || '';
56 my $dob = $kp->{dateofbirth};
57 $dob and $dob =~ s/-//g; # YYYYMMDD
58 $adr .= ($adr && $address) ? " $address" : $address;
59 my $fines_amount = $flags->{CHARGES}->{amount};
60 $fines_amount = ($fines_amount and $fines_amount > 0) ? $fines_amount : 0;
62 no warnings; # any of these $kp->{fields} being concat'd could be undef
64 getmemberdetails_object => $kp,
65 name => $kp->{firstname} . " " . $kp->{surname},
66 id => $kp->{cardnumber}, # to SIP, the id is the BARCODE, not userid
68 ptype => $kp->{categorycode}, # 'A'dult. Whatever.
70 birthdate_iso => $kp->{dateofbirth},
71 branchcode => $kp->{branchcode},
72 library_name => "", # only populated if needed, cached here
73 borrowernumber => $kp->{borrowernumber},
75 home_phone => $kp->{phone},
76 email_addr => $kp->{email},
77 charge_ok => ( !$debarred ),
78 renew_ok => ( !$debarred ),
79 recall_ok => ( !$debarred ),
80 hold_ok => ( !$debarred ),
81 card_lost => ( $kp->{lost} || $kp->{gonenoaddress} || $flags->{LOST} ),
83 fines => $fines_amount, # GetMemberAccountRecords($kp->{borrowernumber})
84 fees => 0, # currently not distinct from fines
87 screen_msg => 'Greetings from Koha. ' . $kp->{opacnote},
90 hold_items => $flags->{WAITING}{itemlist},
91 overdue_items => $flags->{ODUES}{itemlist},
95 inet => ( !$debarred ),
98 $debug and warn "patron fines: $ilspatron{fines} ... amountoutstanding: $kp->{amountoutstanding} ... CHARGES->amount: $flags->{CHARGES}->{amount}";
99 for (qw(CHARGES CREDITS GNA LOST DBARRED NOTES)) {
100 ($flags->{$_}) or next;
101 $ilspatron{screen_msg} .= ($flags->{$_}->{message} || '') ;
102 if ($flags->{$_}->{noissues}) {
103 foreach my $toggle (qw(charge_ok renew_ok recall_ok hold_ok inet)) {
104 $ilspatron{$toggle} = 0; # if we get noissues, disable everything
109 # FIXME: populate fine_items recall_items
110 # $ilspatron{hold_items} = (GetReservesFromBorrowernumber($kp->{borrowernumber},'F'));
111 $ilspatron{unavail_holds} = [(GetReservesFromBorrowernumber($kp->{borrowernumber}))];
112 $ilspatron{items} = GetPendingIssues($kp->{borrowernumber});
114 $debug and warn Dumper($self);
115 syslog("LOG_DEBUG", "new ILS::Patron(%s): found patron '%s'", $patron_id,$self->{id});
133 charge_ok => 0, # for patron_status[0] (inverted)
134 renew_ok => 0, # for patron_status[1] (inverted)
135 recall_ok => 0, # for patron_status[2] (inverted)
136 hold_ok => 0, # for patron_status[3] (inverted)
137 card_lost => 0, # for patron_status[4]
143 too_many_charged => 0, # for patron_status[5]
144 too_many_overdue => 0, # for patron_status[6]
145 too_many_renewal => 0, # for patron_status[7]
146 too_many_claim_return => 0, # for patron_status[8]
147 too_many_lost => 0, # for patron_status[9]
148 # excessive_fines => 0, # for patron_status[10]
149 # excessive_fees => 0, # for patron_status[11]
150 recall_overdue => 0, # for patron_status[12]
151 too_many_billed => 0, # for patron_status[13]
152 inet => 0, # EnvisionWare extension
153 getmemberdetails_object => 0,
159 # be cool. needed for AUTOLOAD(?)
164 my $class = ref($self) or croak "$self is not an object";
165 my $name = $AUTOLOAD;
169 unless (exists $fields{$name}) {
170 croak "Cannot access '$name' field of class '$class'";
174 $fields{$name} or croak "Field '$name' of class '$class' is READ ONLY.";
175 return $self->{$name} = shift;
177 return $self->{$name};
182 my ($self, $pwd) = @_;
183 my $md5pwd = $self->{password};
184 # warn sprintf "check_password for %s: '%s' vs. '%s'",($self->{name}||''),($self->{password}||''),($pwd||'');
185 (defined $pwd ) or return 0; # you gotta give me something (at least ''), or no deal
186 (defined $md5pwd) or return($pwd eq ''); # if the record has a NULL password, accept '' as match
187 return (md5_base64($pwd) eq $md5pwd);
190 # A few special cases, not in AUTOLOADed %fields
193 return $self->{fines} || undef;
198 return $self->fee_amount;
203 return $self->{language} || '000'; # Unspecified
207 # List of outstanding holds placed
210 my ($self, $start, $end) = @_;
211 $self->{hold_items} or return [];
212 $start = 1 unless defined($start);
213 $end = scalar @{$self->{hold_items}} unless defined($end);
214 return [@{$self->{hold_items}}[$start-1 .. $end-1]]; # SIP "start item" and "end item" values are 1-indexed, not 0 like perl arrays
218 # remove the hold on item item_id from my hold queue.
219 # return true if I was holding the item, false otherwise.
222 my ($self, $item_id) = @_;
223 $item_id or return undef;
225 foreach (qw(hold_items unavail_holds)) {
227 for (my $i = 0; $i < scalar @{$self->{$_}}; $i++) {
228 my $held_item = $self->{$_}[$i]->{item_id} or next;
229 if ($held_item eq $item_id) {
230 splice @{$self->{$_}}, $i, 1;
239 my ($self, $start, $end) = @_;
240 $self->{overdue_items} or return [];
241 $start = 1 if !defined($start);
242 $end = scalar @{$self->{overdue_items}} if !defined($end);
243 return [@{$self->{overdue_items}}[$start-1 .. $end-1]];
247 my ($self, $start, $end) = shift;
248 $self->{items} or return [];
249 $start = 1 if !defined($start);
250 $end = scalar @{$self->{items}} if !defined($end);
251 syslog("LOG_DEBUG", "charged_items: start = %d, end = %d; items(%s)",
252 $start, $end, join(', ', @{$self->{items}}));
253 return [@{$self->{items}}[$start-1 .. $end-1]];
257 my ($self, $start, $end) = @_;
258 $self->{fine_items} or return [];
259 $start = 1 if !defined($start);
260 $end = scalar @{$self->{fine_items}} if !defined($end);
261 return [@{$self->{fine_items}}[$start-1 .. $end-1]];
265 my ($self, $start, $end) = @_;
266 $self->{recall_items} or return [];
267 $start = 1 if !defined($start);
268 $end = scalar @{$self->{recall_items}} if !defined($end);
269 return [@{$self->{recall_items}}[$start-1 .. $end-1]];
273 my ($self, $start, $end) = @_;
274 $self->{unavail_holds} or return [];
275 $start = 1 if !defined($start);
276 $end = scalar @{$self->{unavail_holds}} if !defined($end);
277 return [@{$self->{unavail_holds}}[$start-1 .. $end-1]];
281 my ($self, $card_retained, $blocked_card_msg) = @_;
282 foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
285 $self->{screen_msg} = "Feature not implemented"; # $blocked_card_msg || "Card Blocked. Please contact library staff";
286 # TODO: not really affecting patron record
292 foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
295 syslog("LOG_DEBUG", "Patron(%s)->enable: charge: %s, renew:%s, recall:%s, hold:%s",
296 $self->{id}, $self->{charge_ok}, $self->{renew_ok},
297 $self->{recall_ok}, $self->{hold_ok});
298 $self->{screen_msg} = "This feature not implemented."; # "All privileges restored."; # TODO: not really affecting patron record
302 sub inet_privileges {
304 return $self->{inet} ? 'Y' : 'N';
309 return C4::Context->preference("noissuescharge") || 5;
313 my $self = shift or return;
314 return ($self->fee_amount and $self->fee_amount > $self->fee_limit);
316 sub excessive_fines {
317 my $self = shift or return;
318 return $self->excessive_fees; # same thing for Koha
323 unless ($self->{library_name}) {
324 $self->{library_name} = GetBranchName($self->{branchcode});
326 return $self->{library_name};
333 return "Please contact library staff";
337 return "Please contact library staff";
345 our %patron_example = (
347 name => "David J. Fiander",
350 ptype => 'A', # 'A'dult. Whatever.
351 birthdate => '19640925',
352 address => '2 Meadowvale Dr. St Thomas, ON',
353 home_phone => '(519) 555 1234',
354 email_addr => 'djfiander@hotmail.com',
360 claims_returned => 0,
370 fine_items => ['Computer Time'],
377 From borrowers table:
378 +---------------------+--------------+------+-----+
379 | Field | Type | Null | Key |
380 +---------------------+--------------+------+-----+
381 | borrowernumber | int(11) | NO | PRI |
382 | cardnumber | varchar(16) | YES | UNI |
383 | surname | mediumtext | NO | |
384 | firstname | text | YES | |
385 | title | mediumtext | YES | |
386 | othernames | mediumtext | YES | |
387 | initials | text | YES | |
388 | streetnumber | varchar(10) | YES | |
389 | streettype | varchar(50) | YES | |
390 | address | mediumtext | NO | |
391 | address2 | text | YES | |
392 | city | mediumtext | NO | |
393 | zipcode | varchar(25) | YES | |
394 | email | mediumtext | YES | |
395 | phone | text | YES | |
396 | mobile | varchar(50) | YES | |
397 | fax | mediumtext | YES | |
398 | emailpro | text | YES | |
399 | phonepro | text | YES | |
400 | B_streetnumber | varchar(10) | YES | |
401 | B_streettype | varchar(50) | YES | |
402 | B_address | varchar(100) | YES | |
403 | B_city | mediumtext | YES | |
404 | B_zipcode | varchar(25) | YES | |
405 | B_email | text | YES | |
406 | B_phone | mediumtext | YES | |
407 | dateofbirth | date | YES | |
408 | branchcode | varchar(10) | NO | MUL |
409 | categorycode | varchar(10) | NO | MUL |
410 | dateenrolled | date | YES | |
411 | dateexpiry | date | YES | |
412 | gonenoaddress | tinyint(1) | YES | |
413 | lost | tinyint(1) | YES | |
414 | debarred | tinyint(1) | YES | |
415 | contactname | mediumtext | YES | |
416 | contactfirstname | text | YES | |
417 | contacttitle | text | YES | |
418 | guarantorid | int(11) | YES | |
419 | borrowernotes | mediumtext | YES | |
420 | relationship | varchar(100) | YES | |
421 | ethnicity | varchar(50) | YES | |
422 | ethnotes | varchar(255) | YES | |
423 | sex | varchar(1) | YES | |
424 | password | varchar(30) | YES | |
425 | flags | int(11) | YES | |
426 | userid | varchar(30) | YES | MUL |
427 | opacnote | mediumtext | YES | |
428 | contactnote | varchar(255) | YES | |
429 | sort1 | varchar(80) | YES | |
430 | sort2 | varchar(80) | YES | |
431 | altcontactfirstname | varchar(255) | YES | |
432 | altcontactsurname | varchar(255) | YES | |
433 | altcontactaddress1 | varchar(255) | YES | |
434 | altcontactaddress2 | varchar(255) | YES | |
435 | altcontactaddress3 | varchar(255) | YES | |
436 | altcontactzipcode | varchar(50) | YES | |
437 | altcontactphone | varchar(50) | YES | |
438 +---------------------+--------------+------+-----+
444 {message} Message showing patron's credit or debt
445 {noissues} Set if patron owes >$5.00
446 {GNA} Set if patron gone w/o address
447 {message} "Borrower has no valid address"
449 {LOST} Set if patron's card reported lost
450 {message} Message to this effect
452 {DBARRED} Set if patron is debarred
453 {message} Message to this effect
455 {NOTES} Set if patron has notes
456 {message} Notes about patron
457 {ODUES} Set if patron has overdue books
459 {itemlist} ref-to-array: list of overdue books
460 {itemlisttext} Text list of overdue items
461 {WAITING} Set if there are items available that the patron reserved
462 {message} Message to this effect
463 {itemlist} ref-to-array: list of available items