4 # A Class for hiding the ILS's concept of the patron from the OpenSIP
14 use Sys::Syslog qw(syslog);
23 use Digest::MD5 qw(md5_base64);
25 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
30 @EXPORT_OK = qw(invalid_patron);
33 our $kp; # koha patron
36 my ($class, $patron_id) = @_;
37 my $type = ref($class) || $class;
39 $kp = GetMember($patron_id,'cardnumber');
40 $debug and warn "new Patron: " . Dumper($kp);
41 unless (defined $kp) {
42 syslog("LOG_DEBUG", "new ILS::Patron(%s): no such patron", $patron_id);
45 $kp = GetMemberDetails(undef,$patron_id);
46 $debug and warn "new Patron: " . Dumper($kp);
47 my $pw = $kp->{password}; ## FIXME - md5hash -- deal with .
48 my $dob= $kp->{dateofbirth};
49 my $fines_out = GetMemberAccountRecords($kp->{borrowernumber});
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 "Debarred: $debarred = " . Dumper(%{$kp->{flags}});
54 my $adr = $kp->{streetnumber} || '';
55 my $address = $kp->{address} || '';
56 $adr .= ($adr && $address) ? " $address" : $address;
58 no warnings; # any of these $kp->{fields} being concat'd could be undef
61 name => $kp->{firstname} . " " . $kp->{surname},
62 id => $kp->{cardnumber}, # to SIP, the id is the BARCODE, not userid
64 ptype => $kp->{categorycode}, # 'A'dult. Whatever.
65 birthdate => $kp->{dateofbirth}, ##$dob,
66 branchcode => $kp->{branchcode},
68 home_phone => $kp->{phone},
69 email_addr => $kp->{email},
70 charge_ok => (!$debarred), ## (C4::Context->preference('FinesMode') eq 'charge') || 0,
71 renew_ok => (!$debarred),
72 recall_ok => (!$debarred),
73 hold_ok => (!$debarred),
74 card_lost => ($kp->{lost} || $kp->{gonenoaddress} || $flags->{LOST}) ,
77 fees => 0, # currently not distinct from fines
80 screen_msg => 'Greetings from Koha. ' . $kp->{opacnote},
83 hold_items => $flags->{WAITING}{itemlist},
84 overdue_items => $flags->{ODUES}{itemlist},
91 for (qw(CHARGES CREDITS GNA LOST DBARRED NOTES)) {
92 ($flags->{$_}) or next;
93 $ilspatron{screen_msg} .= ($flags->{$_}->{message} || '') ;
94 if ($flags->{$_}->{noissues}){
95 $ilspatron{qw(charge_ok renew_ok recall_ok hold_ok)} = (0,0,0,0);
99 # FIXME: populate items fine_items recall_items
100 # $ilspatron{hold_items} = (GetReservesFromBorrowernumber($kp->{borrowernumber},'F'));
101 $ilspatron{unavail_holds} = [(GetReservesFromBorrowernumber($kp->{borrowernumber}))];
102 my ($count,$issues) = GetPendingIssues($kp->{borrowernumber});
103 $ilspatron{items} = $issues;
105 $debug and warn Dumper($self);
106 syslog("LOG_DEBUG", "new ILS::Patron(%s): found patron '%s'", $patron_id,$self->{id});
117 return $self->{name};
121 return $self->{address};
125 return $self->{email_addr};
129 return $self->{home_phone};
133 return $self->{birthdate};
137 return $self->{ptype};
141 return $self->{language} || '000'; # Unspecified
145 return $self->{charge_ok};
149 return $self->{renew_ok};
153 return $self->{recall_ok};
157 return $self->{hold_ok};
161 return $self->{card_lost};
165 return $self->{recall_overdue};
168 my ($self, $pwd) = @_;
169 my $md5pwd = $self->{password};
170 # warn sprintf "check_password for %s: '%s' vs. '%s'",($self->{name}||''),($self->{password}||''),($pwd||'');
171 (defined $pwd ) or return 0; # you gotta give me something (at least ''), or no deal
172 (defined $md5pwd) or return($pwd eq ''); # if the record has a NULL password, accept '' as match
173 return (md5_base64($pwd) eq $md5pwd);
177 return $self->{currency};
181 return $self->{fee_amount} || undef;
185 return $self->{screen_msg};
189 return $self->{print_line};
191 sub too_many_charged {
193 return $self->{too_many_charged};
195 sub too_many_overdue {
197 return $self->{too_many_overdue};
199 sub too_many_renewal {
201 return $self->{too_many_renewal};
203 sub too_many_claim_return {
205 return $self->{too_many_claim_return};
209 return $self->{too_many_lost};
211 sub excessive_fines {
213 return $self->{excessive_fines};
217 return $self->{excessive_fees};
219 sub too_many_billed {
221 return $self->{too_many_billed};
225 # List of outstanding holds placed
228 my ($self, $start, $end) = @_;
229 $self->{hold_items} or return [];
230 $start = 1 unless defined($start);
231 $end = scalar @{$self->{hold_items}} unless defined($end);
232 return [@{$self->{hold_items}}[$start-1 .. $end-1]];
236 # remove the hold on item item_id from my hold queue.
237 # return true if I was holding the item, false otherwise.
240 my ($self, $item_id) = @_;
241 $item_id or return undef;
243 foreach (qw(hold_items unavail_holds)) {
245 for (my $i = 0; $i < scalar @{$self->{$_}}; $i++) {
246 my $held_item = $self->{$_}[$i]->{item_id} or next;
247 if ($held_item eq $item_id) {
248 splice @{$self->{$_}}, $i, 1;
257 my ($self, $start, $end) = @_;
258 $self->{overdue_items} or return [];
259 $start = 1 if !defined($start);
260 $end = scalar @{$self->{overdue_items}} if !defined($end);
261 return [@{$self->{overdue_items}}[$start-1 .. $end-1]];
265 my ($self, $start, $end) = shift;
266 $self->{items} or return [];
267 $start = 1 if !defined($start);
268 $end = scalar @{$self->{items}} if !defined($end);
269 syslog("LOG_DEBUG", "charged_items: start = %d, end = %d; items(%s)",
270 $start, $end, join(', ', @{$self->{items}}));
271 return [@{$self->{items}}[$start-1 .. $end-1]];
275 my ($self, $start, $end) = @_;
276 $self->{fine_items} or return [];
277 $start = 1 if !defined($start);
278 $end = scalar @{$self->{fine_items}} if !defined($end);
279 return [@{$self->{fine_items}}[$start-1 .. $end-1]];
283 my ($self, $start, $end) = @_;
284 $self->{recall_items} or return [];
285 $start = 1 if !defined($start);
286 $end = scalar @{$self->{recall_items}} if !defined($end);
287 return [@{$self->{recall_items}}[$start-1 .. $end-1]];
291 my ($self, $start, $end) = @_;
292 $self->{unavail_holds} or return [];
293 $start = 1 if !defined($start);
294 $end = scalar @{$self->{unavail_holds}} if !defined($end);
295 return [@{$self->{unavail_holds}}[$start-1 .. $end-1]];
299 my ($self, $card_retained, $blocked_card_msg) = @_;
300 foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok') {
303 $self->{screen_msg} = $blocked_card_msg || "Card Blocked. Please contact library staff";
309 foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok') {
312 syslog("LOG_DEBUG", "Patron(%s)->enable: charge: %s, renew:%s, recall:%s, hold:%s",
313 $self->{id}, $self->{charge_ok}, $self->{renew_ok},
314 $self->{recall_ok}, $self->{hold_ok});
315 $self->{screen_msg} = "All privileges restored.";
319 sub inet_privileges {
321 return $self->{inet} ? 'Y' : 'N';
329 return "Please contact library staff";
333 return "Please contact library staff";
341 our %patron_example = (
343 name => "David J. Fiander",
346 ptype => 'A', # 'A'dult. Whatever.
347 birthdate => '19640925',
348 address => '2 Meadowvale Dr. St Thomas, ON',
349 home_phone => '(519) 555 1234',
350 email_addr => 'djfiander@hotmail.com',
356 claims_returned => 0,
366 fine_items => ['Computer Time'],
373 From borrowers table:
374 +---------------------+--------------+------+-----+
375 | Field | Type | Null | Key |
376 +---------------------+--------------+------+-----+
377 | borrowernumber | int(11) | NO | PRI |
378 | cardnumber | varchar(16) | YES | UNI |
379 | surname | mediumtext | NO | |
380 | firstname | text | YES | |
381 | title | mediumtext | YES | |
382 | othernames | mediumtext | YES | |
383 | initials | text | YES | |
384 | streetnumber | varchar(10) | YES | |
385 | streettype | varchar(50) | YES | |
386 | address | mediumtext | NO | |
387 | address2 | text | YES | |
388 | city | mediumtext | NO | |
389 | zipcode | varchar(25) | YES | |
390 | email | mediumtext | YES | |
391 | phone | text | YES | |
392 | mobile | varchar(50) | YES | |
393 | fax | mediumtext | YES | |
394 | emailpro | text | YES | |
395 | phonepro | text | YES | |
396 | B_streetnumber | varchar(10) | YES | |
397 | B_streettype | varchar(50) | YES | |
398 | B_address | varchar(100) | YES | |
399 | B_city | mediumtext | YES | |
400 | B_zipcode | varchar(25) | YES | |
401 | B_email | text | YES | |
402 | B_phone | mediumtext | YES | |
403 | dateofbirth | date | YES | |
404 | branchcode | varchar(10) | NO | MUL |
405 | categorycode | varchar(10) | NO | MUL |
406 | dateenrolled | date | YES | |
407 | dateexpiry | date | YES | |
408 | gonenoaddress | tinyint(1) | YES | |
409 | lost | tinyint(1) | YES | |
410 | debarred | tinyint(1) | YES | |
411 | contactname | mediumtext | YES | |
412 | contactfirstname | text | YES | |
413 | contacttitle | text | YES | |
414 | guarantorid | int(11) | YES | |
415 | borrowernotes | mediumtext | YES | |
416 | relationship | varchar(100) | YES | |
417 | ethnicity | varchar(50) | YES | |
418 | ethnotes | varchar(255) | YES | |
419 | sex | varchar(1) | YES | |
420 | password | varchar(30) | YES | |
421 | flags | int(11) | YES | |
422 | userid | varchar(30) | YES | MUL |
423 | opacnote | mediumtext | YES | |
424 | contactnote | varchar(255) | YES | |
425 | sort1 | varchar(80) | YES | |
426 | sort2 | varchar(80) | YES | |
427 | altcontactfirstname | varchar(255) | YES | |
428 | altcontactsurname | varchar(255) | YES | |
429 | altcontactaddress1 | varchar(255) | YES | |
430 | altcontactaddress2 | varchar(255) | YES | |
431 | altcontactaddress3 | varchar(255) | YES | |
432 | altcontactzipcode | varchar(50) | YES | |
433 | altcontactphone | varchar(50) | YES | |
434 +---------------------+--------------+------+-----+
440 {message} Message showing patron's credit or debt
441 {noissues} Set if patron owes >$5.00
442 {GNA} Set if patron gone w/o address
443 {message} "Borrower has no valid address"
445 {LOST} Set if patron's card reported lost
446 {message} Message to this effect
448 {DBARRED} Set if patron is debarred
449 {message} Message to this effect
451 {NOTES} Set if patron has notes
452 {message} Notes about patron
453 {ODUES} Set if patron has overdue books
455 {itemlist} ref-to-array: list of overdue books
456 {itemlisttext} Text list of overdue items
457 {WAITING} Set if there are items available that the patron reserved
458 {message} Message to this effect
459 {itemlist} ref-to-array: list of available items