Bug 15253: Add Koha::Logger based logging for SIP2
[koha-equinox.git] / C4 / SIP / ILS / Item.pm
index 28cd4bb..7e246bc 100644 (file)
@@ -4,15 +4,16 @@
 # A Class for hiding the ILS's concept of the item from OpenSIP
 #
 
-package ILS::Item;
+package C4::SIP::ILS::Item;
 
 use strict;
 use warnings;
 
-use Sys::Syslog qw(syslog);
+use C4::SIP::Sip qw(syslog);
 use Carp;
+use Template;
 
-use ILS::Transaction;
+use C4::SIP::ILS::Transaction;
 
 use C4::Debug;
 use C4::Context;
@@ -21,19 +22,18 @@ use C4::Items;
 use C4::Circulation;
 use C4::Members;
 use C4::Reserves;
+use Koha::Database;
+use Koha::Biblios;
+use Koha::Checkouts;
+use Koha::DateUtils;
+use Koha::Patrons;
+use Koha::Items;
 
-use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
+=encoding UTF-8
 
-BEGIN {
-       $VERSION = 2.11;
-       require Exporter;
-       @ISA = qw(Exporter);
-       @EXPORT_OK = qw();
-}
-
-=head2 EXAMPLE
+=head1 EXAMPLE
 
-our %item_db = (
+ our %item_db = (
     '1565921879' => {
         title => "Perl 5 desktop reference",
         id => '1565921879',
@@ -51,7 +51,6 @@ our %item_db = (
             itemnumber => '823',
             priority => '1',
             reservenotes => undef,
-            constrainttype => 'a',
             reservedate => '2008-10-09',
             found => undef,
             rtimestamp => '2008-10-09 11:15:06',
@@ -62,52 +61,53 @@ our %item_db = (
         ],
     },
     '660' => {
-        title => "Harry Potter y el cáliz de fuego",
+        title => "Harry Potter y el cáliz de fuego",
         id => '660',
         sip_media_type => '001',
         magnetic_media => 0,
         hold_queue => [],
     },
 );
-=cut
 
-sub priority_sort {
-    defined $a->{priority} or return -1;
-    defined $b->{priority} or return 1;
-    return $a->{priority} <=> $b->{priority};
-}
+=cut
 
 sub new {
-       my ($class, $item_id) = @_;
-       my $type = ref($class) || $class;
-       my $self;
-    my $itemnumber = GetItemnumberFromBarcode($item_id);
-       my $item = GetBiblioFromItemNumber($itemnumber);    # actually biblio.*, biblioitems.* AND items.*  (overkill)
-       if (! $item) {
-               syslog("LOG_DEBUG", "new ILS::Item('%s'): not found", $item_id);
-               warn "new ILS::Item($item_id) : No item '$item_id'.";
-               return undef;
-       }
-    $item->{  'itemnumber'   } = $itemnumber;
-    $item->{      'id'       } = $item->{barcode};     # to SIP, the barcode IS the id.
-    $item->{permanent_location}= $item->{homebranch};
-    $item->{'collection_code'} = $item->{ccode};
-    $item->{  'call_number'  } = $item->{itemcallnumber};
-    # $item->{'destination_loc'}  =  ?
-
-       # check if its on issue and if so get the borrower
-       my $issue = GetItemIssue($item->{'itemnumber'});
-       my $borrower = GetMember($issue->{'borrowernumber'},'borrowernumber');
-       $item->{patron} = $borrower->{'cardnumber'};
-    my ($whatever, $arrayref) = GetReservesFromBiblionumber($item->{biblionumber});
-       $item->{hold_queue} = [ sort priority_sort @$arrayref ];
-       $item->{hold_shelf}    = [( grep {   defined $_->{found}  and $_->{found} eq 'W' } @{$item->{hold_queue}} )];
-       $item->{pending_queue} = [( grep {(! defined $_->{found}) or  $_->{found} ne 'W' } @{$item->{hold_queue}} )];
-       $self = $item;
-       bless $self, $type;
-
-    syslog("LOG_DEBUG", "new ILS::Item('%s'): found with title '%s'",
-          $item_id, $self->{title});
+    my ($class, $item_id) = @_;
+    my $type = ref($class) || $class;
+    my $item = Koha::Items->find( { barcode => $item_id } );
+    unless ( $item ) {
+        syslog("LOG_DEBUG", "new ILS::Item('%s'): not found", $item_id);
+        warn "new ILS::Item($item_id) : No item '$item_id'.";
+        return;
+    }
+    my $self = $item->unblessed;
+    $self->{      'id'       } = $item->barcode;     # to SIP, the barcode IS the id.
+    $self->{permanent_location}= $item->homebranch;
+    $self->{'collection_code'} = $item->ccode;
+    $self->{  'call_number'  } = $item->itemcallnumber;
+
+    my $it = $item->effective_itemtype;
+    my $itemtype = Koha::Database->new()->schema()->resultset('Itemtype')->find( $it );
+    $self->{sip_media_type} = $itemtype->sip_media_type() if $itemtype;
+
+    # check if its on issue and if so get the borrower
+    my $issue = Koha::Checkouts->find( { itemnumber => $item->itemnumber } );
+    if ($issue) {
+        $self->{due_date} = dt_from_string( $issue->date_due, 'sql' )->truncate( to => 'minute' );
+        my $patron = Koha::Patrons->find( $issue->borrowernumber );
+        $self->{patron} = $patron->cardnumber;
+    }
+    my $biblio = Koha::Biblios->find( $self->{biblionumber} );
+    my $holds = $biblio->current_holds->unblessed;
+    $self->{hold_queue} = $holds;
+    $self->{hold_shelf}    = [( grep {   defined $_->{found}  and $_->{found} eq 'W' } @{$self->{hold_queue}} )];
+    $self->{pending_queue} = [( grep {(! defined $_->{found}) or  $_->{found} ne 'W' } @{$self->{hold_queue}} )];
+    $self->{title} = $biblio->title;
+    $self->{author} = $biblio->author;
+    bless $self, $type;
+
+    syslog( "LOG_DEBUG", "new ILS::Item('%s'): found with title '%s'",
+        $item_id, $self->{title} // '' );
 
     return $self;
 }
@@ -137,45 +137,82 @@ my %fields = (
 );
 
 sub next_hold {
-    my $self = shift or return;
-    foreach (@$self->{hold_shelf}) {    # If this item was taken from the hold shelf, then that reserve still governs
+    my $self = shift;
+    # use Data::Dumper; warn "next_hold() hold_shelf: " . Dumper($self->{hold_shelf}); warn "next_hold() pending_queue: " . $self->{pending_queue};
+    foreach (@{$self->hold_shelf}) {    # If this item was taken from the hold shelf, then that reserve still governs
         next unless ($_->{itemnumber} and $_->{itemnumber} == $self->{itemnumber});
         return $_;
     }
-    if (scalar @$self->{pending_queue}) {    # Otherwise, if there is at least one hold, the first (best priority) gets it
+    if (scalar @{$self->{pending_queue}}) {    # Otherwise, if there is at least one hold, the first (best priority) gets it
         return  $self->{pending_queue}->[0];
     }
     return;
 }
 
+# hold_patron_id is NOT the barcode.  It's the borrowernumber.
+# If a return triggers capture for a hold the borrowernumber is passed
+# and saved so that other hold info can be retrieved
 sub hold_patron_id {
-    my $self = shift or return;
-    my $hold = $self->next_hold() or return;
-    return $hold->{borrowernumber};
+    my $self = shift;
+    my $id   = shift;
+    if ($id) {
+        $self->{hold}->{borrowernumber} = $id;
+    }
+    if ($self->{hold} ) {
+        return $self->{hold}->{borrowernumber};
+    }
+    return;
+
 }
 sub hold_patron_name {
-    my $self = shift or return;
-    # return $self->{hold_patron_name} if $self->{hold_patron_name};    TODO: consider caching
-    my $borrowernumber = (@_ ? shift: $self->hold_patron_id()) or return;
-    my $holder = GetMember($borrowernumber, 'borrowernumber');
+    my ( $self, $template ) = @_;
+    my $borrowernumber = $self->hold_patron_id() or return;
+
+    if ($template) {
+        my $tt = Template->new();
+
+        my $patron = Koha::Patrons->find($borrowernumber);
+
+        my $output;
+        $tt->process( \$template, { patron => $patron }, \$output );
+        return $output;
+    }
+
+    my $holder = Koha::Patrons->find( $borrowernumber );
     unless ($holder) {
-        syslog("LOG_ERR", "While checking hold, GetMember failed for borrowernumber '$borrowernumber'");
+        syslog("LOG_ERR", "While checking hold, failed to retrieve the patron with borrowernumber '$borrowernumber'");
         return;
     }
-    my $email = $holder{email} || '';
-    my $phone = $holder{phone} || '';
+    my $email = $holder->email || '';
+    my $phone = $holder->phone || '';
     my $extra = ($email and $phone) ? " ($email, $phone)" :  # both populated, employ comma
                 ($email or  $phone) ? " ($email$phone)"   :  # only 1 populated, we don't care which: no comma
-                "" ;                                         # niether populated, empty string
-    my $name = $holder->{firstname} ? $holder->{firstname} . ' ' : '';
-    $name .= $holder->{surname} . $extra;
-    # $self->{hold_patron_name} = $name;      # TODO: consider caching
+                "" ;                                         # neither populated, empty string
+    my $name = $holder->firstname ? $holder->firstname . ' ' : '';
+    $name .= $holder->surname . $extra;
     return $name;
 }
+
+sub hold_patron_bcode {
+    my $self = shift;
+    my $borrowernumber = (@_ ? shift: $self->hold_patron_id()) or return;
+    my $holder = Koha::Patrons->find( $borrowernumber );
+    if ($holder and $holder->cardnumber ) {
+        return $holder->cardnumber;
+    }
+    return;
+}
+
 sub destination_loc {
-    my $self = shift or return;
-    my $hold = $self->next_hold();
-    return ($hold ? $hold->{branchcode}
+    my $self = shift;
+    my $set_loc = shift;
+    if ($set_loc) {
+        $self->{dest_loc} = $set_loc;
+    }
+    if ($self->{dest_loc} ) {
+        return $self->{dest_loc};
+    }
+    return q{};
 }
 
 our $AUTOLOAD;
@@ -203,12 +240,12 @@ sub AUTOLOAD {
 
 sub status_update {     # FIXME: this looks unimplemented
     my ($self, $props) = @_;
-    my $status = new ILS::Transaction;
+    my $status = C4::SIP::ILS::Transaction->new();
     $self->{sip_item_properties} = $props;
     $status->{ok} = 1;
     return $status;
 }
-    
+
 sub title_id {
     my $self = shift;
     return $self->{title};
@@ -216,19 +253,23 @@ sub title_id {
 
 sub sip_circulation_status {
     my $self = shift;
-    if ($self->{patron}) {
-               return '04';    # charged
-    } elsif (scalar @{$self->{hold_queue}}) {
-               return '08';    # waiting on hold shelf
-    } else {
-               return '03';    # available
-    }                   # FIXME: 01-13 enumerated in spec.
+    if ( $self->{patron} ) {
+        return '04';    # charged
+    }
+    elsif ( grep { $_->{itemnumber} == $self->{itemnumber}  } @{ $self->{hold_shelf} } ) {
+        return '08';    # waiting on hold shelf
+    }
+    else {
+        return '03';    # available
+    }    # FIXME: 01-13 enumerated in spec.
 }
 
 sub sip_security_marker {
+    my $self = shift;
     return '02';       # FIXME? 00-other; 01-None; 02-Tattle-Tape Security Strip (3M); 03-Whisper Tape (3M)
 }
 sub sip_fee_type {
+    my $self = shift;
     return '01';    # FIXME? 01-09 enumerated in spec.  We just use O1-other/unknown.
 }
 
@@ -316,25 +357,26 @@ sub available {
        return 0;
 }
 
-sub _barcode_to_borrowernumber ($) {
+sub _barcode_to_borrowernumber {
     my $known = shift;
-    (defined($known)) or return undef;
-    my $member = GetMember($known,'cardnumber') or return undef;
-    return $member->{borrowernumber};
+    return unless defined $known;
+    my $patron = Koha::Patrons->find( { cardnumber => $known } ) or return;
+    return $patron->borrowernumber
 }
-sub barcode_is_borrowernumber ($$$) {    # because hold_queue only has borrowernumber...
-    my $self = shift;   # not really used
+sub barcode_is_borrowernumber {    # because hold_queue only has borrowernumber...
+    my $self = shift;
     my $barcode = shift;
-    my $number  = shift or return undef;    # can't be zero
-    (defined($barcode)) or return undef;    # might be 0 or 000 or 000000
-    my $converted = _barcode_to_borrowernumber($barcode) or return undef;
-    return ($number eq $converted); # even though both *should* be numbers, eq is safer.
+    my $number  = shift or return;    # can't be zero
+    return unless defined $barcode; # might be 0 or 000 or 000000
+    my $converted = _barcode_to_borrowernumber($barcode);
+    return unless $converted;
+    return ($number == $converted);
 }
-sub fill_reserve ($$) {
+sub fill_reserve {
     my $self = shift;
-    my $hold = shift or return undef;
+    my $hold = shift or return;
     foreach (qw(biblionumber borrowernumber reservedate)) {
-        $hold->{$_} or return undef;
+        $hold->{$_} or return;
     }
     return ModReserveFill($hold);
 }