C4/SIP/ILS/Item.pm

   1 #
   2 # ILS::Item.pm
   3 #
   4 # A Class for hiding the ILS's concept of the item from OpenSIP
   5 #
   6
   7 package C4::SIP::ILS::Item;
   8
   9 use strict;
  10 use warnings;
  11
  12 use Sys::Syslog qw(syslog);
  13 use Carp;
  14
  15 use C4::SIP::ILS::Transaction;
  16
  17 use C4::Debug;
  18 use C4::Context;
  19 use C4::Biblio;
  20 use C4::Items;
  21 use C4::Circulation;
  22 use C4::Members;
  23 use C4::Reserves;
  24 use Koha::Database;
  25
  26
  27 =encoding UTF-8
  28
  29 =head1 EXAMPLE
  30
  31  our %item_db = (
  32     '1565921879' => {
  33         title => "Perl 5 desktop reference",
  34         id => '1565921879',
  35         sip_media_type => '001',
  36         magnetic_media => 0,
  37         hold_queue => [],
  38     },
  39     '0440242746' => {
  40         title => "The deep blue alibi",
  41         id => '0440242746',
  42         sip_media_type => '001',
  43         magnetic_media => 0,
  44         hold_queue => [
  45             {
  46             itemnumber => '823',
  47             priority => '1',
  48             reservenotes => undef,
  49             reservedate => '2008-10-09',
  50             found => undef,
  51             rtimestamp => '2008-10-09 11:15:06',
  52             biblionumber => '406',
  53             borrowernumber => '756',
  54             branchcode => 'CPL'
  55             }
  56         ],
  57     },
  58     '660' => {
  59         title => "Harry Potter y el cáliz de fuego",
  60         id => '660',
  61         sip_media_type => '001',
  62         magnetic_media => 0,
  63         hold_queue => [],
  64     },
  65 );
  66 =cut
  67
  68 sub priority_sort {
  69     defined $a->{priority} or return -1;
  70     defined $b->{priority} or return 1;
  71     return $a->{priority} <=> $b->{priority};
  72 }
  73
  74 sub new {
  75         my ($class, $item_id) = @_;
  76         my $type = ref($class) || $class;
  77         my $self;
  78     my $itemnumber = GetItemnumberFromBarcode($item_id);
  79         my $item = GetBiblioFromItemNumber($itemnumber);    # actually biblio.*, biblioitems.* AND items.*  (overkill)
  80         if (! $item) {
  81                 syslog("LOG_DEBUG", "new ILS::Item('%s'): not found", $item_id);
  82                 warn "new ILS::Item($item_id) : No item '$item_id'.";
  83         return;
  84         }
  85     $item->{  'itemnumber'   } = $itemnumber;
  86     $item->{      'id'       } = $item->{barcode};     # to SIP, the barcode IS the id.
  87     $item->{permanent_location}= $item->{homebranch};
  88     $item->{'collection_code'} = $item->{ccode};
  89     $item->{  'call_number'  } = $item->{itemcallnumber};
  90
  91     my $it = C4::Context->preference('item-level_itypes') ? $item->{itype} : $item->{itemtype};
  92     my $itemtype = Koha::Database->new()->schema()->resultset('Itemtype')->find( $it );
  93     $item->{sip_media_type} = $itemtype->sip_media_type() if $itemtype;
  94
  95         # check if its on issue and if so get the borrower
  96         my $issue = GetItemIssue($item->{'itemnumber'});
  97     if ($issue) {
  98         $item->{due_date} = $issue->{date_due};
  99     }
 100         my $borrower = GetMember(borrowernumber=>$issue->{'borrowernumber'});
 101         $item->{patron} = $borrower->{'cardnumber'};
 102     my $reserves = GetReservesFromBiblionumber({ biblionumber => $item->{biblionumber} });
 103     $item->{hold_queue} = [ sort priority_sort @$reserves ];
 104         $item->{hold_shelf}    = [( grep {   defined $_->{found}  and $_->{found} eq 'W' } @{$item->{hold_queue}} )];
 105         $item->{pending_queue} = [( grep {(! defined $_->{found}) or  $_->{found} ne 'W' } @{$item->{hold_queue}} )];
 106         $self = $item;
 107         bless $self, $type;
 108
 109     syslog("LOG_DEBUG", "new ILS::Item('%s'): found with title '%s'",
 110            $item_id, $self->{title});
 111
 112     return $self;
 113 }
 114
 115 # 0 means read-only
 116 # 1 means read/write
 117
 118 my %fields = (
 119     id                  => 0,
 120     sip_media_type      => 0,
 121     sip_item_properties => 0,
 122     magnetic_media      => 0,
 123     permanent_location  => 0,
 124     current_location    => 0,
 125     print_line          => 1,
 126     screen_msg          => 1,
 127     itemnumber          => 0,
 128     biblionumber        => 0,
 129     barcode             => 0,
 130     onloan              => 0,
 131     collection_code     => 0,
 132     call_number         => 0,
 133     enumchron           => 0,
 134     location            => 0,
 135     author              => 0,
 136     title               => 0,
 137 );
 138
 139 sub next_hold {
 140     my $self = shift;
 141     # use Data::Dumper; warn "next_hold() hold_shelf: " . Dumper($self->{hold_shelf}); warn "next_hold() pending_queue: " . $self->{pending_queue};
 142     foreach (@{$self->hold_shelf}) {    # If this item was taken from the hold shelf, then that reserve still governs
 143         next unless ($_->{itemnumber} and $_->{itemnumber} == $self->{itemnumber});
 144         return $_;
 145     }
 146     if (scalar @{$self->{pending_queue}}) {    # Otherwise, if there is at least one hold, the first (best priority) gets it
 147         return  $self->{pending_queue}->[0];
 148     }
 149     return;
 150 }
 151
 152 # hold_patron_id is NOT the barcode.  It's the borrowernumber.
 153 # If a return triggers capture for a hold the borrowernumber is passed
 154 # and saved so that other hold info can be retrieved
 155 sub hold_patron_id {
 156     my $self = shift;
 157     my $id   = shift;
 158     if ($id) {
 159         $self->{hold}->{borrowernumber} = $id;
 160     }
 161     if ($self->{hold} ) {
 162         return $self->{hold}->{borrowernumber};
 163     }
 164     return;
 165
 166 }
 167 sub hold_patron_name {
 168     my $self = shift;
 169     my $borrowernumber = (@_ ? shift: $self->hold_patron_id()) or return;
 170     my $holder = GetMember(borrowernumber=>$borrowernumber);
 171     unless ($holder) {
 172         syslog("LOG_ERR", "While checking hold, GetMember failed for borrowernumber '$borrowernumber'");
 173         return;
 174     }
 175     my $email = $holder->{email} || '';
 176     my $phone = $holder->{phone} || '';
 177     my $extra = ($email and $phone) ? " ($email, $phone)" :  # both populated, employ comma
 178                 ($email or  $phone) ? " ($email$phone)"   :  # only 1 populated, we don't care which: no comma
 179                 "" ;                                         # neither populated, empty string
 180     my $name = $holder->{firstname} ? $holder->{firstname} . ' ' : '';
 181     $name .= $holder->{surname} . $extra;
 182     return $name;
 183 }
 184
 185 sub hold_patron_bcode {
 186     my $self = shift;
 187     my $borrowernumber = (@_ ? shift: $self->hold_patron_id()) or return;
 188     my $holder = GetMember(borrowernumber => $borrowernumber);
 189     if ($holder) {
 190         if ($holder->{cardnumber}) {
 191             return $holder->{cardnumber};
 192         }
 193     }
 194     return;
 195 }
 196
 197 sub destination_loc {
 198     my $self = shift;
 199     my $set_loc = shift;
 200     if ($set_loc) {
 201         $self->{dest_loc} = $set_loc;
 202     }
 203     if ($self->{dest_loc} ) {
 204         return $self->{dest_loc};
 205     }
 206     return q{};
 207 }
 208
 209 our $AUTOLOAD;
 210
 211 sub DESTROY { } # keeps AUTOLOAD from catching inherent DESTROY calls
 212
 213 sub AUTOLOAD {
 214     my $self = shift;
 215     my $class = ref($self) or croak "$self is not an object";
 216     my $name = $AUTOLOAD;
 217
 218     $name =~ s/.*://;
 219
 220     unless (exists $fields{$name}) {
 221                 croak "Cannot access '$name' field of class '$class'";
 222     }
 223
 224         if (@_) {
 225         $fields{$name} or croak "Field '$name' of class '$class' is READ ONLY.";
 226                 return $self->{$name} = shift;
 227         } else {
 228                 return $self->{$name};
 229         }
 230 }
 231
 232 sub status_update {     # FIXME: this looks unimplemented
 233     my ($self, $props) = @_;
 234     my $status = C4::SIP::ILS::Transaction->new();
 235     $self->{sip_item_properties} = $props;
 236     $status->{ok} = 1;
 237     return $status;
 238 }
 239
 240 sub title_id {
 241     my $self = shift;
 242     return $self->{title};
 243 }
 244
 245 sub sip_circulation_status {
 246     my $self = shift;
 247     if ($self->{patron}) {
 248                 return '04';    # charged
 249     } elsif (scalar @{$self->{hold_queue}}) {
 250                 return '08';    # waiting on hold shelf
 251     } else {
 252                 return '03';    # available
 253     }                   # FIXME: 01-13 enumerated in spec.
 254 }
 255
 256 sub sip_security_marker {
 257     my $self = shift;
 258     return '02';        # FIXME? 00-other; 01-None; 02-Tattle-Tape Security Strip (3M); 03-Whisper Tape (3M)
 259 }
 260 sub sip_fee_type {
 261     my $self = shift;
 262     return '01';    # FIXME? 01-09 enumerated in spec.  We just use O1-other/unknown.
 263 }
 264
 265 sub fee {
 266     my $self = shift;
 267     return $self->{fee} || 0;
 268 }
 269 sub fee_currency {
 270     my $self = shift;
 271     return $self->{currency} || 'USD';
 272 }
 273 sub owner {
 274     my $self = shift;
 275     return $self->{homebranch};
 276 }
 277 sub hold_queue {
 278     my $self = shift;
 279         (defined $self->{hold_queue}) or return [];
 280     return $self->{hold_queue};
 281 }
 282 sub pending_queue {
 283     my $self = shift;
 284         (defined $self->{pending_queue}) or return [];
 285     return $self->{pending_queue};
 286 }
 287 sub hold_shelf {
 288     my $self = shift;
 289         (defined $self->{hold_shelf}) or return [];
 290     return $self->{hold_shelf};
 291 }
 292
 293 sub hold_queue_position {
 294         my ($self, $patron_id) = @_;
 295         ($self->{hold_queue}) or return 0;
 296         my $i = 0;
 297         foreach (@{$self->{hold_queue}}) {
 298                 $i++;
 299                 $_->{patron_id} or next;
 300                 if ($self->barcode_is_borrowernumber($patron_id, $_->{borrowernumber})) {
 301                         return $i;  # maybe should return $_->{priority}
 302                 }
 303         }
 304     return 0;
 305 }
 306
 307 sub due_date {
 308     my $self = shift;
 309     return $self->{due_date} || 0;
 310 }
 311 sub recall_date {
 312     my $self = shift;
 313     return $self->{recall_date} || 0;
 314 }
 315 sub hold_pickup_date {
 316     my $self = shift;
 317     return $self->{hold_pickup_date} || 0;
 318 }
 319
 320 # This is a partial check of "availability".  It is not supposed to check everything here.
 321 # An item is available for a patron if it is:
 322 # 1) checked out to the same patron
 323 #    AND no pending (i.e. non-W) hold queue
 324 # OR
 325 # 2) not checked out
 326 #    AND (not on hold_shelf OR is on hold_shelf for patron)
 327 #
 328 # What this means is we are consciously allowing the patron to checkout (but not renew) an item that DOES
 329 # have non-W holds on it, but has not been "picked" from the stacks.  That is to say, the
 330 # patron has retrieved the item before the librarian.
 331 #
 332 # We don't check if the patron is at the front of the pending queue in the first case, because
 333 # they should not be able to place a hold on an item they already have.
 334
 335 sub available {
 336         my ($self, $for_patron) = @_;
 337         my $count  = (defined $self->{pending_queue}) ? scalar @{$self->{pending_queue}} : 0;
 338         my $count2 = (defined $self->{hold_shelf}   ) ? scalar @{$self->{hold_shelf}   } : 0;
 339         $debug and print STDERR "availability check: pending_queue size $count, hold_shelf size $count2\n";
 340     if (defined($self->{patron_id})) {
 341                 ($self->{patron_id} eq $for_patron) or return 0;
 342                 return ($count ? 0 : 1);
 343         } else {        # not checked out
 344         ($count2) and return $self->barcode_is_borrowernumber($for_patron, $self->{hold_shelf}[0]->{borrowernumber});
 345         }
 346         return 0;
 347 }
 348
 349 sub _barcode_to_borrowernumber {
 350     my $known = shift;
 351     return unless defined $known;
 352     my $member = GetMember(cardnumber=>$known) or return;
 353     return $member->{borrowernumber};
 354 }
 355 sub barcode_is_borrowernumber {    # because hold_queue only has borrowernumber...
 356     my $self = shift;
 357     my $barcode = shift;
 358     my $number  = shift or return;    # can't be zero
 359     return unless defined $barcode; # might be 0 or 000 or 000000
 360     my $converted = _barcode_to_borrowernumber($barcode);
 361     return unless $converted;
 362     return ($number == $converted);
 363 }
 364 sub fill_reserve {
 365     my $self = shift;
 366     my $hold = shift or return;
 367     foreach (qw(biblionumber borrowernumber reservedate)) {
 368         $hold->{$_} or return;
 369     }
 370     return ModReserveFill($hold);
 371 }
 372 1;
 373 __END__
 374