Bug 5549 : Sip scripts should handle dt due dates
[koha.git] / C4 / SIP / ILS / Patron.pm
index 86d0bac..99fd6e7 100644 (file)
@@ -10,22 +10,23 @@ 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.02;
+       $VERSION = 2.03;
        @ISA = qw(Exporter);
        @EXPORT_OK = qw(invalid_patron);
 }
@@ -36,7 +37,7 @@ sub new {
        my ($class, $patron_id) = @_;
     my $type = ref($class) || $class;
     my $self;
-       $kp = GetMember($patron_id,'cardnumber');
+       $kp = GetMember(cardnumber=>$patron_id);
        $debug and warn "new Patron (GetMember): " . Dumper($kp);
     unless (defined $kp) {
                syslog("LOG_DEBUG", "new ILS::Patron(%s): no such patron", $patron_id);
@@ -44,66 +45,86 @@ sub new {
        }
        $kp = GetMemberDetails(undef,$patron_id);
        $debug and warn "new Patron (GetMemberDetails): " . Dumper($kp);
-       my $pw = $kp->{password};    ## FIXME - md5hash -- deal with . 
-       my $dob= $kp->{dateofbirth};
-       my $fines_out = GetMemberAccountRecords($kp->{borrowernumber});
-       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 $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 ($day, $month, $year) = (localtime)[3,4,5];
+    my $today    = sprintf '%04d-%02d-%02d', $year+1900, $month+1, $day;
+    my $expired  = ($today gt $kp->{dateexpiry}) ? 1 : 0;
+    if ($expired) {
+        if ($kp->{opacnote} ) {
+            $kp->{opacnote} .= q{ };
+        }
+        $kp->{opacnote} .= 'PATRON EXPIRED';
+    }
        my %ilspatron;
        my $adr     = $kp->{streetnumber} || '';
        my $address = $kp->{address}      || ''; 
+    my $dob     = $kp->{dateofbirth};
+    $dob and $dob =~ s/-//g;    # YYYYMMDD
+    my $dexpiry     = $kp->{dateexpiry};
+    $dexpiry and $dexpiry =~ 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
-       $dob =~ s/\-//g;
-       %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 => $kp->{dateofbirth}, ##$dob,
-               branchcode => $kp->{branchcode},
-                  address => $adr,
-               home_phone => $kp->{phone},
-               email_addr => $kp->{email},
-                charge_ok => (!$debarred), ##  (C4::Context->preference('FinesMode') eq 'charge') || 0,
-                 renew_ok => (!$debarred),
-                recall_ok => (!$debarred),
-                  hold_ok => (!$debarred),
-                card_lost => ($kp->{lost} || $kp->{gonenoaddress} || $flags->{LOST}) ,
-               claims_returned => 0,
-               fines => $fines_out,
-                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 => 1,
-       );
-       }
-       for (qw(CHARGES CREDITS GNA LOST DBARRED NOTES)) {
+    %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.
+        dateexpiry      => $dexpiry,
+        dateexpiry_iso  => $kp->{dateexpiry},
+        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 && !$expired ),
+        renew_ok        => ( !$debarred && !$expired ),
+        recall_ok       => ( !$debarred && !$expired ),
+        hold_ok         => ( !$debarred && !$expired ),
+        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 && !$expired ),
+        expired         => $expired,
+    );
+    }
+    $debug and warn "patron fines: $ilspatron{fines} ... amountoutstanding: $kp->{amountoutstanding} ... CHARGES->amount: $flags->{CHARGES}->{amount}";
+       for (qw(EXPIRED 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)) {
-                               $ilspatron{$toggle} = 0;
+        if ($_ ne 'NOTES' and $flags->{$_}->{message}) {
+            $ilspatron{screen_msg} .= " -- " . $flags->{$_}->{message};  # show all but internal NOTES
+        }
+               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 items fine_items recall_items
+    # FIXME: populate fine_items recall_items
 #   $ilspatron{hold_items}    = (GetReservesFromBorrowernumber($kp->{borrowernumber},'F'));
        $ilspatron{unavail_holds} = [(GetReservesFromBorrowernumber($kp->{borrowernumber}))];
-       my ($count,$issues) = GetPendingIssues($kp->{borrowernumber});
-       $ilspatron{items} = $issues;
+       $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});
@@ -111,62 +132,69 @@ sub new {
     return $self;
 }
 
-sub id {
-    my $self = shift;
-    return $self->{id};
-}
-sub name {
-    my $self = shift;
-    return $self->{name};
-}
-sub address {
-    my $self = shift;
-    return $self->{address};
-}
-sub email_addr {
-    my $self = shift;
-    return $self->{email_addr};
-}
-sub home_phone {
-    my $self = shift;
-    return $self->{home_phone};
-}
-sub sip_birthdate {
-    my $self = shift;
-    return $self->{birthdate};
-}
-sub ptype {
-    my $self = shift;
-    return $self->{ptype};
-}
-sub language {
-    my $self = shift;
-    return $self->{language} || '000'; # Unspecified
-}
-sub charge_ok {
-    my $self = shift;
-    return $self->{charge_ok};
-}
-sub renew_ok {
-    my $self = shift;
-    return $self->{renew_ok};
-}
-sub recall_ok {
-    my $self = shift;
-    return $self->{recall_ok};
-}
-sub hold_ok {
-    my $self = shift;
-    return $self->{hold_ok};
-}
-sub card_lost {
-    my $self = shift;
-    return $self->{card_lost};
+
+# 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,
+    dateexpiry              => 0,
+    dateexpiry_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 recall_overdue {
+
+sub AUTOLOAD {
     my $self = shift;
-    return $self->{recall_overdue};
+    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};
@@ -175,68 +203,26 @@ sub check_password {
        (defined $md5pwd) or return($pwd eq '');        # if the record has a NULL password, accept '' as match
        return (md5_base64($pwd) eq $md5pwd);
 }
-sub currency {
-    my $self = shift;
-    return $self->{currency};
-}
+
+# A few special cases, not in AUTOLOADed %fields
 sub fee_amount {
     my $self = shift;
-    return $self->{fee_amount} || undef;
-}
-sub screen_msg {
-    my $self = shift;
-    return $self->{screen_msg};
-}
-sub print_line {
-    my $self = shift;
-    return $self->{print_line};
+    return $self->{fines} || undef;
 }
-sub too_many_charged {
-    my $self = shift;
-    return $self->{too_many_charged};
-}
-sub too_many_overdue {
-    my $self = shift;
-    return $self->{too_many_overdue};
-}
-sub too_many_renewal {
-    my $self = shift;
-    return $self->{too_many_renewal};
-}
-sub too_many_claim_return {
-    my $self = shift;
-    return $self->{too_many_claim_return};
-}
-sub too_many_lost {
-    my $self = shift;
-    return $self->{too_many_lost};
-}
-sub excessive_fines {
-    my $self = shift;
-    return $self->{excessive_fines};
-}
-sub excessive_fees {
-    my $self = shift;
-    return $self->{excessive_fees};
-}
-sub too_many_billed {
+
+sub fines_amount {
     my $self = shift;
-    return $self->{too_many_billed};
+    return $self->fee_amount;
 }
-sub getmemberdetails_object {
+
+sub language {
     my $self = shift;
-    return $self->{getmemberdetails_object};
+    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]];
+sub expired {
+    my $self = shift;
+    return $self->{expired};
 }
 
 #
@@ -260,66 +246,69 @@ sub drop_hold {
     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]];
+# Accessor method for array_ref values, designed to get the "start" and "end" values
+# from the SIP request.  Note those incoming values are 1-indexed, not 0-indexed.
+#
+sub x_items {
+    my $self      = shift or return;
+    my $array_var = shift or return;
+    my ($start, $end) = @_;
+       $self->{$array_var} or return [];
+    $start = 1 unless defined($start);
+    $end   = scalar @{$self->{$array_var}} unless defined($end);
+    # syslog("LOG_DEBUG", "$array_var: start = %d, end = %d; items(%s)", $start, $end, join(', ', @{$self->{items}}));
+
+    return [@{$self->{$array_var}}[$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]];
+#
+# List of outstanding holds placed
+#
+sub hold_items {
+    my $self = shift or return;
+    return $self->x_items('hold_items', @_);
 }
 
+sub overdue_items {
+    my $self = shift or return;
+    return $self->x_items('overdue_items', @_);
+}
+sub charged_items {
+    my $self = shift or return;
+    return $self->x_items('items', @_);
+}
 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]];
+    my $self = shift or return;
+    return $self->x_items('fine_items', @_);
 }
-
 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]];
+    my $self = shift or return;
+    return $self->x_items('recall_items', @_);
 }
-
 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]];
+    my $self = shift or return;
+    return $self->x_items('unavail_holds', @_);
 }
 
 sub block {
     my ($self, $card_retained, $blocked_card_msg) = @_;
-    foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok') {
+    foreach my $field ('charge_ok', 'renew_ok', 'recall_ok', 'hold_ok', 'inet') {
                $self->{$field} = 0;
     }
-    $self->{screen_msg} = $blocked_card_msg || "Card Blocked.  Please contact library staff";
+    $self->{screen_msg} = "Block 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') {
+    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} = "All privileges restored.";
+    $self->{screen_msg} = "Enable feature not implemented."; # "All privileges restored.";   # TODO: not really affecting patron record
     return $self;
 }
 
@@ -328,6 +317,27 @@ sub inet_privileges {
     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;   # excessive_fines is the same thing as excessive_fees for Koha
+}
+    
+sub library_name {
+    my $self = shift;
+    unless ($self->{library_name}) {
+        $self->{library_name} = GetBranchName($self->{branchcode});
+    }
+    return $self->{library_name};
+}
 #
 # Messages
 #
@@ -343,9 +353,9 @@ sub charge_denied {
 1;
 __END__
 
-=head2 EXAMPLES
+=head1 EXAMPLES
 
-our %patron_example = (
+  our %patron_example = (
                  djfiander => {
                      name => "David J. Fiander",
                      id => 'djfiander',
@@ -377,91 +387,101 @@ our %patron_example = (
                  },
   );
 
-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}
+ From borrowers table:
++---------------------+--------------+------+-----+---------+----------------+
+| Field               | Type         | Null | Key | Default | Extra          |
++---------------------+--------------+------+-----+---------+----------------+
+| borrowernumber      | int(11)      | NO   | PRI | NULL    | auto_increment |
+| cardnumber          | varchar(16)  | YES  | UNI | NULL    |                |
+| surname             | mediumtext   | NO   |     | NULL    |                |
+| firstname           | text         | YES  |     | NULL    |                |
+| title               | mediumtext   | YES  |     | NULL    |                |
+| othernames          | mediumtext   | YES  |     | NULL    |                |
+| initials            | text         | YES  |     | NULL    |                |
+| streetnumber        | varchar(10)  | YES  |     | NULL    |                |
+| streettype          | varchar(50)  | YES  |     | NULL    |                |
+| address             | mediumtext   | NO   |     | NULL    |                |
+| address2            | text         | YES  |     | NULL    |                |
+| city                | mediumtext   | NO   |     | NULL    |                |
+| state               | mediumtext   | YES  |     | NULL    |                |
+| zipcode             | varchar(25)  | YES  |     | NULL    |                |
+| country             | text         | YES  |     | NULL    |                |
+| email               | mediumtext   | YES  |     | NULL    |                |
+| phone               | text         | YES  |     | NULL    |                |
+| mobile              | varchar(50)  | YES  |     | NULL    |                |
+| fax                 | mediumtext   | YES  |     | NULL    |                |
+| emailpro            | text         | YES  |     | NULL    |                |
+| phonepro            | text         | YES  |     | NULL    |                |
+| B_streetnumber      | varchar(10)  | YES  |     | NULL    |                |
+| B_streettype        | varchar(50)  | YES  |     | NULL    |                |
+| B_address           | varchar(100) | YES  |     | NULL    |                |
+| B_address2          | text         | YES  |     | NULL    |                |
+| B_city              | mediumtext   | YES  |     | NULL    |                |
+| B_state             | mediumtext   | YES  |     | NULL    |                |
+| B_zipcode           | varchar(25)  | YES  |     | NULL    |                |
+| B_country           | text         | YES  |     | NULL    |                |
+| B_email             | text         | YES  |     | NULL    |                |
+| B_phone             | mediumtext   | YES  |     | NULL    |                |
+| dateofbirth         | date         | YES  |     | NULL    |                |
+| branchcode          | varchar(10)  | NO   | MUL |         |                |
+| categorycode        | varchar(10)  | NO   | MUL |         |                |
+| dateenrolled        | date         | YES  |     | NULL    |                |
+| dateexpiry          | date         | YES  |     | NULL    |                |
+| gonenoaddress       | tinyint(1)   | YES  |     | NULL    |                |
+| lost                | tinyint(1)   | YES  |     | NULL    |                |
+| debarred            | tinyint(1)   | YES  |     | NULL    |                |
+| contactname         | mediumtext   | YES  |     | NULL    |                |
+| contactfirstname    | text         | YES  |     | NULL    |                |
+| contacttitle        | text         | YES  |     | NULL    |                |
+| guarantorid         | int(11)      | YES  | MUL | NULL    |                |
+| borrowernotes       | mediumtext   | YES  |     | NULL    |                |
+| relationship        | varchar(100) | YES  |     | NULL    |                |
+| ethnicity           | varchar(50)  | YES  |     | NULL    |                |
+| ethnotes            | varchar(255) | YES  |     | NULL    |                |
+| sex                 | varchar(1)   | YES  |     | NULL    |                |
+| password            | varchar(30)  | YES  |     | NULL    |                |
+| flags               | int(11)      | YES  |     | NULL    |                |
+| userid              | varchar(30)  | YES  | MUL | NULL    |                |
+| opacnote            | mediumtext   | YES  |     | NULL    |                |
+| contactnote         | varchar(255) | YES  |     | NULL    |                |
+| sort1               | varchar(80)  | YES  |     | NULL    |                |
+| sort2               | varchar(80)  | YES  |     | NULL    |                |
+| altcontactfirstname | varchar(255) | YES  |     | NULL    |                |
+| altcontactsurname   | varchar(255) | YES  |     | NULL    |                |
+| altcontactaddress1  | varchar(255) | YES  |     | NULL    |                |
+| altcontactaddress2  | varchar(255) | YES  |     | NULL    |                |
+| altcontactaddress3  | varchar(255) | YES  |     | NULL    |                |
+| altcontactstate     | mediumtext   | YES  |     | NULL    |                |
+| altcontactzipcode   | varchar(50)  | YES  |     | NULL    |                |
+| altcontactcountry   | text         | YES  |     | NULL    |                |
+| altcontactphone     | varchar(50)  | YES  |     | NULL    |                |
+| smsalertnumber      | varchar(50)  | YES  |     | NULL    |                |
+| privacy             | int(11)      | NO   |     | 1       |                |
++---------------------+--------------+------+-----+---------+----------------+
+
+
+ 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
+ {GNA}                 Set if patron gone w/o address
        {message}     "Borrower has no valid address"
        {noissues}    Set.
-{LOST}         Set if patron's card reported lost
+ {LOST}                Set if patron's card reported lost
        {message}     Message to this effect
        {noissues}    Set.
-{DBARRED}      Set if patron is debarred
+ {DBARRED}             Set if patron is debarred
        {message}     Message to this effect
        {noissues}    Set.
-{NOTES}        Set if patron has notes
+ {NOTES}               Set if patron has notes
        {message}     Notes about patron
-{ODUES}        Set if patron has overdue books
+ {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
+ {WAITING}             Set if there are items available that the patron reserved
        {message}     Message to this effect
        {itemlist}    ref-to-array: list of available items