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 our $VERSION = 3.07.00.049;
28 our $kp; # koha patron
31 my ($class, $patron_id) = @_;
32 my $type = ref($class) || $class;
34 $kp = GetMember(cardnumber=>$patron_id);
35 $debug and warn "new Patron (GetMember): " . Dumper($kp);
36 unless (defined $kp) {
37 syslog("LOG_DEBUG", "new ILS::Patron(%s): no such patron", $patron_id);
40 $kp = GetMemberDetails(undef,$patron_id);
41 $debug and warn "new Patron (GetMemberDetails): " . Dumper($kp);
42 my $pw = $kp->{password}; ### FIXME - md5hash -- deal with .
43 my $flags = $kp->{flags}; # or warn "Warning: No flags from patron object for '$patron_id'";
44 my $debarred = $kp->{debarred}; # 1 if ($kp->{flags}->{DBARRED}->{noissues});
45 $debug and warn sprintf("Debarred = %s : ", ($debarred||'undef')) . Dumper(%{$kp->{flags}});
46 my ($day, $month, $year) = (localtime)[3,4,5];
47 my $today = sprintf '%04d-%02d-%02d', $year+1900, $month+1, $day;
48 my $expired = ($today gt $kp->{dateexpiry}) ? 1 : 0;
50 if ($kp->{opacnote} ) {
51 $kp->{opacnote} .= q{ };
53 $kp->{opacnote} .= 'PATRON EXPIRED';
56 my $adr = $kp->{streetnumber} || '';
57 my $address = $kp->{address} || '';
58 my $dob = $kp->{dateofbirth};
59 $dob and $dob =~ s/-//g; # YYYYMMDD
60 my $dexpiry = $kp->{dateexpiry};
61 $dexpiry and $dexpiry =~ s/-//g; # YYYYMMDD
62 $adr .= ($adr && $address) ? " $address" : $address;
63 my $fines_amount = $flags->{CHARGES}->{amount};
64 $fines_amount = ($fines_amount and $fines_amount > 0) ? $fines_amount : 0;
66 no warnings; # any of these $kp->{fields} being concat'd could be undef
68 getmemberdetails_object => $kp,
69 name => $kp->{firstname} . " " . $kp->{surname},
70 id => $kp->{cardnumber}, # to SIP, the id is the BARCODE, not userid
72 ptype => $kp->{categorycode}, # 'A'dult. Whatever.
73 dateexpiry => $dexpiry,
74 dateexpiry_iso => $kp->{dateexpiry},
76 birthdate_iso => $kp->{dateofbirth},
77 branchcode => $kp->{branchcode},
78 library_name => "", # only populated if needed, cached here
79 borrowernumber => $kp->{borrowernumber},
81 home_phone => $kp->{phone},
82 email_addr => $kp->{email},
83 charge_ok => ( !$debarred && !$expired ),
84 renew_ok => ( !$debarred && !$expired ),
85 recall_ok => ( !$debarred && !$expired ),
86 hold_ok => ( !$debarred && !$expired ),
87 card_lost => ( $kp->{lost} || $kp->{gonenoaddress} || $flags->{LOST} ),
89 fines => $fines_amount, # GetMemberAccountRecords($kp->{borrowernumber})
90 fees => 0, # currently not distinct from fines
93 screen_msg => 'Greetings from Koha. ' . $kp->{opacnote},
96 hold_items => $flags->{WAITING}{itemlist},
97 overdue_items => $flags->{ODUES}{itemlist},
101 inet => ( !$debarred && !$expired ),
105 $debug and warn "patron fines: $ilspatron{fines} ... amountoutstanding: $kp->{amountoutstanding} ... CHARGES->amount: $flags->{CHARGES}->{amount}";
106 for (qw(EXPIRED CHARGES CREDITS GNA LOST DBARRED NOTES)) {
107 ($flags->{$_}) or next;
108 if ($_ ne 'NOTES' and $flags->{$_}->{message}) {
109 $ilspatron{screen_msg} .= " -- " . $flags->{$_}->{message}; # show all but internal NOTES
111 if ($flags->{$_}->{noissues}) {
112 foreach my $toggle (qw(charge_ok renew_ok recall_ok hold_ok inet)) {
113 $ilspatron{$toggle} = 0; # if we get noissues, disable everything
118 # FIXME: populate fine_items recall_items
119 # $ilspatron{hold_items} = (GetReservesFromBorrowernumber($kp->{borrowernumber},'F'));
120 $ilspatron{unavail_holds} = [(GetReservesFromBorrowernumber($kp->{borrowernumber}))];
121 $ilspatron{items} = GetPendingIssues($kp->{borrowernumber});
123 $debug and warn Dumper($self);
124 syslog("LOG_DEBUG", "new ILS::Patron(%s): found patron '%s'", $patron_id,$self->{id});
144 charge_ok => 0, # for patron_status[0] (inverted)
145 renew_ok => 0, # for patron_status[1] (inverted)
146 recall_ok => 0, # for patron_status[2] (inverted)
147 hold_ok => 0, # for patron_status[3] (inverted)
148 card_lost => 0, # for patron_status[4]
154 too_many_charged => 0, # for patron_status[5]
155 too_many_overdue => 0, # for patron_status[6]
156 too_many_renewal => 0, # for patron_status[7]
157 too_many_claim_return => 0, # for patron_status[8]
158 too_many_lost => 0, # for patron_status[9]
159 # excessive_fines => 0, # for patron_status[10]
160 # excessive_fees => 0, # for patron_status[11]
161 recall_overdue => 0, # for patron_status[12]
162 too_many_billed => 0, # for patron_status[13]
163 inet => 0, # EnvisionWare extension
164 getmemberdetails_object => 0,
170 # be cool. needed for AUTOLOAD(?)
175 my $class = ref($self) or croak "$self is not an object";
176 my $name = $AUTOLOAD;
180 unless (exists $fields{$name}) {
181 croak "Cannot access '$name' field of class '$class'";
185 $fields{$name} or croak "Field '$name' of class '$class' is READ ONLY.";
186 return $self->{$name} = shift;
188 return $self->{$name};
193 my ($self, $pwd) = @_;
194 my $md5pwd = $self->{password};
195 # warn sprintf "check_password for %s: '%s' vs. '%s'",($self->{name}||''),($self->{password}||''),($pwd||'');
196 (defined $pwd ) or return 0; # you gotta give me something (at least ''), or no deal
197 (defined $md5pwd) or return($pwd eq ''); # if the record has a NULL password, accept '' as match
198 return (md5_base64($pwd) eq $md5pwd);
201 # A few special cases, not in AUTOLOADed %fields
204 if ( $self->{fines} ) {
205 return $self->{fines};
212 return $self->fee_amount;
217 return $self->{language} || '000'; # Unspecified
222 return $self->{expired};
226 # remove the hold on item item_id from my hold queue.
227 # return true if I was holding the item, false otherwise.
230 my ($self, $item_id) = @_;
233 foreach (qw(hold_items unavail_holds)) {
235 for (my $i = 0; $i < scalar @{$self->{$_}}; $i++) {
236 my $held_item = $self->{$_}[$i]->{item_id} or next;
237 if ($held_item eq $item_id) {
238 splice @{$self->{$_}}, $i, 1;
246 # Accessor method for array_ref values, designed to get the "start" and "end" values
247 # from the SIP request. Note those incoming values are 1-indexed, not 0-indexed.
251 my $array_var = shift or return;
252 my ($start, $end) = @_;
253 $self->{$array_var} or return [];
254 $start = 1 unless defined($start);
255 $end = scalar @{$self->{$array_var}} unless defined($end);
256 # syslog("LOG_DEBUG", "$array_var: start = %d, end = %d; items(%s)", $start, $end, join(', ', @{$self->{items}}));
258 return [@{$self->{$array_var}}[$start-1 .. $end-1]];
262 # List of outstanding holds placed
266 return $self->x_items('hold_items', @_);
271 return $self->x_items('overdue_items', @_);
275 return $self->x_items('items', @_);
279 return $self->x_items('fine_items', @_);
283 return $self->x_items('recall_items', @_);
287 return $self->x_items('unavail_holds', @_);
291 my ($self, $card_retained, $blocked_card_msg) = @_;
292 foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
295 $self->{screen_msg} = "Block feature not implemented"; # $blocked_card_msg || "Card Blocked. Please contact library staff";
296 # TODO: not really affecting patron record
302 foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
305 syslog("LOG_DEBUG", "Patron(%s)->enable: charge: %s, renew:%s, recall:%s, hold:%s",
306 $self->{id}, $self->{charge_ok}, $self->{renew_ok},
307 $self->{recall_ok}, $self->{hold_ok});
308 $self->{screen_msg} = "Enable feature not implemented."; # "All privileges restored."; # TODO: not really affecting patron record
312 sub inet_privileges {
314 return $self->{inet} ? 'Y' : 'N';
319 return C4::Context->preference("noissuescharge") || 5;
324 return ($self->fee_amount and $self->fee_amount > $self->fee_limit);
326 sub excessive_fines {
328 return $self->excessive_fees; # excessive_fines is the same thing as excessive_fees for Koha
333 unless ($self->{library_name}) {
334 $self->{library_name} = GetBranchName($self->{branchcode});
336 return $self->{library_name};
344 return "Please contact library staff";
349 return "Please contact library staff";
357 our %patron_example = (
359 name => "David J. Fiander",
362 ptype => 'A', # 'A'dult. Whatever.
363 birthdate => '19640925',
364 address => '2 Meadowvale Dr. St Thomas, ON',
365 home_phone => '(519) 555 1234',
366 email_addr => 'djfiander@hotmail.com',
372 claims_returned => 0,
382 fine_items => ['Computer Time'],
389 From borrowers table:
390 +---------------------+--------------+------+-----+---------+----------------+
391 | Field | Type | Null | Key | Default | Extra |
392 +---------------------+--------------+------+-----+---------+----------------+
393 | borrowernumber | int(11) | NO | PRI | NULL | auto_increment |
394 | cardnumber | varchar(16) | YES | UNI | NULL | |
395 | surname | mediumtext | NO | | NULL | |
396 | firstname | text | YES | | NULL | |
397 | title | mediumtext | YES | | NULL | |
398 | othernames | mediumtext | YES | | NULL | |
399 | initials | text | YES | | NULL | |
400 | streetnumber | varchar(10) | YES | | NULL | |
401 | streettype | varchar(50) | YES | | NULL | |
402 | address | mediumtext | NO | | NULL | |
403 | address2 | text | YES | | NULL | |
404 | city | mediumtext | NO | | NULL | |
405 | state | mediumtext | YES | | NULL | |
406 | zipcode | varchar(25) | YES | | NULL | |
407 | country | text | YES | | NULL | |
408 | email | mediumtext | YES | | NULL | |
409 | phone | text | YES | | NULL | |
410 | mobile | varchar(50) | YES | | NULL | |
411 | fax | mediumtext | YES | | NULL | |
412 | emailpro | text | YES | | NULL | |
413 | phonepro | text | YES | | NULL | |
414 | B_streetnumber | varchar(10) | YES | | NULL | |
415 | B_streettype | varchar(50) | YES | | NULL | |
416 | B_address | varchar(100) | YES | | NULL | |
417 | B_address2 | text | YES | | NULL | |
418 | B_city | mediumtext | YES | | NULL | |
419 | B_state | mediumtext | YES | | NULL | |
420 | B_zipcode | varchar(25) | YES | | NULL | |
421 | B_country | text | YES | | NULL | |
422 | B_email | text | YES | | NULL | |
423 | B_phone | mediumtext | YES | | NULL | |
424 | dateofbirth | date | YES | | NULL | |
425 | branchcode | varchar(10) | NO | MUL | | |
426 | categorycode | varchar(10) | NO | MUL | | |
427 | dateenrolled | date | YES | | NULL | |
428 | dateexpiry | date | YES | | NULL | |
429 | gonenoaddress | tinyint(1) | YES | | NULL | |
430 | lost | tinyint(1) | YES | | NULL | |
431 | debarred | tinyint(1) | YES | | NULL | |
432 | contactname | mediumtext | YES | | NULL | |
433 | contactfirstname | text | YES | | NULL | |
434 | contacttitle | text | YES | | NULL | |
435 | guarantorid | int(11) | YES | MUL | NULL | |
436 | borrowernotes | mediumtext | YES | | NULL | |
437 | relationship | varchar(100) | YES | | NULL | |
438 | ethnicity | varchar(50) | YES | | NULL | |
439 | ethnotes | varchar(255) | YES | | NULL | |
440 | sex | varchar(1) | YES | | NULL | |
441 | password | varchar(30) | YES | | NULL | |
442 | flags | int(11) | YES | | NULL | |
443 | userid | varchar(30) | YES | MUL | NULL | |
444 | opacnote | mediumtext | YES | | NULL | |
445 | contactnote | varchar(255) | YES | | NULL | |
446 | sort1 | varchar(80) | YES | | NULL | |
447 | sort2 | varchar(80) | YES | | NULL | |
448 | altcontactfirstname | varchar(255) | YES | | NULL | |
449 | altcontactsurname | varchar(255) | YES | | NULL | |
450 | altcontactaddress1 | varchar(255) | YES | | NULL | |
451 | altcontactaddress2 | varchar(255) | YES | | NULL | |
452 | altcontactaddress3 | varchar(255) | YES | | NULL | |
453 | altcontactstate | mediumtext | YES | | NULL | |
454 | altcontactzipcode | varchar(50) | YES | | NULL | |
455 | altcontactcountry | text | YES | | NULL | |
456 | altcontactphone | varchar(50) | YES | | NULL | |
457 | smsalertnumber | varchar(50) | YES | | NULL | |
458 | privacy | int(11) | NO | | 1 | |
459 +---------------------+--------------+------+-----+---------+----------------+
466 {message} Message showing patron's credit or debt
467 {noissues} Set if patron owes >$5.00
468 {GNA} Set if patron gone w/o address
469 {message} "Borrower has no valid address"
471 {LOST} Set if patron's card reported lost
472 {message} Message to this effect
474 {DBARRED} Set if patron is debarred
475 {message} Message to this effect
477 {NOTES} Set if patron has notes
478 {message} Notes about patron
479 {ODUES} Set if patron has overdue books
481 {itemlist} ref-to-array: list of overdue books
482 {itemlisttext} Text list of overdue items
483 {WAITING} Set if there are items available that the patron reserved
484 {message} Message to this effect
485 {itemlist} ref-to-array: list of available items