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