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
  14 use Sys::Syslog qw(syslog);
  15 use Data::Dumper;
  16
  17 use C4::Context;
  18 use C4::Koha;
  19 use C4::Members;
  20 use Digest::MD5 qw(md5_base64);
  21
  22 our (@ISA, @EXPORT_OK);
  23
  24 @ISA = qw(Exporter);
  25
  26 @EXPORT_OK = qw(invalid_patron);
  27
  28 our %patron_example = (
  29                   djfiander => {
  30                       name => "David J. Fiander",
  31                       id => 'djfiander',
  32                       password => '6789',
  33                       ptype => 'A', # 'A'dult.  Whatever.
  34                       birthdate => '19640925',
  35                       address => '2 Meadowvale Dr. St Thomas, ON',
  36                       home_phone => '(519) 555 1234',
  37                       email_addr => 'djfiander@hotmail.com',
  38                       charge_ok => 1,
  39                       renew_ok => 1,
  40                       recall_ok => 0,
  41                       hold_ok => 1,
  42                       card_lost => 0,
  43                       claims_returned => 0,
  44                       fines => 100,
  45                       fees => 0,
  46                       recall_overdue => 0,
  47                       items_billed => 0,
  48                       screen_msg => '',
  49                       print_line => '',
  50                       items => [],
  51                       hold_items => [],
  52                       overdue_items => [],
  53                       fine_items => ['Computer Time'],
  54                       recall_items => [],
  55                       unavail_holds => [],
  56                       inet => 1,
  57                   },
  58                   );
  59
  60 sub new {
  61     my ($class, $patron_id) = @_;
  62     my $type = ref($class) || $class;
  63     my $self;
  64 my %ilspatron;
  65         my $kp = GetMember($patron_id,'cardnumber');
  66 warn "THIS IS what we et from getmember...";
  67 use Data::Dumper;
  68 warn Dumper($kp);
  69     if ($kp) {
  70         my $pw = $kp->{password};    ## FIXME - md5hash -- deal with .
  71         my $dob= $kp->{dateofbirth};
  72         $dob =~ s/\-//g;
  73 my $fines_out = GetMemberAccountRecords($kp->{borrowernumber});
  74 my ($num_cur_issues,$cur_issues) = GetPendingIssues($kp->{borrowernumber});
  75
  76         my $debarred = $kp->{debarred}; ### 1 if ($kp->{flags}->{DBARRED}->{noissues});
  77 warn "i am debarred: $debarred";
  78 #warn Dumper(%{$kp->{flags}});
  79         my $adr = $kp->{streetnumber} . " ". $kp->{address};
  80                 %ilspatron = (
  81                       name => $kp->{firstname} . " " . $kp->{surname},
  82                       id => $kp->{cardnumber},
  83                       password => $pw,
  84                       ptype => $kp->{categorycode}, # 'A'dult.  Whatever.
  85                       birthdate => $kp->{dateofbirth}, ##$dob,
  86                       address => $adr,
  87                       home_phone => $kp->{phone},
  88                       email_addr => $kp->{email},
  89                       charge_ok => (!$debarred) , ##  (C4::Context->preference('FinesMode') eq 'charge') || 0,
  90                       renew_ok => 1,
  91                           recall_ok => 1,
  92                       hold_ok => 1,
  93                       card_lost => ($kp->{lost} || $kp->{gonenoaddress}) ,
  94                       claims_returned => 0,
  95                       fines => $fines_out,
  96                       fees => 0,
  97                       recall_overdue => 0,
  98                       items_billed => 0,
  99                       screen_msg => 'Greetings from Koha',
 100                       print_line => '',
 101                       items => ['one item','itemstring 2'] ,
 102                       hold_items => [],#$kp->{flags}->{WAITING}{itemlist}->{biblionumber},
 103                       overdue_items =>[], # [$kp->{flags}->{ODUES}{itemlisttext}],   ### FIXME -> this should be array, not texts string.
 104                       fine_items => [],
 105                       recall_items => [],
 106                       unavail_holds => [],
 107                       inet => '',
 108                           );
 109         } else {
 110                 syslog("LOG_DEBUG", "new ILS::Patron(%s): no such patron", $patron_id);
 111                 return undef;
 112     }
 113
 114     $self =  \%ilspatron;
 115         warn Dumper($self);
 116
 117     syslog("LOG_DEBUG", "new ILS::Patron(%s): found patron '%s'", $patron_id,$self->{id});
 118
 119     bless $self, $type;
 120     return $self;
 121 }
 122
 123 sub id {
 124     my $self = shift;
 125
 126     return $self->{id};
 127 }
 128
 129 sub name {
 130     my $self = shift;
 131
 132     return $self->{name};
 133 }
 134
 135 sub address {
 136     my $self = shift;
 137
 138     return $self->{address};
 139 }
 140
 141 sub email_addr {
 142     my $self = shift;
 143
 144     return $self->{email_addr};
 145 }
 146
 147 sub home_phone {
 148     my $self = shift;
 149
 150     return $self->{home_phone};
 151 }
 152
 153 sub sip_birthdate {
 154     my $self = shift;
 155
 156     return $self->{birthdate};
 157 }
 158
 159 sub ptype {
 160     my $self = shift;
 161
 162     return $self->{ptype};
 163 }
 164
 165 sub language {
 166     my $self = shift;
 167
 168     return $self->{language} || '000'; # Unspecified
 169 }
 170
 171 sub charge_ok {
 172     my $self = shift;
 173
 174     return $self->{charge_ok};
 175 }
 176
 177 sub renew_ok {
 178     my $self = shift;
 179
 180     return $self->{renew_ok};
 181 }
 182
 183 sub recall_ok {
 184     my $self = shift;
 185
 186     return $self->{recall_ok};
 187 }
 188
 189 sub hold_ok {
 190     my $self = shift;
 191
 192     return $self->{hold_ok};
 193 }
 194
 195 sub card_lost {
 196     my $self = shift;
 197
 198     return $self->{card_lost};
 199 }
 200
 201 sub recall_overdue {
 202     my $self = shift;
 203
 204     return $self->{recall_overdue};
 205 }
 206
 207 sub check_password {
 208     my ($self, $pwd) = @_;
 209         my $md5pwd=$self->{password};  ### FIXME -  we're allowing access if user has no password.
 210
 211 return (!$self->{password} ||  md5_base64($pwd) eq $md5pwd );
 212 }
 213
 214 sub currency {
 215     my $self = shift;
 216
 217     return $self->{currency};
 218 }
 219
 220 sub fee_amount {
 221     my $self = shift;
 222
 223     return $self->{fee_amount} || undef;
 224 }
 225
 226 sub screen_msg {
 227     my $self = shift;
 228
 229     return $self->{screen_msg};
 230 }
 231
 232 sub print_line {
 233     my $self = shift;
 234
 235     return $self->{print_line};
 236 }
 237
 238 sub too_many_charged {
 239     my $self = shift;
 240
 241     return $self->{too_many_charged};
 242 }
 243
 244 sub too_many_overdue {
 245     my $self = shift;
 246
 247     return $self->{too_many_overdue};
 248 }
 249
 250 sub too_many_renewal {
 251     my $self = shift;
 252
 253     return $self->{too_many_renewal};
 254 }
 255
 256 sub too_many_claim_return {
 257     my $self = shift;
 258
 259     return $self->{too_many_claim_return};
 260 }
 261
 262 sub too_many_lost {
 263     my $self = shift;
 264
 265     return $self->{too_many_lost};
 266 }
 267
 268 sub excessive_fines {
 269     my $self = shift;
 270
 271     return $self->{excessive_fines};
 272 }
 273
 274 sub excessive_fees {
 275     my $self = shift;
 276
 277     return $self->{excessive_fees};
 278 }
 279
 280 sub too_many_billed {
 281     my $self = shift;
 282
 283     return $self->{too_many_billed};
 284 }
 285
 286 #
 287 # List of outstanding holds placed
 288 #
 289 sub hold_items {
 290     my ($self, $start, $end) = @_;
 291
 292     $start = 1 if !defined($start);
 293     $end = scalar @{$self->{hold_items}} if !defined($end);
 294
 295     return [@{$self->{hold_items}}[$start-1 .. $end-1]];
 296 }
 297
 298 #
 299 # remove the hold on item item_id from my hold queue.
 300 # return true if I was holding the item, false otherwise.
 301 #
 302 sub drop_hold {
 303     my ($self, $item_id) = @_;
 304     my $i;
 305
 306     for ($i = 0; $i < scalar @{$self->{hold_items}}; $i += 1) {
 307         if ($self->{hold_items}[$i]->{item_id} eq $item_id) {
 308             splice @{$self->{hold_items}}, $i, 1;
 309             return 1;
 310         }
 311     }
 312
 313     return 0;
 314 }
 315
 316 sub overdue_items {
 317     my ($self, $start, $end) = @_;
 318
 319     $start = 1 if !defined($start);
 320     $end = scalar @{$self->{overdue_items}} if !defined($end);
 321
 322     return [@{$self->{overdue_items}}[$start-1 .. $end-1]];
 323 }
 324
 325 sub charged_items {
 326     my ($self, $start, $end) = shift;
 327
 328     $start = 1 if !defined($start);
 329     $end = scalar @{$self->{items}} if !defined($end);
 330
 331     syslog("LOG_DEBUG", "charged_items: start = %d, end = %d", $start, $end);
 332     syslog("LOG_DEBUG", "charged_items: items = (%s)",
 333            join(', ', @{$self->{items}}));
 334
 335         return [@{$self->{items}}[$start-1 .. $end-1]];
 336 }
 337
 338 sub fine_items {
 339     my ($self, $start, $end) = @_;
 340
 341     $start = 1 if !defined($start);
 342     $end = scalar @{$self->{fine_items}} if !defined($end);
 343
 344     return [@{$self->{fine_items}}[$start-1 .. $end-1]];
 345 }
 346
 347 sub recall_items {
 348     my ($self, $start, $end) = @_;
 349
 350     $start = 1 if !defined($start);
 351     $end = scalar @{$self->{recall_items}} if !defined($end);
 352
 353     return [@{$self->{recall_items}}[$start-1 .. $end-1]];
 354 }
 355
 356 sub unavail_holds {
 357     my ($self, $start, $end) = @_;
 358
 359     $start = 1 if !defined($start);
 360     $end = scalar @{$self->{unavail_holds}} if !defined($end);
 361
 362     return [@{$self->{unavail_holds}}[$start-1 .. $end-1]];
 363 }
 364
 365 sub block {
 366     my ($self, $card_retained, $blocked_card_msg) = @_;
 367
 368     foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok') {
 369         $self->{$field} = 0;
 370     }
 371
 372     $self->{screen_msg} = $blocked_card_msg || "Card Blocked.  Please contact library staff";
 373
 374     return $self;
 375 }
 376
 377 sub enable {
 378     my $self = shift;
 379
 380     foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok') {
 381         $self->{$field} = 1;
 382     }
 383
 384     syslog("LOG_DEBUG", "Patron(%s)->enable: charge: %s, renew:%s, recall:%s, hold:%s",
 385            $self->{id}, $self->{charge_ok}, $self->{renew_ok},
 386            $self->{recall_ok}, $self->{hold_ok});
 387
 388     $self->{screen_msg} = "All privileges restored.";
 389
 390     return $self;
 391 }
 392
 393
 394 sub inet_privileges {
 395     my $self = shift;
 396
 397     return $self->{inet} ? 'Y' : 'N';
 398 }
 399
 400 #
 401 # Messages
 402 #
 403
 404 sub invalid_patron {
 405     return "Please contact library staff";
 406 }
 407
 408 sub charge_denied {
 409     return "Please contact library staff";
 410 }
 411
 412 1;