21725c3a2c
This includes some initial work for the 3M SIP2 extensions. It also better populates the Patron object with methods for a fuller Patron Information Reponse. This is positively affect EnvisionWare software, as used by NEKLS. This work was sponsored by the Northeast Kansas Library System. Signed-off-by: Galen Charlton <galen.charlton@liblime.com>
466 lines
15 KiB
Perl
466 lines
15 KiB
Perl
#
|
|
# ILS::Patron.pm
|
|
#
|
|
# A Class for hiding the ILS's concept of the patron from the OpenSIP
|
|
# system
|
|
#
|
|
|
|
package ILS::Patron;
|
|
|
|
use strict;
|
|
use warnings;
|
|
use Exporter;
|
|
use Carp;
|
|
|
|
use Sys::Syslog qw(syslog);
|
|
use Data::Dumper;
|
|
|
|
use C4::Debug;
|
|
use C4::Context;
|
|
# use C4::Dates;
|
|
use C4::Koha;
|
|
use C4::Members;
|
|
use C4::Reserves;
|
|
use C4::Branch qw(GetBranchName);
|
|
use Digest::MD5 qw(md5_base64);
|
|
|
|
use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
|
|
|
|
BEGIN {
|
|
$VERSION = 2.03;
|
|
@ISA = qw(Exporter);
|
|
@EXPORT_OK = qw(invalid_patron);
|
|
}
|
|
|
|
our $kp; # koha patron
|
|
|
|
sub new {
|
|
my ($class, $patron_id) = @_;
|
|
my $type = ref($class) || $class;
|
|
my $self;
|
|
$kp = GetMember($patron_id,'cardnumber');
|
|
$debug and warn "new Patron (GetMember): " . Dumper($kp);
|
|
unless (defined $kp) {
|
|
syslog("LOG_DEBUG", "new ILS::Patron(%s): no such patron", $patron_id);
|
|
return undef;
|
|
}
|
|
$kp = GetMemberDetails(undef,$patron_id);
|
|
$debug and warn "new Patron (GetMemberDetails): " . Dumper($kp);
|
|
my $pw = $kp->{password}; ### FIXME - md5hash -- deal with .
|
|
my $flags = $kp->{flags}; # or warn "Warning: No flags from patron object for '$patron_id'";
|
|
my $debarred = $kp->{debarred}; # 1 if ($kp->{flags}->{DBARRED}->{noissues});
|
|
$debug and warn sprintf("Debarred = %s : ", ($debarred||'undef')) . Dumper(%{$kp->{flags}});
|
|
my %ilspatron;
|
|
my $adr = $kp->{streetnumber} || '';
|
|
my $address = $kp->{address} || '';
|
|
my $dob = $kp->{dateofbirth};
|
|
$dob and $dob =~ s/-//g; # YYYYMMDD
|
|
$adr .= ($adr && $address) ? " $address" : $address;
|
|
my $fines_amount = $flags->{CHARGES}->{amount};
|
|
$fines_amount = ($fines_amount and $fines_amount > 0) ? $fines_amount : 0;
|
|
{
|
|
no warnings; # any of these $kp->{fields} being concat'd could be undef
|
|
%ilspatron = (
|
|
getmemberdetails_object => $kp,
|
|
name => $kp->{firstname} . " " . $kp->{surname},
|
|
id => $kp->{cardnumber}, # to SIP, the id is the BARCODE, not userid
|
|
password => $pw,
|
|
ptype => $kp->{categorycode}, # 'A'dult. Whatever.
|
|
birthdate => $dob,
|
|
birthdate_iso => $kp->{dateofbirth},
|
|
branchcode => $kp->{branchcode},
|
|
library_name => "", # only populated if needed, cached here
|
|
borrowernumber => $kp->{borrowernumber},
|
|
address => $adr,
|
|
home_phone => $kp->{phone},
|
|
email_addr => $kp->{email},
|
|
charge_ok => ( !$debarred ),
|
|
renew_ok => ( !$debarred ),
|
|
recall_ok => ( !$debarred ),
|
|
hold_ok => ( !$debarred ),
|
|
card_lost => ( $kp->{lost} || $kp->{gonenoaddress} || $flags->{LOST} ),
|
|
claims_returned => 0,
|
|
fines => $fines_amount, # GetMemberAccountRecords($kp->{borrowernumber})
|
|
fees => 0, # currently not distinct from fines
|
|
recall_overdue => 0,
|
|
items_billed => 0,
|
|
screen_msg => 'Greetings from Koha. ' . $kp->{opacnote},
|
|
print_line => '',
|
|
items => [],
|
|
hold_items => $flags->{WAITING}{itemlist},
|
|
overdue_items => $flags->{ODUES}{itemlist},
|
|
fine_items => [],
|
|
recall_items => [],
|
|
unavail_holds => [],
|
|
inet => ( !$debarred ),
|
|
);
|
|
}
|
|
print STDERR "patron fines: $ilspatron{fines} ... amountoutstanding: $kp->{amountoutstanding} ... CHARGES->amount: $flags->{CHARGES}->{amount}\n";
|
|
for (qw(CHARGES CREDITS GNA LOST DBARRED NOTES)) {
|
|
($flags->{$_}) or next;
|
|
$ilspatron{screen_msg} .= ($flags->{$_}->{message} || '') ;
|
|
if ($flags->{$_}->{noissues}) {
|
|
foreach my $toggle (qw(charge_ok renew_ok recall_ok hold_ok inet)) {
|
|
$ilspatron{$toggle} = 0; # if we get noissues, disable everything
|
|
}
|
|
}
|
|
}
|
|
|
|
# FIXME: populate fine_items recall_items
|
|
# $ilspatron{hold_items} = (GetReservesFromBorrowernumber($kp->{borrowernumber},'F'));
|
|
$ilspatron{unavail_holds} = [(GetReservesFromBorrowernumber($kp->{borrowernumber}))];
|
|
$ilspatron{items} = GetPendingIssues($kp->{borrowernumber});
|
|
$self = \%ilspatron;
|
|
$debug and warn Dumper($self);
|
|
syslog("LOG_DEBUG", "new ILS::Patron(%s): found patron '%s'", $patron_id,$self->{id});
|
|
bless $self, $type;
|
|
return $self;
|
|
}
|
|
|
|
|
|
# 0 means read-only
|
|
# 1 means read/write
|
|
|
|
my %fields = (
|
|
id => 0,
|
|
name => 0,
|
|
address => 0,
|
|
email_addr => 0,
|
|
home_phone => 0,
|
|
birthdate => 0,
|
|
birthdate_iso => 0,
|
|
ptype => 0,
|
|
charge_ok => 0, # for patron_status[0] (inverted)
|
|
renew_ok => 0, # for patron_status[1] (inverted)
|
|
recall_ok => 0, # for patron_status[2] (inverted)
|
|
hold_ok => 0, # for patron_status[3] (inverted)
|
|
card_lost => 0, # for patron_status[4]
|
|
recall_overdue => 0,
|
|
currency => 1,
|
|
# fee_limit => 0,
|
|
screen_msg => 1,
|
|
print_line => 1,
|
|
too_many_charged => 0, # for patron_status[5]
|
|
too_many_overdue => 0, # for patron_status[6]
|
|
too_many_renewal => 0, # for patron_status[7]
|
|
too_many_claim_return => 0, # for patron_status[8]
|
|
too_many_lost => 0, # for patron_status[9]
|
|
# excessive_fines => 0, # for patron_status[10]
|
|
# excessive_fees => 0, # for patron_status[11]
|
|
recall_overdue => 0, # for patron_status[12]
|
|
too_many_billed => 0, # for patron_status[13]
|
|
inet => 0, # EnvisionWare extension
|
|
getmemberdetails_object => 0,
|
|
);
|
|
|
|
our $AUTOLOAD;
|
|
|
|
sub DESTROY {
|
|
# be cool. needed for AUTOLOAD(?)
|
|
}
|
|
|
|
sub AUTOLOAD {
|
|
my $self = shift;
|
|
my $class = ref($self) or croak "$self is not an object";
|
|
my $name = $AUTOLOAD;
|
|
|
|
$name =~ s/.*://;
|
|
|
|
unless (exists $fields{$name}) {
|
|
croak "Cannot access '$name' field of class '$class'";
|
|
}
|
|
|
|
if (@_) {
|
|
$fields{$name} or croak "Field '$name' of class '$class' is READ ONLY.";
|
|
return $self->{$name} = shift;
|
|
} else {
|
|
return $self->{$name};
|
|
}
|
|
}
|
|
|
|
sub check_password {
|
|
my ($self, $pwd) = @_;
|
|
my $md5pwd = $self->{password};
|
|
# warn sprintf "check_password for %s: '%s' vs. '%s'",($self->{name}||''),($self->{password}||''),($pwd||'');
|
|
(defined $pwd ) or return 0; # you gotta give me something (at least ''), or no deal
|
|
(defined $md5pwd) or return($pwd eq ''); # if the record has a NULL password, accept '' as match
|
|
return (md5_base64($pwd) eq $md5pwd);
|
|
}
|
|
|
|
# A few special cases, not in AUTOLOADed %fields
|
|
sub fee_amount {
|
|
my $self = shift;
|
|
return $self->{fines} || undef;
|
|
}
|
|
|
|
sub fines_amount {
|
|
my $self = shift;
|
|
return $self->fee_amount;
|
|
}
|
|
|
|
sub language {
|
|
my $self = shift;
|
|
return $self->{language} || '000'; # Unspecified
|
|
}
|
|
|
|
#
|
|
# List of outstanding holds placed
|
|
#
|
|
sub hold_items {
|
|
my ($self, $start, $end) = @_;
|
|
$self->{hold_items} or return [];
|
|
$start = 1 unless defined($start);
|
|
$end = scalar @{$self->{hold_items}} unless defined($end);
|
|
return [@{$self->{hold_items}}[$start-1 .. $end-1]]; # SIP "start item" and "end item" values are 1-indexed, not 0 like perl arrays
|
|
}
|
|
|
|
#
|
|
# remove the hold on item item_id from my hold queue.
|
|
# return true if I was holding the item, false otherwise.
|
|
#
|
|
sub drop_hold {
|
|
my ($self, $item_id) = @_;
|
|
$item_id or return undef;
|
|
my $result = 0;
|
|
foreach (qw(hold_items unavail_holds)) {
|
|
$self->{$_} or next;
|
|
for (my $i = 0; $i < scalar @{$self->{$_}}; $i++) {
|
|
my $held_item = $self->{$_}[$i]->{item_id} or next;
|
|
if ($held_item eq $item_id) {
|
|
splice @{$self->{$_}}, $i, 1;
|
|
$result++;
|
|
}
|
|
}
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
sub overdue_items {
|
|
my ($self, $start, $end) = @_;
|
|
$self->{overdue_items} or return [];
|
|
$start = 1 if !defined($start);
|
|
$end = scalar @{$self->{overdue_items}} if !defined($end);
|
|
return [@{$self->{overdue_items}}[$start-1 .. $end-1]];
|
|
}
|
|
|
|
sub charged_items {
|
|
my ($self, $start, $end) = shift;
|
|
$self->{items} or return [];
|
|
$start = 1 if !defined($start);
|
|
$end = scalar @{$self->{items}} if !defined($end);
|
|
syslog("LOG_DEBUG", "charged_items: start = %d, end = %d; items(%s)",
|
|
$start, $end, join(', ', @{$self->{items}}));
|
|
return [@{$self->{items}}[$start-1 .. $end-1]];
|
|
}
|
|
|
|
sub fine_items {
|
|
my ($self, $start, $end) = @_;
|
|
$self->{fine_items} or return [];
|
|
$start = 1 if !defined($start);
|
|
$end = scalar @{$self->{fine_items}} if !defined($end);
|
|
return [@{$self->{fine_items}}[$start-1 .. $end-1]];
|
|
}
|
|
|
|
sub recall_items {
|
|
my ($self, $start, $end) = @_;
|
|
$self->{recall_items} or return [];
|
|
$start = 1 if !defined($start);
|
|
$end = scalar @{$self->{recall_items}} if !defined($end);
|
|
return [@{$self->{recall_items}}[$start-1 .. $end-1]];
|
|
}
|
|
|
|
sub unavail_holds {
|
|
my ($self, $start, $end) = @_;
|
|
$self->{unavail_holds} or return [];
|
|
$start = 1 if !defined($start);
|
|
$end = scalar @{$self->{unavail_holds}} if !defined($end);
|
|
return [@{$self->{unavail_holds}}[$start-1 .. $end-1]];
|
|
}
|
|
|
|
sub block {
|
|
my ($self, $card_retained, $blocked_card_msg) = @_;
|
|
foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
|
|
$self->{$field} = 0;
|
|
}
|
|
$self->{screen_msg} = "Feature not implemented"; # $blocked_card_msg || "Card Blocked. Please contact library staff";
|
|
# TODO: not really affecting patron record
|
|
return $self;
|
|
}
|
|
|
|
sub enable {
|
|
my $self = shift;
|
|
foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
|
|
$self->{$field} = 1;
|
|
}
|
|
syslog("LOG_DEBUG", "Patron(%s)->enable: charge: %s, renew:%s, recall:%s, hold:%s",
|
|
$self->{id}, $self->{charge_ok}, $self->{renew_ok},
|
|
$self->{recall_ok}, $self->{hold_ok});
|
|
$self->{screen_msg} = "This feature not implemented."; # "All privileges restored."; # TODO: not really affecting patron record
|
|
return $self;
|
|
}
|
|
|
|
sub inet_privileges {
|
|
my $self = shift;
|
|
return $self->{inet} ? 'Y' : 'N';
|
|
}
|
|
|
|
sub fee_limit {
|
|
# my $self = shift;
|
|
return C4::Context->preference("noissuescharge") || 5;
|
|
}
|
|
|
|
sub excessive_fees {
|
|
my $self = shift or return;
|
|
return ($self->fee_amount and $self->fee_amount > $self->fee_limit);
|
|
}
|
|
sub excessive_fines {
|
|
my $self = shift or return;
|
|
return $self->excessive_fees; # same thing for Koha
|
|
}
|
|
|
|
sub library_name {
|
|
my $self = shift;
|
|
unless ($self->{library_name}) {
|
|
$self->{library_name} = GetBranchName($self->{branchcode});
|
|
}
|
|
return $self->{library_name};
|
|
}
|
|
#
|
|
# Messages
|
|
#
|
|
|
|
sub invalid_patron {
|
|
return "Please contact library staff";
|
|
}
|
|
|
|
sub charge_denied {
|
|
return "Please contact library staff";
|
|
}
|
|
|
|
1;
|
|
__END__
|
|
|
|
=head2 EXAMPLES
|
|
|
|
our %patron_example = (
|
|
djfiander => {
|
|
name => "David J. Fiander",
|
|
id => 'djfiander',
|
|
password => '6789',
|
|
ptype => 'A', # 'A'dult. Whatever.
|
|
birthdate => '19640925',
|
|
address => '2 Meadowvale Dr. St Thomas, ON',
|
|
home_phone => '(519) 555 1234',
|
|
email_addr => 'djfiander@hotmail.com',
|
|
charge_ok => 1,
|
|
renew_ok => 1,
|
|
recall_ok => 0,
|
|
hold_ok => 1,
|
|
card_lost => 0,
|
|
claims_returned => 0,
|
|
fines => 100,
|
|
fees => 0,
|
|
recall_overdue => 0,
|
|
items_billed => 0,
|
|
screen_msg => '',
|
|
print_line => '',
|
|
items => [],
|
|
hold_items => [],
|
|
overdue_items => [],
|
|
fine_items => ['Computer Time'],
|
|
recall_items => [],
|
|
unavail_holds => [],
|
|
inet => 1,
|
|
},
|
|
);
|
|
|
|
From borrowers table:
|
|
+---------------------+--------------+------+-----+
|
|
| Field | Type | Null | Key |
|
|
+---------------------+--------------+------+-----+
|
|
| borrowernumber | int(11) | NO | PRI |
|
|
| cardnumber | varchar(16) | YES | UNI |
|
|
| surname | mediumtext | NO | |
|
|
| firstname | text | YES | |
|
|
| title | mediumtext | YES | |
|
|
| othernames | mediumtext | YES | |
|
|
| initials | text | YES | |
|
|
| streetnumber | varchar(10) | YES | |
|
|
| streettype | varchar(50) | YES | |
|
|
| address | mediumtext | NO | |
|
|
| address2 | text | YES | |
|
|
| city | mediumtext | NO | |
|
|
| zipcode | varchar(25) | YES | |
|
|
| email | mediumtext | YES | |
|
|
| phone | text | YES | |
|
|
| mobile | varchar(50) | YES | |
|
|
| fax | mediumtext | YES | |
|
|
| emailpro | text | YES | |
|
|
| phonepro | text | YES | |
|
|
| B_streetnumber | varchar(10) | YES | |
|
|
| B_streettype | varchar(50) | YES | |
|
|
| B_address | varchar(100) | YES | |
|
|
| B_city | mediumtext | YES | |
|
|
| B_zipcode | varchar(25) | YES | |
|
|
| B_email | text | YES | |
|
|
| B_phone | mediumtext | YES | |
|
|
| dateofbirth | date | YES | |
|
|
| branchcode | varchar(10) | NO | MUL |
|
|
| categorycode | varchar(10) | NO | MUL |
|
|
| dateenrolled | date | YES | |
|
|
| dateexpiry | date | YES | |
|
|
| gonenoaddress | tinyint(1) | YES | |
|
|
| lost | tinyint(1) | YES | |
|
|
| debarred | tinyint(1) | YES | |
|
|
| contactname | mediumtext | YES | |
|
|
| contactfirstname | text | YES | |
|
|
| contacttitle | text | YES | |
|
|
| guarantorid | int(11) | YES | |
|
|
| borrowernotes | mediumtext | YES | |
|
|
| relationship | varchar(100) | YES | |
|
|
| ethnicity | varchar(50) | YES | |
|
|
| ethnotes | varchar(255) | YES | |
|
|
| sex | varchar(1) | YES | |
|
|
| password | varchar(30) | YES | |
|
|
| flags | int(11) | YES | |
|
|
| userid | varchar(30) | YES | MUL |
|
|
| opacnote | mediumtext | YES | |
|
|
| contactnote | varchar(255) | YES | |
|
|
| sort1 | varchar(80) | YES | |
|
|
| sort2 | varchar(80) | YES | |
|
|
| altcontactfirstname | varchar(255) | YES | |
|
|
| altcontactsurname | varchar(255) | YES | |
|
|
| altcontactaddress1 | varchar(255) | YES | |
|
|
| altcontactaddress2 | varchar(255) | YES | |
|
|
| altcontactaddress3 | varchar(255) | YES | |
|
|
| altcontactzipcode | varchar(50) | YES | |
|
|
| altcontactphone | varchar(50) | YES | |
|
|
+---------------------+--------------+------+-----+
|
|
|
|
From C4::Members
|
|
|
|
$flags->{KEY}
|
|
{CHARGES}
|
|
{message} Message showing patron's credit or debt
|
|
{noissues} Set if patron owes >$5.00
|
|
{GNA} Set if patron gone w/o address
|
|
{message} "Borrower has no valid address"
|
|
{noissues} Set.
|
|
{LOST} Set if patron's card reported lost
|
|
{message} Message to this effect
|
|
{noissues} Set.
|
|
{DBARRED} Set if patron is debarred
|
|
{message} Message to this effect
|
|
{noissues} Set.
|
|
{NOTES} Set if patron has notes
|
|
{message} Notes about patron
|
|
{ODUES} Set if patron has overdue books
|
|
{message} "Yes"
|
|
{itemlist} ref-to-array: list of overdue books
|
|
{itemlisttext} Text list of overdue items
|
|
{WAITING} Set if there are items available that the patron reserved
|
|
{message} Message to this effect
|
|
{itemlist} ref-to-array: list of available items
|
|
|
|
=cut
|
|
|