Bug 15253: Add Koha::Logger based logging for SIP2
[koha-equinox.git] / C4 / SIP / ILS.pm
index 703bb96..047dae4 100644 (file)
@@ -2,21 +2,22 @@
 # ILS.pm: Koha ILS interface module
 #
 
-package ILS;
+package C4::SIP::ILS;
 
 use warnings;
 use strict;
-use Sys::Syslog qw(syslog);
-
-use ILS::Item;
-use ILS::Patron;
-use ILS::Transaction;
-use ILS::Transaction::Checkout;
-use ILS::Transaction::Checkin;
-use ILS::Transaction::FeePayment;
-use ILS::Transaction::Hold;
-use ILS::Transaction::Renew;
-use ILS::Transaction::RenewAll;
+use C4::SIP::Sip qw(syslog);
+use Data::Dumper;
+
+use C4::SIP::ILS::Item;
+use C4::SIP::ILS::Patron;
+use C4::SIP::ILS::Transaction;
+use C4::SIP::ILS::Transaction::Checkout;
+use C4::SIP::ILS::Transaction::Checkin;
+use C4::SIP::ILS::Transaction::FeePayment;
+use C4::SIP::ILS::Transaction::Hold;
+use C4::SIP::ILS::Transaction::Renew;
+use C4::SIP::ILS::Transaction::RenewAll;
 
 my $debug = 0;
 
@@ -45,7 +46,6 @@ sub new {
     my ($class, $institution) = @_;
     my $type = ref($class) || $class;
     my $self = {};
-       use Data::Dumper;
        $debug and warn "new ILS: INSTITUTION: " . Dumper($institution);
     syslog("LOG_DEBUG", "new ILS '%s'", $institution->{id});
     $self->{institution} = $institution;
@@ -55,13 +55,13 @@ sub new {
 sub find_patron {
     my $self = shift;
        $debug and warn "ILS: finding patron";
-    return ILS::Patron->new(@_);
+    return C4::SIP::ILS::Patron->new(@_);
 }
 
 sub find_item {
     my $self = shift;
        $debug and warn "ILS: finding item";
-    return ILS::Item->new(@_);
+    return C4::SIP::ILS::Item->new(@_);
 }
 
 sub institution {
@@ -126,81 +126,126 @@ sub offline_ok {
 # the response.
 #
 sub checkout {
-    my ($self, $patron_id, $item_id, $sc_renew) = @_;
-    my ($patron, $item, $circ);
+    my ( $self, $patron_id, $item_id, $sc_renew, $fee_ack ) = @_;
+    my ( $patron, $item, $circ );
+
+    $circ = C4::SIP::ILS::Transaction::Checkout->new();
 
-    $circ = new ILS::Transaction::Checkout;
     # BEGIN TRANSACTION
-    $circ->patron($patron = new ILS::Patron $patron_id);
-    $circ->item($item = new ILS::Item $item_id);
+    $circ->patron( $patron = C4::SIP::ILS::Patron->new($patron_id) );
+    $circ->item( $item     = C4::SIP::ILS::Item->new($item_id) );
+    if ($fee_ack) {
+        $circ->fee_ack($fee_ack);
+    }
 
-    if (!$patron) {
-               $circ->screen_msg("Invalid Patron");
-    } elsif (!$patron->charge_ok) {
-               $circ->screen_msg("Patron Blocked");
-    } elsif (!$item) {
-               $circ->screen_msg("Invalid Item");
-    # holds checked inside do_checkout
-    # } elsif ($item->hold_queue && @{$item->hold_queue} && ! $item->barcode_is_borrowernumber($patron_id, $item->hold_queue->[0]->{borrowernumber})) {
-       #       $circ->screen_msg("Item on Hold for Another User");
-    } elsif ($item->{patron} && ($item->{patron} ne $patron_id)) {
-       # I can't deal with this right now
-               $circ->screen_msg("Item checked out to another patron");
-    } else {
-               $circ->do_checkout();
-               if ($circ->ok){
-                       $debug and warn "circ is ok";
-                       # If the item is already associated with this patron, then
-                       # we're renewing it.
-                       $circ->renew_ok($item->{patron} && ($item->{patron} eq $patron_id));
-               
-                       $item->{patron} = $patron_id;
-                       $item->{due_date} = $circ->{due};
-                       push(@{$patron->{items}}, $item_id);
-                       $circ->desensitize(!$item->magnetic_media);
-
-                       syslog("LOG_DEBUG", "ILS::Checkout: patron %s has checked out %s",
-                               $patron_id, join(', ', @{$patron->{items}}));
-               }
-               else {
-                       syslog("LOG_ERR", "ILS::Checkout Issue failed");
-               }
+    if ( !$patron ) {
+        $circ->screen_msg("Invalid Patron");
+    }
+    elsif ( !$patron->charge_ok ) {
+        $circ->screen_msg("Patron Blocked");
+    }
+    elsif ( !$item ) {
+        $circ->screen_msg("Invalid Item");
     }
+    elsif ( $item->{patron}
+        && !_ci_cardnumber_cmp( $item->{patron}, $patron_id ) )
+    {
+        $circ->screen_msg("Item checked out to another patron");
+    }
+    else {
+        $circ->do_checkout();
+        if ( $circ->ok ) {
+            $debug and warn "circ is ok";
+
+            # If the item is already associated with this patron, then
+            # we're renewing it.
+            $circ->renew_ok( $item->{patron}
+                  && _ci_cardnumber_cmp( $item->{patron}, $patron_id ) );
+
+            $item->{patron}   = $patron_id;
+            $item->{due_date} = $circ->{due};
+            push( @{ $patron->{items} }, $item_id );
+            $circ->desensitize( !$item->magnetic_media );
+
+            syslog(
+                "LOG_DEBUG", "ILS::Checkout: patron %s has checked out %s",
+                $patron_id, join( ', ', @{ $patron->{items} } )
+            );
+        }
+        else {
+            syslog( "LOG_ERR", "ILS::Checkout Issue failed" );
+        }
+    }
+
     # END TRANSACTION
 
     return $circ;
 }
 
+sub _ci_cardnumber_cmp {
+    my ( $s1, $s2) = @_;
+    # As the database is case insensitive we need to normalize two strings
+    # before comparing them
+    return ( uc($s1) eq uc($s2) );
+}
+
+# wrapper which allows above to be called for testing
+
+sub test_cardnumber_compare {
+    my ($self, $str1, $str2) = @_;
+    return _ci_cardnumber_cmp($str1, $str2);
+}
+
 sub checkin {
-    my ($self, $item_id, $trans_date, $return_date,
-       $current_loc, $item_props, $cancel) = @_;
-    my ($patron, $item, $circ);
+    my ( $self, $item_id, $trans_date, $return_date, $current_loc, $item_props, $cancel, $checked_in_ok, $cv_triggers_alert ) = @_;
+    my ( $patron, $item, $circ );
+
+    $circ = C4::SIP::ILS::Transaction::Checkin->new();
 
-    $circ = new ILS::Transaction::Checkin;
     # BEGIN TRANSACTION
-    $circ->item($item = new ILS::Item $item_id);
+    $circ->item( $item = C4::SIP::ILS::Item->new($item_id) );
 
+    my $data;
     if ($item) {
-        $circ->do_checkin($current_loc);
-    } else {
+        $data = $circ->do_checkin( $current_loc, $return_date, $cv_triggers_alert );
+    }
+    else {
         $circ->alert(1);
         $circ->alert_type(99);
+        $circ->ok( 0 );
         $circ->screen_msg('Invalid Item');
+        return $circ;
+    }
+
+    if ( !$circ->ok && $circ->alert_type && $circ->alert_type == 98 ) { # data corruption
+        $circ->screen_msg("Checkin failed: data problem");
+        syslog( "LOG_WARNING", "Problem with issue_id in issues and old_issues; check the about page" );
+    } elsif ( $data->{messages}->{withdrawn} && !$circ->ok ) {
+            $circ->screen_msg("Item withdrawn, return not allowed");
+            syslog("LOG_DEBUG", "C4::SIP::ILS::Checkin - item withdrawn");
+    } elsif ( $data->{messages}->{WasLost} && !$circ->ok ) {
+            $circ->screen_msg("Item lost, return not allowed");
+            syslog("LOG_DEBUG", "C4::SIP::ILS::Checkin - item lost");
+    } elsif ( !$item->{patron} ) {
+        if ( $checked_in_ok ) { # Mark checkin ok although book not checked out
+            $circ->ok( 1 );
+            syslog("LOG_DEBUG", "C4::SIP::ILS::Checkin - using checked_in_ok");
+        } else {
+            $circ->screen_msg("Item not checked out");
+            syslog("LOG_DEBUG", "C4::SIP::ILS::Checkin - item not checked out");
+        }
+    } elsif ( $circ->ok ) {
+        $circ->patron( $patron = C4::SIP::ILS::Patron->new( $item->{patron} ) );
+        delete $item->{patron};
+        delete $item->{due_date};
+        $patron->{items} = [ grep { $_ ne $item_id } @{ $patron->{items} } ];
+    } else {
+        # Checkin failed: Wrongbranch or withdrawn?
+        # Bug 10748 with pref BlockReturnOfLostItems adds another case to come
+        # here: returning a lost item when the pref is set.
+        $circ->screen_msg("Checkin failed");
+        syslog( "LOG_WARNING", "Checkin failed: probably for Wrongbranch or withdrawn" );
     }
-       # It's ok to check it in if it exists, and if it was checked out
-       $circ->ok($item && $item->{patron});
-
-       if (!defined($item->{patron})) {
-               $circ->screen_msg("Item not checked out");
-       } else {
-               if ($circ->ok) {
-                       $circ->patron($patron = new ILS::Patron $item->{patron});
-                       delete $item->{patron};
-                       delete $item->{due_date};
-                       $patron->{items} = [ grep {$_ ne $item_id} @{$patron->{items}} ];
-               }
-       }
-    # END TRANSACTION
 
     return $circ;
 }
@@ -215,22 +260,19 @@ sub end_patron_session {
 }
 
 sub pay_fee {
-    my ($self, $patron_id, $patron_pwd, $fee_amt, $fee_type,
-       $pay_type, $fee_id, $trans_id, $currency) = @_;
-    my $trans;
-
-    $trans = ILS::Transaction::FeePayment->new();
+    my ($self, $patron_id, $patron_pwd, $fee_amt, $fee_type, $pay_type, $fee_id, $trans_id, $currency, $is_writeoff, $disallow_overpayment ) = @_;
 
+    my $trans = C4::SIP::ILS::Transaction::FeePayment->new();
 
     $trans->transaction_id($trans_id);
     my $patron;
-    $trans->patron($patron = ILS::Patron->new($patron_id));
+    $trans->patron($patron = C4::SIP::ILS::Patron->new($patron_id));
     if (!$patron) {
         $trans->screen_msg('Invalid patron barcode.');
         return $trans;
     }
-    $trans->pay($patron->{borrowernumber},$fee_amt);
-    $trans->ok(1);
+    my $ok = $trans->pay( $patron->{borrowernumber}, $fee_amt, $pay_type, $fee_id, $is_writeoff, $disallow_overpayment );
+    $trans->ok($ok);
 
     return $trans;
 }
@@ -240,16 +282,16 @@ sub add_hold {
        $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
     my ($patron, $item);
 
-       my $trans = new ILS::Transaction::Hold;
+       my $trans = C4::SIP::ILS::Transaction::Hold->new();
 
-    $patron = new ILS::Patron $patron_id;
+    $patron = C4::SIP::ILS::Patron->new( $patron_id);
     if (!$patron
        || (defined($patron_pwd) && !$patron->check_password($patron_pwd))) {
                $trans->screen_msg("Invalid Patron.");
                return $trans;
     }
 
-       unless ($item = new ILS::Item ($item_id || $title_id)) {
+       unless ($item = C4::SIP::ILS::Item->new($item_id || $title_id)) {
                $trans->screen_msg("No such item.");
                return $trans;
        }
@@ -287,9 +329,9 @@ sub cancel_hold {
     my ($self, $patron_id, $patron_pwd, $item_id, $title_id) = @_;
     my ($patron, $item, $hold);
 
-       my $trans = new ILS::Transaction::Hold;
+       my $trans = C4::SIP::ILS::Transaction::Hold->new();
 
-    $patron = new ILS::Patron $patron_id;
+    $patron = C4::SIP::ILS::Patron->new( $patron_id );
     if (!$patron) {
                $trans->screen_msg("Invalid patron barcode.");
                return $trans;
@@ -298,7 +340,7 @@ sub cancel_hold {
                return $trans;
     }
 
-    unless ($item = new ILS::Item ($item_id || $title_id)) {
+    unless ($item = C4::SIP::ILS::Item->new($item_id || $title_id)) {
                $trans->screen_msg("No such item.");
                return $trans;
     }
@@ -345,10 +387,10 @@ sub alter_hold {
     my $hold;
     my $trans;
 
-    $trans = new ILS::Transaction::Hold;
+    $trans = C4::SIP::ILS::Transaction::Hold->new();
 
     # BEGIN TRANSACTION
-    $patron = new ILS::Patron $patron_id;
+    $patron = C4::SIP::ILS::Patron->new( $patron_id );
     unless ($patron) {
                $trans->screen_msg("Invalid patron barcode: '$patron_id'.");
                return $trans;
@@ -366,7 +408,7 @@ sub alter_hold {
            # $trans->ok(1);
            $trans->screen_msg("Hold updated.");
            $trans->patron($patron);
-           $trans->item(new ILS::Item $hold->{item_id});
+           $trans->item(C4::SIP::ILS::Item->new( $hold->{item_id}));
            last;
        }
     }
@@ -390,8 +432,8 @@ sub renew {
     my ($patron, $item);
     my $trans;
 
-    $trans = new ILS::Transaction::Renew;
-    $trans->patron($patron = new ILS::Patron $patron_id);
+    $trans = C4::SIP::ILS::Transaction::Renew->new();
+    $trans->patron($patron = C4::SIP::ILS::Patron->new( $patron_id ));
 
     if (!$patron) {
                $trans->screen_msg("Invalid patron barcode.");
@@ -421,7 +463,7 @@ sub renew {
             syslog("LOG_DEBUG", "checking item %s of %s: $item_id vs. %s", ++$j, $count, $i->{barcode});
             if ($i->{barcode} eq $item_id) {
                                # We have it checked out
-                               $item = new ILS::Item $item_id;
+                               $item = C4::SIP::ILS::Item->new( $item_id );
                                last;
                        }
                }
@@ -448,9 +490,9 @@ sub renew_all {
     my ($patron, $item_id);
     my $trans;
 
-    $trans = new ILS::Transaction::RenewAll;
+    $trans = C4::SIP::ILS::Transaction::RenewAll->new();
 
-    $trans->patron($patron = new ILS::Patron $patron_id);
+    $trans->patron($patron = C4::SIP::ILS::Patron->new( $patron_id ));
     if (defined $patron) {
         syslog("LOG_DEBUG", "ILS::renew_all: patron '%s': renew_ok: %s", $patron->name, $patron->renew_ok);
     } else {