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(cardnumber=>$patron_id);
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 my $dexpiry = $kp->{dateexpiry};
59 $dexpiry and $dexpiry =~ s/-//g; # YYYYMMDD
60 $adr .= ($adr && $address) ? " $address" : $address;
61 my $fines_amount = $flags->{CHARGES}->{amount};
62 $fines_amount = ($fines_amount and $fines_amount > 0) ? $fines_amount : 0;
64 no warnings; # any of these $kp->{fields} being concat'd could be undef
66 getmemberdetails_object => $kp,
67 name => $kp->{firstname} . " " . $kp->{surname},
68 id => $kp->{cardnumber}, # to SIP, the id is the BARCODE, not userid
70 ptype => $kp->{categorycode}, # 'A'dult. Whatever.
71 dateexpiry => $dexpiry,
72 dateexpiry_iso => $kp->{dateexpiry},
74 birthdate_iso => $kp->{dateofbirth},
75 branchcode => $kp->{branchcode},
76 library_name => "", # only populated if needed, cached here
77 borrowernumber => $kp->{borrowernumber},
79 home_phone => $kp->{phone},
80 email_addr => $kp->{email},
81 charge_ok => ( !$debarred ),
82 renew_ok => ( !$debarred ),
83 recall_ok => ( !$debarred ),
84 hold_ok => ( !$debarred ),
85 card_lost => ( $kp->{lost} || $kp->{gonenoaddress} || $flags->{LOST} ),
87 fines => $fines_amount, # GetMemberAccountRecords($kp->{borrowernumber})
88 fees => 0, # currently not distinct from fines
91 screen_msg => 'Greetings from Koha. ' . $kp->{opacnote},
94 hold_items => $flags->{WAITING}{itemlist},
95 overdue_items => $flags->{ODUES}{itemlist},
99 inet => ( !$debarred ),
102 $debug and warn "patron fines: $ilspatron{fines} ... amountoutstanding: $kp->{amountoutstanding} ... CHARGES->amount: $flags->{CHARGES}->{amount}";
103 for (qw(EXPIRED CHARGES CREDITS GNA LOST DEBARRED NOTES)) {
104 ($flags->{$_}) or next;
105 if ($_ ne 'NOTES' and $flags->{$_}->{message}) {
106 $ilspatron{screen_msg} .= " -- " . $flags->{$_}->{message}; # show all but internal NOTES
108 if ($flags->{$_}->{noissues}) {
109 foreach my $toggle (qw(charge_ok renew_ok recall_ok hold_ok inet)) {
110 $ilspatron{$toggle} = 0; # if we get noissues, disable everything
115 # FIXME: populate fine_items recall_items
116 # $ilspatron{hold_items} = (GetReservesFromBorrowernumber($kp->{borrowernumber},'F'));
117 $ilspatron{unavail_holds} = [(GetReservesFromBorrowernumber($kp->{borrowernumber}))];
118 $ilspatron{items} = GetPendingIssues($kp->{borrowernumber});
120 $debug and warn Dumper($self);
121 syslog("LOG_DEBUG", "new ILS::Patron(%s): found patron '%s'", $patron_id,$self->{id});
141 charge_ok => 0, # for patron_status[0] (inverted)
142 renew_ok => 0, # for patron_status[1] (inverted)
143 recall_ok => 0, # for patron_status[2] (inverted)
144 hold_ok => 0, # for patron_status[3] (inverted)
145 card_lost => 0, # for patron_status[4]
151 too_many_charged => 0, # for patron_status[5]
152 too_many_overdue => 0, # for patron_status[6]
153 too_many_renewal => 0, # for patron_status[7]
154 too_many_claim_return => 0, # for patron_status[8]
155 too_many_lost => 0, # for patron_status[9]
156 # excessive_fines => 0, # for patron_status[10]
157 # excessive_fees => 0, # for patron_status[11]
158 recall_overdue => 0, # for patron_status[12]
159 too_many_billed => 0, # for patron_status[13]
160 inet => 0, # EnvisionWare extension
161 getmemberdetails_object => 0,
167 # be cool. needed for AUTOLOAD(?)
172 my $class = ref($self) or croak "$self is not an object";
173 my $name = $AUTOLOAD;
177 unless (exists $fields{$name}) {
178 croak "Cannot access '$name' field of class '$class'";
182 $fields{$name} or croak "Field '$name' of class '$class' is READ ONLY.";
183 return $self->{$name} = shift;
185 return $self->{$name};
190 my ($self, $pwd) = @_;
191 my $md5pwd = $self->{password};
192 # warn sprintf "check_password for %s: '%s' vs. '%s'",($self->{name}||''),($self->{password}||''),($pwd||'');
193 (defined $pwd ) or return 0; # you gotta give me something (at least ''), or no deal
194 (defined $md5pwd) or return($pwd eq ''); # if the record has a NULL password, accept '' as match
195 return (md5_base64($pwd) eq $md5pwd);
198 # A few special cases, not in AUTOLOADed %fields
201 return $self->{fines} || undef;
206 return $self->fee_amount;
211 return $self->{language} || '000'; # Unspecified
215 # remove the hold on item item_id from my hold queue.
216 # return true if I was holding the item, false otherwise.
219 my ($self, $item_id) = @_;
220 $item_id or return undef;
222 foreach (qw(hold_items unavail_holds)) {
224 for (my $i = 0; $i < scalar @{$self->{$_}}; $i++) {
225 my $held_item = $self->{$_}[$i]->{item_id} or next;
226 if ($held_item eq $item_id) {
227 splice @{$self->{$_}}, $i, 1;
235 # Accessor method for array_ref values, designed to get the "start" and "end" values
236 # from the SIP request. Note those incoming values are 1-indexed, not 0-indexed.
239 my $self = shift or return;
240 my $array_var = shift or return;
241 my ($start, $end) = @_;
242 $self->{$array_var} or return [];
243 $start = 1 unless defined($start);
244 $end = scalar @{$self->{$array_var}} unless defined($end);
245 # syslog("LOG_DEBUG", "$array_var: start = %d, end = %d; items(%s)", $start, $end, join(', ', @{$self->{items}}));
247 return [@{$self->{$array_var}}[$start-1 .. $end-1]];
251 # List of outstanding holds placed
254 my $self = shift or return;
255 return $self->x_items('hold_items', @_);
259 my $self = shift or return;
260 return $self->x_items('overdue_items', @_);
263 my $self = shift or return;
264 return $self->x_items('items', @_);
267 my $self = shift or return;
268 return $self->x_items('fine_items', @_);
271 my $self = shift or return;
272 return $self->x_items('recall_items', @_);
275 my $self = shift or return;
276 return $self->x_items('unavail_holds', @_);
280 my ($self, $card_retained, $blocked_card_msg) = @_;
281 foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
284 $self->{screen_msg} = "Block feature not implemented"; # $blocked_card_msg || "Card Blocked. Please contact library staff";
285 # TODO: not really affecting patron record
291 foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
294 syslog("LOG_DEBUG", "Patron(%s)->enable: charge: %s, renew:%s, recall:%s, hold:%s",
295 $self->{id}, $self->{charge_ok}, $self->{renew_ok},
296 $self->{recall_ok}, $self->{hold_ok});
297 $self->{screen_msg} = "Enable feature not implemented."; # "All privileges restored."; # TODO: not really affecting patron record
301 sub inet_privileges {
303 return $self->{inet} ? 'Y' : 'N';
308 return C4::Context->preference("noissuescharge") || 5;
312 my $self = shift or return;
313 return ($self->fee_amount and $self->fee_amount > $self->fee_limit);
315 sub excessive_fines {
316 my $self = shift or return;
317 return $self->excessive_fees; # excessive_fines is the same thing as excessive_fees for Koha
322 unless ($self->{library_name}) {
323 $self->{library_name} = GetBranchName($self->{branchcode});
325 return $self->{library_name};
332 return "Please contact library staff";
336 return "Please contact library staff";
344 our %patron_example = (
346 name => "David J. Fiander",
349 ptype => 'A', # 'A'dult. Whatever.
350 birthdate => '19640925',
351 address => '2 Meadowvale Dr. St Thomas, ON',
352 home_phone => '(519) 555 1234',
353 email_addr => 'djfiander@hotmail.com',
359 claims_returned => 0,
369 fine_items => ['Computer Time'],
376 From borrowers table:
377 +---------------------+--------------+------+-----+
378 | Field | Type | Null | Key |
379 +---------------------+--------------+------+-----+
380 | borrowernumber | int(11) | NO | PRI |
381 | cardnumber | varchar(16) | YES | UNI |
382 | surname | mediumtext | NO | |
383 | firstname | text | YES | |
384 | title | mediumtext | YES | |
385 | othernames | mediumtext | YES | |
386 | initials | text | YES | |
387 | streetnumber | varchar(10) | YES | |
388 | streettype | varchar(50) | YES | |
389 | address | mediumtext | NO | |
390 | address2 | text | YES | |
391 | city | mediumtext | NO | |
392 | zipcode | varchar(25) | YES | |
393 | country | text | 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_address2 | text | YES | |
404 | B_city | mediumtext | YES | |
405 | B_zipcode | varchar(25) | YES | |
406 | B_country | text | YES | |
407 | B_email | text | YES | |
408 | B_phone | mediumtext | YES | |
409 | dateofbirth | date | YES | |
410 | branchcode | varchar(10) | NO | MUL |
411 | categorycode | varchar(10) | NO | MUL |
412 | dateenrolled | date | YES | |
413 | dateexpiry | date | YES | |
414 | gonenoaddress | tinyint(1) | YES | |
415 | lost | tinyint(1) | YES | |
416 | debarred | tinyint(1) | YES | |
417 | contactname | mediumtext | YES | |
418 | contactfirstname | text | YES | |
419 | contacttitle | text | YES | |
420 | guarantorid | int(11) | YES | |
421 | borrowernotes | mediumtext | YES | |
422 | relationship | varchar(100) | YES | |
423 | ethnicity | varchar(50) | YES | |
424 | ethnotes | varchar(255) | YES | |
425 | sex | varchar(1) | YES | |
426 | password | varchar(30) | YES | |
427 | flags | int(11) | YES | |
428 | userid | varchar(30) | YES | MUL |
429 | opacnote | mediumtext | YES | |
430 | contactnote | varchar(255) | YES | |
431 | sort1 | varchar(80) | YES | |
432 | sort2 | varchar(80) | YES | |
433 | altcontactfirstname | varchar(255) | YES | |
434 | altcontactsurname | varchar(255) | YES | |
435 | altcontactaddress1 | varchar(255) | YES | |
436 | altcontactaddress2 | varchar(255) | YES | |
437 | altcontactaddress3 | varchar(255) | YES | |
438 | altcontactzipcode | varchar(50) | YES | |
439 | altcontactcountry | text | YES | |
440 | altcontactphone | varchar(50) | YES | |
441 | smsalertnumber | varchar(50) | YES | |
442 +---------------------+--------------+------+-----+
448 {message} Message showing patron's credit or debt
449 {noissues} Set if patron owes >$5.00
450 {GNA} Set if patron gone w/o address
451 {message} "Borrower has no valid address"
453 {LOST} Set if patron's card reported lost
454 {message} Message to this effect
456 {DBARRED} Set if patron is debarred
457 {message} Message to this effect
459 {NOTES} Set if patron has notes
460 {message} Notes about patron
461 {ODUES} Set if patron has overdue books
463 {itemlist} ref-to-array: list of overdue books
464 {itemlisttext} Text list of overdue items
465 {WAITING} Set if there are items available that the patron reserved
466 {message} Message to this effect
467 {itemlist} ref-to-array: list of available items