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 our $VERSION = 3.07.00.049;
  27
  28 our $kp;    # koha patron
  29
  30 sub new {
  31     my ($class, $patron_id) = @_;
  32     my $type = ref($class) || $class;
  33     my $self;
  34     $kp = GetMember(cardnumber=>$patron_id) || GetMember(userid=>$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);
  38         return;
  39     }
  40     $kp = GetMemberDetails($kp->{borrowernumber});
  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;
  49     if ($expired) {
  50         if ($kp->{opacnote} ) {
  51             $kp->{opacnote} .= q{ };
  52         }
  53         $kp->{opacnote} .= 'PATRON EXPIRED';
  54     }
  55     my %ilspatron;
  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;
  65     {
  66     no warnings;    # any of these $kp->{fields} being concat'd could be undef
  67     %ilspatron = (
  68         getmemberdetails_object => $kp,
  69         name => $kp->{firstname} . " " . $kp->{surname},
  70         id   => $kp->{cardnumber},    # to SIP, the id is the BARCODE, not userid
  71         password        => $pw,
  72         ptype           => $kp->{categorycode},     # 'A'dult.  Whatever.
  73         dateexpiry      => $dexpiry,
  74         dateexpiry_iso  => $kp->{dateexpiry},
  75         birthdate       => $dob,
  76         birthdate_iso   => $kp->{dateofbirth},
  77         branchcode      => $kp->{branchcode},
  78         library_name    => "",                      # only populated if needed, cached here
  79         borrowernumber  => $kp->{borrowernumber},
  80         address         => $adr,
  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} ),
  88         claims_returned => 0,
  89         fines           => $fines_amount, # GetMemberAccountRecords($kp->{borrowernumber})
  90         fees            => 0,             # currently not distinct from fines
  91         recall_overdue  => 0,
  92         items_billed    => 0,
  93         screen_msg      => 'Greetings from Koha. ' . $kp->{opacnote},
  94         print_line      => '',
  95         items           => [],
  96         hold_items      => $flags->{WAITING}{itemlist},
  97         overdue_items   => $flags->{ODUES}{itemlist},
  98         fine_items      => [],
  99         recall_items    => [],
 100         unavail_holds   => [],
 101         inet            => ( !$debarred && !$expired ),
 102         expired         => $expired,
 103     );
 104     }
 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
 110         }
 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
 114             }
 115         }
 116     }
 117
 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});
 122     $self = \%ilspatron;
 123     $debug and warn Dumper($self);
 124     syslog("LOG_DEBUG", "new ILS::Patron(%s): found patron '%s'", $patron_id,$self->{id});
 125     bless $self, $type;
 126     return $self;
 127 }
 128
 129
 130 # 0 means read-only
 131 # 1 means read/write
 132
 133 my %fields = (
 134     id                      => 0,
 135     name                    => 0,
 136     address                 => 0,
 137     email_addr              => 0,
 138     home_phone              => 0,
 139     birthdate               => 0,
 140     birthdate_iso           => 0,
 141     dateexpiry              => 0,
 142     dateexpiry_iso          => 0,
 143     ptype                   => 0,
 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]
 149     recall_overdue          => 0,
 150     currency                => 1,
 151 #   fee_limit               => 0,
 152     screen_msg              => 1,
 153     print_line              => 1,
 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,
 165 );
 166
 167 our $AUTOLOAD;
 168
 169 sub DESTROY {
 170     # be cool.  needed for AUTOLOAD(?)
 171 }
 172
 173 sub AUTOLOAD {
 174     my $self = shift;
 175     my $class = ref($self) or croak "$self is not an object";
 176     my $name = $AUTOLOAD;
 177
 178     $name =~ s/.*://;
 179
 180     unless (exists $fields{$name}) {
 181         croak "Cannot access '$name' field of class '$class'";
 182     }
 183
 184     if (@_) {
 185         $fields{$name} or croak "Field '$name' of class '$class' is READ ONLY.";
 186         return $self->{$name} = shift;
 187     } else {
 188         return $self->{$name};
 189     }
 190 }
 191
 192 sub check_password {
 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);
 199 }
 200
 201 # A few special cases, not in AUTOLOADed %fields
 202 sub fee_amount {
 203     my $self = shift;
 204     if ( $self->{fines} ) {
 205         return $self->{fines};
 206     }
 207     return;
 208 }
 209
 210 sub fines_amount {
 211     my $self = shift;
 212     return $self->fee_amount;
 213 }
 214
 215 sub language {
 216     my $self = shift;
 217     return $self->{language} || '000'; # Unspecified
 218 }
 219
 220 sub expired {
 221     my $self = shift;
 222     return $self->{expired};
 223 }
 224
 225 #
 226 # remove the hold on item item_id from my hold queue.
 227 # return true if I was holding the item, false otherwise.
 228 #
 229 sub drop_hold {
 230     my ($self, $item_id) = @_;
 231     return if !$item_id;
 232     my $result = 0;
 233     foreach (qw(hold_items unavail_holds)) {
 234         $self->{$_} or next;
 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;
 239                 $result++;
 240             }
 241         }
 242     }
 243     return $result;
 244 }
 245
 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.
 248 #
 249 sub x_items {
 250     my $self      = shift;
 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}}));
 257
 258     return [@{$self->{$array_var}}[$start-1 .. $end-1]];
 259 }
 260
 261 #
 262 # List of outstanding holds placed
 263 #
 264 sub hold_items {
 265     my $self = shift;
 266     return $self->x_items('hold_items', @_);
 267 }
 268
 269 sub overdue_items {
 270     my $self = shift;
 271     return $self->x_items('overdue_items', @_);
 272 }
 273 sub charged_items {
 274     my $self = shift;
 275     return $self->x_items('items', @_);
 276 }
 277 sub fine_items {
 278     my $self = shift;
 279     return $self->x_items('fine_items', @_);
 280 }
 281 sub recall_items {
 282     my $self = shift;
 283     return $self->x_items('recall_items', @_);
 284 }
 285 sub unavail_holds {
 286     my $self = shift;
 287     return $self->x_items('unavail_holds', @_);
 288 }
 289
 290 sub block {
 291     my ($self, $card_retained, $blocked_card_msg) = @_;
 292     foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
 293         $self->{$field} = 0;
 294     }
 295     $self->{screen_msg} = "Block feature not implemented";  # $blocked_card_msg || "Card Blocked.  Please contact library staff";
 296     # TODO: not really affecting patron record
 297     return $self;
 298 }
 299
 300 sub enable {
 301     my $self = shift;
 302     foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
 303         $self->{$field} = 1;
 304     }
 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
 309     return $self;
 310 }
 311
 312 sub inet_privileges {
 313     my $self = shift;
 314     return $self->{inet} ? 'Y' : 'N';
 315 }
 316
 317 sub fee_limit {
 318     my $self = shift;
 319     return C4::Context->preference("noissuescharge") || 5;
 320 }
 321
 322 sub excessive_fees {
 323     my $self = shift;
 324     return ($self->fee_amount and $self->fee_amount > $self->fee_limit);
 325 }
 326 sub excessive_fines {
 327     my $self = shift;
 328     return $self->excessive_fees;   # excessive_fines is the same thing as excessive_fees for Koha
 329 }
 330
 331 sub library_name {
 332     my $self = shift;
 333     unless ($self->{library_name}) {
 334         $self->{library_name} = GetBranchName($self->{branchcode});
 335     }
 336     return $self->{library_name};
 337 }
 338 #
 339 # Messages
 340 #
 341
 342 sub invalid_patron {
 343     my $self = shift;
 344     return "Please contact library staff";
 345 }
 346
 347 sub charge_denied {
 348     my $self = shift;
 349     return "Please contact library staff";
 350 }
 351
 352 1;
 353 __END__
 354
 355 =head1 EXAMPLES
 356
 357   our %patron_example = (
 358           djfiander => {
 359               name => "David J. Fiander",
 360               id => 'djfiander',
 361               password => '6789',
 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',
 367               charge_ok => 1,
 368               renew_ok => 1,
 369               recall_ok => 0,
 370               hold_ok => 1,
 371               card_lost => 0,
 372               claims_returned => 0,
 373               fines => 100,
 374               fees => 0,
 375               recall_overdue => 0,
 376               items_billed => 0,
 377               screen_msg => '',
 378               print_line => '',
 379               items => [],
 380               hold_items => [],
 381               overdue_items => [],
 382               fine_items => ['Computer Time'],
 383               recall_items => [],
 384               unavail_holds => [],
 385               inet => 1,
 386           },
 387   );
 388
 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 +---------------------+--------------+------+-----+---------+----------------+
 460
 461
 462  From C4::Members
 463
 464  $flags->{KEY}
 465  {CHARGES}
 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"
 470     {noissues}    Set.
 471  {LOST}            Set if patron's card reported lost
 472     {message}     Message to this effect
 473     {noissues}    Set.
 474  {DBARRED}         Set if patron is debarred
 475     {message}     Message to this effect
 476     {noissues}    Set.
 477  {NOTES}           Set if patron has notes
 478     {message}     Notes about patron
 479  {ODUES}           Set if patron has overdue books
 480     {message}     "Yes"
 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
 486
 487 =cut
 488