Bug 8216: Allow SIP modules to pass critic tests
[koha.git] / C4 / SIP / ILS / Item.pm
index 5afcf1d..6bf7192 100644 (file)
@@ -1,8 +1,7 @@
 #
 # ILS::Item.pm
 # 
-# A Class for hiding the ILS's concept of the item from the OpenSIP
-# system
+# A Class for hiding the ILS's concept of the item from OpenSIP
 #
 
 package ILS::Item;
@@ -11,6 +10,7 @@ use strict;
 use warnings;
 
 use Sys::Syslog qw(syslog);
+use Carp;
 
 use ILS::Transaction;
 
@@ -25,15 +25,15 @@ use C4::Reserves;
 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
 
 BEGIN {
-       $VERSION = 2.10;
+    $VERSION = 3.07.00.049;
        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',
@@ -62,7 +62,7 @@ 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,
@@ -81,21 +81,31 @@ sub new {
        my ($class, $item_id) = @_;
        my $type = ref($class) || $class;
        my $self;
-       my $item = GetBiblioFromItemNumber( GetItemnumberFromBarcode($item_id) );
-       
+    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;
+        return;
        }
-    $item->{'id'} = $item->{'barcode'};
+    $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');
+    if ($issue) {
+        $item->{due_date} = $issue->{date_due};
+    }
+       my $borrower = GetMember(borrowernumber=>$issue->{'borrowernumber'});
        $item->{patron} = $borrower->{'cardnumber'};
-       my @reserves = (@{ GetReservesFromBiblionumber($item->{biblionumber}) });
-       $item->{hold_queue} = [ sort priority_sort @reserves ];
-       # $item->{joetest} = 111;
+    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;
 
@@ -105,17 +115,121 @@ sub new {
     return $self;
 }
 
-sub magnetic {
+# 0 means read-only
+# 1 means read/write
+
+my %fields = (
+    id                  => 0,
+    sip_media_type      => 0,
+    sip_item_properties => 0,
+    magnetic_media      => 0,
+    permanent_location  => 0,
+    current_location    => 0,
+    print_line          => 1,
+    screen_msg          => 1,
+    itemnumber          => 0,
+    biblionumber        => 0,
+    barcode             => 0,
+    onloan              => 0,
+    collection_code     => 0,
+    call_number         => 0,
+    enumchron           => 0,
+    location            => 0,
+    author              => 0,
+    title               => 0,
+);
+
+sub next_hold {
+    my $self = shift or return;
+    # 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
+        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;
-    return $self->{magnetic_media};
+    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;
+    my $borrowernumber = (@_ ? shift: $self->hold_patron_id()) or return;
+    my $holder = GetMember(borrowernumber=>$borrowernumber);
+    unless ($holder) {
+        syslog("LOG_ERR", "While checking hold, GetMember failed for borrowernumber '$borrowernumber'");
+        return;
+    }
+    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
+                "" ;                                         # neither populated, empty string
+    my $name = $holder->{firstname} ? $holder->{firstname} . ' ' : '';
+    $name .= $holder->{surname} . $extra;
+    return $name;
+}
+
+sub hold_patron_bcode {
+    my $self = shift or return;
+    my $borrowernumber = (@_ ? shift: $self->hold_patron_id()) or return;
+    my $holder = GetMember(borrowernumber => $borrowernumber);
+    if ($holder) {
+        if ($holder->{cardnumber}) {
+            return $holder->{cardnumber};
+        }
+    }
+    return;
 }
-sub sip_media_type {
+
+sub destination_loc {
     my $self = shift;
-    return $self->{sip_media_type};
+    my $set_loc = shift;
+    if ($set_loc) {
+        $self->{dest_loc} = $set_loc;
+    }
+    if ($self->{dest_loc} ) {
+        return $self->{dest_loc};
+    }
+    return q{};
 }
-sub sip_item_properties {
+
+our $AUTOLOAD;
+
+sub DESTROY { } # keeps AUTOLOAD from catching inherent DESTROY calls
+
+sub AUTOLOAD {
     my $self = shift;
-    return $self->{sip_item_properties};
+    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 status_update {     # FIXME: this looks unimplemented
@@ -125,23 +239,11 @@ sub status_update {     # FIXME: this looks unimplemented
     $status->{ok} = 1;
     return $status;
 }
-    
-sub id {
-    my $self = shift;
-    return $self->{id};
-}
+
 sub title_id {
     my $self = shift;
     return $self->{title};
 }
-sub permanent_location {
-    my $self = shift;
-    return $self->{permanent_location} || '';
-}
-sub current_location {
-    my $self = shift;
-    return $self->{current_location} || '';
-}
 
 sub sip_circulation_status {
     my $self = shift;
@@ -171,13 +273,23 @@ sub fee_currency {
 }
 sub owner {
     my $self = shift;
-    return 'CPL';      # FIXME: UWOLS was hardcoded 
+    return $self->{homebranch};
 }
 sub hold_queue {
     my $self = shift;
        (defined $self->{hold_queue}) or return [];
     return $self->{hold_queue};
 }
+sub pending_queue {
+    my $self = shift;
+       (defined $self->{pending_queue}) or return [];
+    return $self->{pending_queue};
+}
+sub hold_shelf {
+    my $self = shift;
+       (defined $self->{hold_shelf}) or return [];
+    return $self->{hold_shelf};
+}
 
 sub hold_queue_position {
        my ($self, $patron_id) = @_;
@@ -205,48 +317,58 @@ sub hold_pickup_date {
     my $self = shift;
     return $self->{hold_pickup_date} || 0;
 }
-sub screen_msg {
-    my $self = shift;
-    return $self->{screen_msg} || '';
-}
-sub print_line {
-       my $self = shift;
-       return $self->{print_line} || '';
-}
 
 # This is a partial check of "availability".  It is not supposed to check everything here.
 # An item is available for a patron if it is:
-# 1) checked out to the same patron and there's no hold queue
+# 1) checked out to the same patron 
+#    AND no pending (i.e. non-W) hold queue
 # OR
-# 2) not checked out and (there's no hold queue OR patron
-#    is at the front of the queue)
+# 2) not checked out
+#    AND (not on hold_shelf OR is on hold_shelf for patron)
+#
+# What this means is we are consciously allowing the patron to checkout (but not renew) an item that DOES
+# have non-W holds on it, but has not been "picked" from the stacks.  That is to say, the
+# patron has retrieved the item before the librarian.
+#
+# We don't check if the patron is at the front of the pending queue in the first case, because
+# they should not be able to place a hold on an item they already have.
+
 sub available {
        my ($self, $for_patron) = @_;
-       my $count = (defined $self->{hold_queue}) ? scalar @{$self->{hold_queue}} : 0;
-       $debug and print STDERR "availability check: hold_queue size $count\n";
+       my $count  = (defined $self->{pending_queue}) ? scalar @{$self->{pending_queue}} : 0;
+       my $count2 = (defined $self->{hold_shelf}   ) ? scalar @{$self->{hold_shelf}   } : 0;
+       $debug and print STDERR "availability check: pending_queue size $count, hold_shelf size $count2\n";
     if (defined($self->{patron_id})) {
                ($self->{patron_id} eq $for_patron) or return 0;
                return ($count ? 0 : 1);
        } else {        # not checked out
-               ($count) or return 1;
-               ($self->barcode_is_borrowernumber($for_patron, $self->{hold_queue}[0]->{borrowernumber})) and return 1;
+        ($count2) and return $self->barcode_is_borrowernumber($for_patron, $self->{hold_shelf}[0]->{borrowernumber});
        }
        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; # borrowernumber is default type for GetMember lookup
+    return unless defined $known;
+    my $member = GetMember(cardnumber=>$known) or return;
     return $member->{borrowernumber};
 }
-sub barcode_is_borrowernumber ($$$) {    # because hold_queue only has borrowernumber...
+sub barcode_is_borrowernumber {    # because hold_queue only has borrowernumber...
     my $self = shift;   # not really used
     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 {
+    my $self = shift;
+    my $hold = shift or return;
+    foreach (qw(biblionumber borrowernumber reservedate)) {
+        $hold->{$_} or return;
+    }
+    return ModReserveFill($hold);
 }
 1;
 __END__