Merge remote-tracking branch 'origin/new/bug_7805'
[koha.git] / C4 / SIP / ILS / Patron.pm
1 #
2 # ILS::Patron.pm
3
4 # A Class for hiding the ILS's concept of the patron from the OpenSIP
5 # system
6 #
7
8 package ILS::Patron;
9
10 use strict;
11 use warnings;
12 use Exporter;
13 use Carp;
14
15 use Sys::Syslog qw(syslog);
16 use Data::Dumper;
17
18 use C4::Debug;
19 use C4::Context;
20 use C4::Koha;
21 use C4::Members;
22 use C4::Reserves;
23 use C4::Branch qw(GetBranchName);
24 use Digest::MD5 qw(md5_base64);
25
26 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
27
28 BEGIN {
29     $VERSION = 3.07.00.049;
30         @ISA = qw(Exporter);
31         @EXPORT_OK = qw(invalid_patron);
32 }
33
34 our $kp;        # koha patron
35
36 sub new {
37         my ($class, $patron_id) = @_;
38     my $type = ref($class) || $class;
39     my $self;
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);
44         return;
45         }
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;
55     if ($expired) {
56         if ($kp->{opacnote} ) {
57             $kp->{opacnote} .= q{ };
58         }
59         $kp->{opacnote} .= 'PATRON EXPIRED';
60     }
61         my %ilspatron;
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;
71     {
72         no warnings;    # any of these $kp->{fields} being concat'd could be undef
73     %ilspatron = (
74         getmemberdetails_object => $kp,
75         name => $kp->{firstname} . " " . $kp->{surname},
76         id   => $kp->{cardnumber},    # to SIP, the id is the BARCODE, not userid
77         password        => $pw,
78         ptype           => $kp->{categorycode},     # 'A'dult.  Whatever.
79         dateexpiry      => $dexpiry,
80         dateexpiry_iso  => $kp->{dateexpiry},
81         birthdate       => $dob,
82         birthdate_iso   => $kp->{dateofbirth},
83         branchcode      => $kp->{branchcode},
84         library_name    => "",                      # only populated if needed, cached here
85         borrowernumber  => $kp->{borrowernumber},
86         address         => $adr,
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} ),
94         claims_returned => 0,
95         fines           => $fines_amount, # GetMemberAccountRecords($kp->{borrowernumber})
96         fees            => 0,             # currently not distinct from fines
97         recall_overdue  => 0,
98         items_billed    => 0,
99         screen_msg      => 'Greetings from Koha. ' . $kp->{opacnote},
100         print_line      => '',
101         items           => [],
102         hold_items      => $flags->{WAITING}{itemlist},
103         overdue_items   => $flags->{ODUES}{itemlist},
104         fine_items      => [],
105         recall_items    => [],
106         unavail_holds   => [],
107         inet            => ( !$debarred && !$expired ),
108         expired         => $expired,
109     );
110     }
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
116         }
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
120                         }
121                 }
122         }
123
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});
128         $self = \%ilspatron;
129         $debug and warn Dumper($self);
130     syslog("LOG_DEBUG", "new ILS::Patron(%s): found patron '%s'", $patron_id,$self->{id});
131     bless $self, $type;
132     return $self;
133 }
134
135
136 # 0 means read-only
137 # 1 means read/write
138
139 my %fields = (
140     id                      => 0,
141     name                    => 0,
142     address                 => 0,
143     email_addr              => 0,
144     home_phone              => 0,
145     birthdate               => 0,
146     birthdate_iso           => 0,
147     dateexpiry              => 0,
148     dateexpiry_iso          => 0,
149     ptype                   => 0,
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]
155     recall_overdue          => 0,
156     currency                => 1,
157 #   fee_limit               => 0,
158     screen_msg              => 1,
159     print_line              => 1,
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,
171 );
172
173 our $AUTOLOAD;
174
175 sub DESTROY {
176     # be cool.  needed for AUTOLOAD(?)
177 }
178
179 sub AUTOLOAD {
180     my $self = shift;
181     my $class = ref($self) or croak "$self is not an object";
182     my $name = $AUTOLOAD;
183
184     $name =~ s/.*://;
185
186     unless (exists $fields{$name}) {
187                 croak "Cannot access '$name' field of class '$class'";
188     }
189
190         if (@_) {
191         $fields{$name} or croak "Field '$name' of class '$class' is READ ONLY.";
192                 return $self->{$name} = shift;
193         } else {
194                 return $self->{$name};
195         }
196 }
197
198 sub check_password {
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);
205 }
206
207 # A few special cases, not in AUTOLOADed %fields
208 sub fee_amount {
209     my $self = shift;
210     if ( $self->{fines} ) {
211         return $self->{fines};
212     }
213     return;
214 }
215
216 sub fines_amount {
217     my $self = shift;
218     return $self->fee_amount;
219 }
220
221 sub language {
222     my $self = shift;
223     return $self->{language} || '000'; # Unspecified
224 }
225
226 sub expired {
227     my $self = shift;
228     return $self->{expired};
229 }
230
231 #
232 # remove the hold on item item_id from my hold queue.
233 # return true if I was holding the item, false otherwise.
234
235 sub drop_hold {
236     my ($self, $item_id) = @_;
237     return if !$item_id;
238         my $result = 0;
239         foreach (qw(hold_items unavail_holds)) {
240                 $self->{$_} or next;
241                 for (my $i = 0; $i < scalar @{$self->{$_}}; $i++) {
242                         my $held_item = $self->{$_}[$i]->{item_id} or next;
243                         if ($held_item eq $item_id) {
244                                 splice @{$self->{$_}}, $i, 1;
245                                 $result++;
246                         }
247                 }
248         }
249     return $result;
250 }
251
252 # Accessor method for array_ref values, designed to get the "start" and "end" values
253 # from the SIP request.  Note those incoming values are 1-indexed, not 0-indexed.
254 #
255 sub x_items {
256     my $self      = shift or return;
257     my $array_var = shift or return;
258     my ($start, $end) = @_;
259         $self->{$array_var} or return [];
260     $start = 1 unless defined($start);
261     $end   = scalar @{$self->{$array_var}} unless defined($end);
262     # syslog("LOG_DEBUG", "$array_var: start = %d, end = %d; items(%s)", $start, $end, join(', ', @{$self->{items}}));
263
264     return [@{$self->{$array_var}}[$start-1 .. $end-1]];
265 }
266
267 #
268 # List of outstanding holds placed
269 #
270 sub hold_items {
271     my $self = shift or return;
272     return $self->x_items('hold_items', @_);
273 }
274
275 sub overdue_items {
276     my $self = shift or return;
277     return $self->x_items('overdue_items', @_);
278 }
279 sub charged_items {
280     my $self = shift or return;
281     return $self->x_items('items', @_);
282 }
283 sub fine_items {
284     my $self = shift or return;
285     return $self->x_items('fine_items', @_);
286 }
287 sub recall_items {
288     my $self = shift or return;
289     return $self->x_items('recall_items', @_);
290 }
291 sub unavail_holds {
292     my $self = shift or return;
293     return $self->x_items('unavail_holds', @_);
294 }
295
296 sub block {
297     my ($self, $card_retained, $blocked_card_msg) = @_;
298     foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
299                 $self->{$field} = 0;
300     }
301     $self->{screen_msg} = "Block feature not implemented";  # $blocked_card_msg || "Card Blocked.  Please contact library staff";
302     # TODO: not really affecting patron record
303     return $self;
304 }
305
306 sub enable {
307     my $self = shift;
308     foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
309                 $self->{$field} = 1;
310     }
311     syslog("LOG_DEBUG", "Patron(%s)->enable: charge: %s, renew:%s, recall:%s, hold:%s",
312            $self->{id}, $self->{charge_ok}, $self->{renew_ok},
313            $self->{recall_ok}, $self->{hold_ok});
314     $self->{screen_msg} = "Enable feature not implemented."; # "All privileges restored.";   # TODO: not really affecting patron record
315     return $self;
316 }
317
318 sub inet_privileges {
319     my $self = shift;
320     return $self->{inet} ? 'Y' : 'N';
321 }
322
323 sub fee_limit {
324     # my $self = shift;
325     return C4::Context->preference("noissuescharge") || 5;
326 }
327
328 sub excessive_fees {
329     my $self = shift or return;
330     return ($self->fee_amount and $self->fee_amount > $self->fee_limit);
331 }
332 sub excessive_fines {
333     my $self = shift or return;
334     return $self->excessive_fees;   # excessive_fines is the same thing as excessive_fees for Koha
335 }
336     
337 sub library_name {
338     my $self = shift;
339     unless ($self->{library_name}) {
340         $self->{library_name} = GetBranchName($self->{branchcode});
341     }
342     return $self->{library_name};
343 }
344 #
345 # Messages
346 #
347
348 sub invalid_patron {
349     return "Please contact library staff";
350 }
351
352 sub charge_denied {
353     return "Please contact library staff";
354 }
355
356 1;
357 __END__
358
359 =head1 EXAMPLES
360
361   our %patron_example = (
362                   djfiander => {
363                       name => "David J. Fiander",
364                       id => 'djfiander',
365                       password => '6789',
366                       ptype => 'A', # 'A'dult.  Whatever.
367                       birthdate => '19640925',
368                       address => '2 Meadowvale Dr. St Thomas, ON',
369                       home_phone => '(519) 555 1234',
370                       email_addr => 'djfiander@hotmail.com',
371                       charge_ok => 1,
372                       renew_ok => 1,
373                       recall_ok => 0,
374                       hold_ok => 1,
375                       card_lost => 0,
376                       claims_returned => 0,
377                       fines => 100,
378                       fees => 0,
379                       recall_overdue => 0,
380                       items_billed => 0,
381                       screen_msg => '',
382                       print_line => '',
383                       items => [],
384                       hold_items => [],
385                       overdue_items => [],
386                       fine_items => ['Computer Time'],
387                       recall_items => [],
388                       unavail_holds => [],
389                       inet => 1,
390                   },
391   );
392
393  From borrowers table:
394 +---------------------+--------------+------+-----+---------+----------------+
395 | Field               | Type         | Null | Key | Default | Extra          |
396 +---------------------+--------------+------+-----+---------+----------------+
397 | borrowernumber      | int(11)      | NO   | PRI | NULL    | auto_increment |
398 | cardnumber          | varchar(16)  | YES  | UNI | NULL    |                |
399 | surname             | mediumtext   | NO   |     | NULL    |                |
400 | firstname           | text         | YES  |     | NULL    |                |
401 | title               | mediumtext   | YES  |     | NULL    |                |
402 | othernames          | mediumtext   | YES  |     | NULL    |                |
403 | initials            | text         | YES  |     | NULL    |                |
404 | streetnumber        | varchar(10)  | YES  |     | NULL    |                |
405 | streettype          | varchar(50)  | YES  |     | NULL    |                |
406 | address             | mediumtext   | NO   |     | NULL    |                |
407 | address2            | text         | YES  |     | NULL    |                |
408 | city                | mediumtext   | NO   |     | NULL    |                |
409 | state               | mediumtext   | YES  |     | NULL    |                |
410 | zipcode             | varchar(25)  | YES  |     | NULL    |                |
411 | country             | text         | YES  |     | NULL    |                |
412 | email               | mediumtext   | YES  |     | NULL    |                |
413 | phone               | text         | YES  |     | NULL    |                |
414 | mobile              | varchar(50)  | YES  |     | NULL    |                |
415 | fax                 | mediumtext   | YES  |     | NULL    |                |
416 | emailpro            | text         | YES  |     | NULL    |                |
417 | phonepro            | text         | YES  |     | NULL    |                |
418 | B_streetnumber      | varchar(10)  | YES  |     | NULL    |                |
419 | B_streettype        | varchar(50)  | YES  |     | NULL    |                |
420 | B_address           | varchar(100) | YES  |     | NULL    |                |
421 | B_address2          | text         | YES  |     | NULL    |                |
422 | B_city              | mediumtext   | YES  |     | NULL    |                |
423 | B_state             | mediumtext   | YES  |     | NULL    |                |
424 | B_zipcode           | varchar(25)  | YES  |     | NULL    |                |
425 | B_country           | text         | YES  |     | NULL    |                |
426 | B_email             | text         | YES  |     | NULL    |                |
427 | B_phone             | mediumtext   | YES  |     | NULL    |                |
428 | dateofbirth         | date         | YES  |     | NULL    |                |
429 | branchcode          | varchar(10)  | NO   | MUL |         |                |
430 | categorycode        | varchar(10)  | NO   | MUL |         |                |
431 | dateenrolled        | date         | YES  |     | NULL    |                |
432 | dateexpiry          | date         | YES  |     | NULL    |                |
433 | gonenoaddress       | tinyint(1)   | YES  |     | NULL    |                |
434 | lost                | tinyint(1)   | YES  |     | NULL    |                |
435 | debarred            | tinyint(1)   | YES  |     | NULL    |                |
436 | contactname         | mediumtext   | YES  |     | NULL    |                |
437 | contactfirstname    | text         | YES  |     | NULL    |                |
438 | contacttitle        | text         | YES  |     | NULL    |                |
439 | guarantorid         | int(11)      | YES  | MUL | NULL    |                |
440 | borrowernotes       | mediumtext   | YES  |     | NULL    |                |
441 | relationship        | varchar(100) | YES  |     | NULL    |                |
442 | ethnicity           | varchar(50)  | YES  |     | NULL    |                |
443 | ethnotes            | varchar(255) | YES  |     | NULL    |                |
444 | sex                 | varchar(1)   | YES  |     | NULL    |                |
445 | password            | varchar(30)  | YES  |     | NULL    |                |
446 | flags               | int(11)      | YES  |     | NULL    |                |
447 | userid              | varchar(30)  | YES  | MUL | NULL    |                |
448 | opacnote            | mediumtext   | YES  |     | NULL    |                |
449 | contactnote         | varchar(255) | YES  |     | NULL    |                |
450 | sort1               | varchar(80)  | YES  |     | NULL    |                |
451 | sort2               | varchar(80)  | YES  |     | NULL    |                |
452 | altcontactfirstname | varchar(255) | YES  |     | NULL    |                |
453 | altcontactsurname   | varchar(255) | YES  |     | NULL    |                |
454 | altcontactaddress1  | varchar(255) | YES  |     | NULL    |                |
455 | altcontactaddress2  | varchar(255) | YES  |     | NULL    |                |
456 | altcontactaddress3  | varchar(255) | YES  |     | NULL    |                |
457 | altcontactstate     | mediumtext   | YES  |     | NULL    |                |
458 | altcontactzipcode   | varchar(50)  | YES  |     | NULL    |                |
459 | altcontactcountry   | text         | YES  |     | NULL    |                |
460 | altcontactphone     | varchar(50)  | YES  |     | NULL    |                |
461 | smsalertnumber      | varchar(50)  | YES  |     | NULL    |                |
462 | privacy             | int(11)      | NO   |     | 1       |                |
463 +---------------------+--------------+------+-----+---------+----------------+
464
465
466  From C4::Members
467
468  $flags->{KEY}
469  {CHARGES}
470         {message}     Message showing patron's credit or debt
471         {noissues}    Set if patron owes >$5.00
472  {GNA}          Set if patron gone w/o address
473         {message}     "Borrower has no valid address"
474         {noissues}    Set.
475  {LOST}         Set if patron's card reported lost
476         {message}     Message to this effect
477         {noissues}    Set.
478  {DBARRED}      Set if patron is debarred
479         {message}     Message to this effect
480         {noissues}    Set.
481  {NOTES}        Set if patron has notes
482         {message}     Notes about patron
483  {ODUES}        Set if patron has overdue books
484         {message}     "Yes"
485         {itemlist}    ref-to-array: list of overdue books
486         {itemlisttext}    Text list of overdue items
487  {WAITING}      Set if there are items available that the patron reserved
488         {message}     Message to this effect
489         {itemlist}    ref-to-array: list of available items
490
491 =cut
492