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