Bug 15253: Add Koha::Logger based logging for SIP2
[koha-equinox.git] / C4 / SIP / ILS / Patron.pm
index 8c00a11..17c9081 100644 (file)
@@ -5,44 +5,51 @@
 # system
 #
 
-package ILS::Patron;
+package C4::SIP::ILS::Patron;
 
 use strict;
 use warnings;
 use Exporter;
 use Carp;
 
-use Sys::Syslog qw(syslog);
+use C4::SIP::Sip qw(syslog);
 use Data::Dumper;
 
+use C4::SIP::Sip qw(add_field);
+
 use C4::Debug;
 use C4::Context;
 use C4::Koha;
 use C4::Members;
 use C4::Reserves;
-use C4::Branch qw(GetBranchName);
-use Digest::MD5 qw(md5_base64);
+use C4::Auth qw(checkpw);
 
-our $VERSION = 3.07.00.049;
+use Koha::Items;
+use Koha::Libraries;
+use Koha::Patrons;
 
 our $kp;    # koha patron
 
+=head1 Methods
+
+=cut
+
 sub new {
     my ($class, $patron_id) = @_;
     my $type = ref($class) || $class;
     my $self;
-    $kp = GetMember(cardnumber=>$patron_id) || GetMember(userid=>$patron_id);
-    $debug and warn "new Patron (GetMember): " . Dumper($kp);
-    unless (defined $kp) {
+    my $patron = Koha::Patrons->find( { cardnumber => $patron_id } )
+      || Koha::Patrons->find( { userid => $patron_id } );
+    $debug and warn "new Patron: " . Dumper($patron->unblessed) if $patron;
+    unless ($patron) {
         syslog("LOG_DEBUG", "new ILS::Patron(%s): no such patron", $patron_id);
         return;
     }
-    $kp = GetMemberDetails($kp->{borrowernumber});
-    $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}});
+    $kp = $patron->unblessed;
+    my $pw        = $kp->{password};
+    my $flags     = C4::Members::patronflags( $kp );
+    my $debarred  = $patron->is_debarred;
+    $debug and warn sprintf("Debarred = %s : ", ($debarred||'undef')); # Do we need more debug info here?
     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;
@@ -58,12 +65,14 @@ sub new {
     $dob and $dob =~ s/-//g;    # YYYYMMDD
     my $dexpiry     = $kp->{dateexpiry};
     $dexpiry and $dexpiry =~ s/-//g;    # YYYYMMDD
-    my $fines_amount = $flags->{CHARGES}->{amount};
+    my $fines_amount = $patron->account->balance;
     $fines_amount = ($fines_amount and $fines_amount > 0) ? $fines_amount : 0;
+    my $fee_limit = _fee_limit();
+    my $fine_blocked = $fines_amount > $fee_limit;
+    my $circ_blocked =( C4::Context->preference('OverduesBlockCirc') ne "noblock" &&  defined $flags->{ODUES}->{itemlist} ) ? 1 : 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,
@@ -78,29 +87,35 @@ sub new {
         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 ),
+        charge_ok       => ( !$debarred && !$expired && !$fine_blocked && !$circ_blocked),
+        renew_ok        => ( !$debarred && !$expired && !$fine_blocked),
+        recall_ok       => ( !$debarred && !$expired && !$fine_blocked),
+        hold_ok         => ( !$debarred && !$expired && !$fine_blocked),
         card_lost       => ( $kp->{lost} || $kp->{gonenoaddress} || $flags->{LOST} ),
         claims_returned => 0,
-        fines           => $fines_amount, # GetMemberAccountRecords($kp->{borrowernumber})
+        fines           => $fines_amount,
         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},
+        hold_items      => $flags->{WAITING}->{itemlist},
+        overdue_items   => $flags->{ODUES}->{itemlist},
         fine_items      => [],
         recall_items    => [],
         unavail_holds   => [],
         inet            => ( !$debarred && !$expired ),
         expired         => $expired,
+        fee_limit       => $fee_limit,
+        userid          => $kp->{userid},
     );
     }
     $debug and warn "patron fines: $ilspatron{fines} ... amountoutstanding: $kp->{amountoutstanding} ... CHARGES->amount: $flags->{CHARGES}->{amount}";
+
+    if ( $patron->is_debarred and $patron->debarredcomment ) {
+        $ilspatron{screen_msg} .= " -- " . $patron->debarredcomment;
+    }
     for (qw(EXPIRED CHARGES CREDITS GNA LOST DBARRED NOTES)) {
         ($flags->{$_}) or next;
         if ($_ ne 'NOTES' and $flags->{$_}->{message}) {
@@ -114,9 +129,15 @@ sub new {
     }
 
     # FIXME: populate fine_items recall_items
-#   $ilspatron{hold_items}    = (GetReservesFromBorrowernumber($kp->{borrowernumber},'F'));
-    $ilspatron{unavail_holds} = [(GetReservesFromBorrowernumber($kp->{borrowernumber}))];
-    $ilspatron{items} = GetPendingIssues($kp->{borrowernumber});
+    $ilspatron{unavail_holds} = _get_outstanding_holds($kp->{borrowernumber});
+
+    my $pending_checkouts = $patron->pending_checkouts;
+    my @barcodes;
+    while ( my $c = $pending_checkouts->next ) {
+        push @barcodes, { barcode => $c->item->barcode };
+    }
+    $ilspatron{items} = \@barcodes;
+
     $self = \%ilspatron;
     $debug and warn Dumper($self);
     syslog("LOG_DEBUG", "new ILS::Patron(%s): found patron '%s'", $patron_id,$self->{id});
@@ -146,7 +167,7 @@ my %fields = (
     card_lost               => 0,   # for patron_status[4]
     recall_overdue          => 0,
     currency                => 1,
-#   fee_limit               => 0,
+    fee_limit               => 0,
     screen_msg              => 1,
     print_line              => 1,
     too_many_charged        => 0,   # for patron_status[5]
@@ -159,7 +180,6 @@ my %fields = (
     recall_overdue          => 0,   # for patron_status[12]
     too_many_billed         => 0,   # for patron_status[13]
     inet                    => 0,   # EnvisionWare extension
-    getmemberdetails_object => 0,
 );
 
 our $AUTOLOAD;
@@ -187,13 +207,39 @@ sub AUTOLOAD {
     }
 }
 
+sub name {
+    my ( $self, $template ) = @_;
+
+    if ($template) {
+        require Template;
+        require Koha::Patrons;
+
+        my $tt = Template->new();
+
+        my $patron = Koha::Patrons->find( $self->{borrowernumber} );
+
+        my $output;
+        $tt->process( \$template, { patron => $patron }, \$output );
+        return $output;
+    }
+    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);
+    my ( $self, $pwd ) = @_;
+
+    # you gotta give me something (at least ''), or no deal
+    return 0 unless defined $pwd;
+
+    # If the record has a NULL password, accept '' as match
+    return $pwd eq q{} unless $self->{password};
+
+    my $dbh = C4::Context->dbh;
+    my $ret = 0;
+    ($ret) = checkpw( $dbh, $self->{userid}, $pwd, undef, undef, 1 ); # dbh, userid, query, type, no_set_userenv
+    return $ret;
 }
 
 # A few special cases, not in AUTOLOADed %fields
@@ -248,12 +294,25 @@ sub x_items {
     my $self      = shift;
     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]];
+    my $item_list = [];
+    if ($self->{$array_var}) {
+        if ($start && $start > 1) {
+            --$start;
+        }
+        else {
+            $start = 0;
+        }
+        if ( $end && $end < @{$self->{$array_var}} ) {
+        }
+        else {
+            $end = @{$self->{$array_var}};
+            --$end;
+        }
+        @{$item_list} = @{$self->{$array_var}}[ $start .. $end ];
+
+    }
+    return $item_list;
 }
 
 #
@@ -261,7 +320,12 @@ sub x_items {
 #
 sub hold_items {
     my $self = shift;
-    return $self->x_items('hold_items', @_);
+    my $item_arr = $self->x_items('hold_items', @_);
+    foreach my $item (@{$item_arr}) {
+        my $item_obj = Koha::Items->find($item->{itemnumber});
+        $item->{barcode} = $item_obj ? $item_obj->barcode : undef;
+    }
+    return $item_arr;
 }
 
 sub overdue_items {
@@ -273,8 +337,39 @@ sub charged_items {
     return $self->x_items('items', @_);
 }
 sub fine_items {
+    require Koha::Database;
+    require Template;
+
     my $self = shift;
-    return $self->x_items('fine_items', @_);
+    my $start = shift;
+    my $end = shift;
+    my $server = shift;
+
+    my @fees = Koha::Database->new()->schema()->resultset('Accountline')->search(
+        {
+            borrowernumber    => $self->{borrowernumber},
+            amountoutstanding => { '>' => '0' },
+        }
+    );
+
+    $start = $start ? $start - 1 : 0;
+    $end   = $end   ? $end       : scalar @fees - 1;
+
+    my $av_field_template = $server ? $server->{account}->{av_field_template} : undef;
+    $av_field_template ||= "[% accountline.description %] [% accountline.amountoutstanding | format('%.2f') %]";
+
+    my $tt = Template->new();
+
+    my @return_values;
+    for ( my $i = $start; $i <= $end; $i++ ) {
+        my $fee = $fees[$i];
+
+        my $output;
+        $tt->process( \$av_field_template, { accountline => $fee }, \$output );
+        push( @return_values, { barcode => $output } );
+    }
+
+    return \@return_values;
 }
 sub recall_items {
     my $self = shift;
@@ -312,24 +407,31 @@ sub inet_privileges {
     return $self->{inet} ? 'Y' : 'N';
 }
 
-sub fee_limit {
-    my $self = shift;
-    return C4::Context->preference("noissuescharge") || 5;
+sub _fee_limit {
+    return C4::Context->preference('noissuescharge') || 5;
 }
 
 sub excessive_fees {
     my $self = shift;
     return ($self->fee_amount and $self->fee_amount > $self->fee_limit);
 }
+
 sub excessive_fines {
     my $self = shift;
     return $self->excessive_fees;   # excessive_fines is the same thing as excessive_fees for Koha
 }
+
+sub holds_blocked_by_excessive_fees {
+    my $self = shift;
+    return ( $self->fee_amount
+          && $self->fee_amount > C4::Context->preference("maxoutstanding") );
+}
     
 sub library_name {
     my $self = shift;
     unless ($self->{library_name}) {
-        $self->{library_name} = GetBranchName($self->{branchcode});
+        my $library = Koha::Libraries->find( $self->{branchcode} );
+        $self->{library_name} = $library ? $library->branchname : '';
     }
     return $self->{library_name};
 }
@@ -347,6 +449,21 @@ sub charge_denied {
     return "Please contact library staff";
 }
 
+=head2 update_lastseen
+
+    $patron->update_lastseen();
+
+    Patron method to update lastseen field in borrower
+    to record that patron has been seen via sip connection
+
+=cut
+
+sub update_lastseen {
+    my $self = shift;
+    my $kohaobj = Koha::Patrons->find( $self->{borrowernumber} );
+    $kohaobj->track_login if $kohaobj; # track_login checks the pref
+}
+
 sub _get_address {
     my $patron = shift;
 
@@ -365,6 +482,68 @@ sub _get_address {
     return $address;
 }
 
+sub _get_outstanding_holds {
+    my $borrowernumber = shift;
+
+    my $patron = Koha::Patrons->find( $borrowernumber );
+    my $holds = $patron->holds->search( { -or => [ { found => undef }, { found => { '!=' => 'W' } } ] } );
+    my @holds;
+    while ( my $hold = $holds->next ) {
+        my $item;
+        if ($hold->itemnumber) {
+            $item = $hold->item;
+        }
+        else {
+            # We need to return a barcode for the biblio so the client
+            # can request the biblio info
+            my $items = $hold->biblio->items;
+            $item = $items->count ? $items->next : undef;
+        }
+        my $unblessed_hold = $hold->unblessed;
+
+        $unblessed_hold->{barcode} = $item ? $item->barcode : undef;
+
+        push @holds, $unblessed_hold;
+    }
+    return \@holds;
+}
+
+=head2 build_patron_attributes_string
+
+This method builds the part of the sip message for extended patron
+attributes as defined in the sip config
+
+=cut
+
+sub build_patron_attributes_string {
+    my ( $self, $server ) = @_;
+
+    my $string = q{};
+
+    if ( $server->{account}->{patron_attribute} ) {
+        my @attributes_to_send =
+          ref $server->{account}->{patron_attribute} eq "ARRAY"
+          ? @{ $server->{account}->{patron_attribute} }
+          : ( $server->{account}->{patron_attribute} );
+
+        foreach my $a ( @attributes_to_send ) {
+            my @attributes = Koha::Patron::Attributes->search(
+                {
+                    borrowernumber => $self->{borrowernumber},
+                    code           => $a->{code}
+                }
+            );
+
+            foreach my $attribute ( @attributes ) {
+                my $value = $attribute->attribute();
+                $string .= add_field( $a->{field}, $value );
+            }
+        }
+    }
+
+    return $string;
+}
+
 1;
 __END__