C4/SIP/ILS.pm

   1 #
   2 # ILS.pm: Koha ILS interface module
   3 #
   4
   5 package ILS;
   6
   7 use warnings;
   8 use strict;
   9 use Sys::Syslog qw(syslog);
  10
  11 use ILS::Item;
  12 use ILS::Patron;
  13 use ILS::Transaction;
  14 use ILS::Transaction::Checkout;
  15 use ILS::Transaction::Checkin;
  16 use ILS::Transaction::FeePayment;
  17 use ILS::Transaction::Hold;
  18 use ILS::Transaction::Renew;
  19 use ILS::Transaction::RenewAll;
  20
  21 my $debug = 0;
  22
  23 my %supports = (
  24     'magnetic media'        => 1,
  25     'security inhibit'      => 0,
  26     'offline operation'     => 0,
  27     "patron status request" => 1,
  28     "checkout"              => 1,
  29     "checkin"               => 1,
  30     "block patron"          => 1,
  31     "acs status"            => 1,
  32     "login"                 => 1,
  33     "patron information"    => 1,
  34     "end patron session"    => 1,
  35     "fee paid"              => 0,
  36     "item information"      => 1,
  37     "item status update"    => 0,
  38     "patron enable"         => 1,
  39     "hold"                  => 1,
  40     "renew"                 => 1,
  41     "renew all"             => 1,
  42 );
  43
  44 sub new {
  45     my ($class, $institution) = @_;
  46     my $type = ref($class) || $class;
  47     my $self = {};
  48         use Data::Dumper;
  49         $debug and warn "new ILS: INSTITUTION: " . Dumper($institution);
  50     syslog("LOG_DEBUG", "new ILS '%s'", $institution->{id});
  51     $self->{institution} = $institution;
  52     return bless $self, $type;
  53 }
  54
  55 sub find_patron {
  56     my $self = shift;
  57         $debug and warn "ILS: finding patron";
  58     return ILS::Patron->new(@_);
  59 }
  60
  61 sub find_item {
  62     my $self = shift;
  63         $debug and warn "ILS: finding item";
  64     return ILS::Item->new(@_);
  65 }
  66
  67 sub institution {
  68     my $self = shift;
  69     return $self->{institution}->{id};  # consider making this return the whole institution
  70 }
  71
  72 sub institution_id {
  73     my $self = shift;
  74     return $self->{institution}->{id};
  75 }
  76
  77 sub supports {
  78     my ($self, $op) = @_;
  79     return (exists($supports{$op}) && $supports{$op});
  80 }
  81
  82 sub check_inst_id {
  83     my ($self, $id, $whence) = @_;
  84     if ($id ne $self->{institution}->{id}) {
  85         syslog("LOG_WARNING", "%s: received institution '%s', expected '%s'", $whence, $id, $self->{institution}->{id});
  86         # Just an FYI check, we don't expect the user to change location from that in SIPconfig.xml
  87     }
  88 }
  89
  90 sub to_bool {
  91     my $bool = shift;
  92     # If it's defined, and matches a true sort of string, or is
  93     # a non-zero number, then it's true.
  94     defined($bool) or return;                   # false
  95     ($bool =~ /true|y|yes/i) and return 1;      # true
  96     return ($bool =~ /^\d+$/ and $bool != 0);   # true for non-zero numbers, false otherwise
  97 }
  98
  99 sub checkout_ok {
 100     my $self = shift;
 101     return (exists($self->{institution}->{policy}->{checkout})
 102             && to_bool($self->{institution}->{policy}->{checkout}));
 103 }
 104 sub checkin_ok {
 105     my $self = shift;
 106     return (exists($self->{institution}->{policy}->{checkin})
 107             && to_bool($self->{institution}->{policy}->{checkin}));
 108 }
 109 sub status_update_ok {
 110     my $self = shift;
 111     return (exists($self->{institution}->{policy}->{status_update})
 112             && to_bool($self->{institution}->{policy}->{status_update}));
 113 }
 114 sub offline_ok {
 115     my $self = shift;
 116     return (exists($self->{institution}->{policy}->{offline})
 117             && to_bool($self->{institution}->{policy}->{offline}));
 118 }
 119
 120 #
 121 # Checkout(patron_id, item_id, sc_renew):
 122 #    patron_id & item_id are the identifiers send by the terminal
 123 #    sc_renew is the renewal policy configured on the terminal
 124 # returns a status opject that can be queried for the various bits
 125 # of information that the protocol (SIP or NCIP) needs to generate
 126 # the response.
 127 #
 128 sub checkout {
 129     my ($self, $patron_id, $item_id, $sc_renew) = @_;
 130     my ($patron, $item, $circ);
 131
 132     $circ = new ILS::Transaction::Checkout;
 133     # BEGIN TRANSACTION
 134     $circ->patron($patron = new ILS::Patron $patron_id);
 135     $circ->item($item = new ILS::Item $item_id);
 136
 137     if (!$patron) {
 138                 $circ->screen_msg("Invalid Patron");
 139     } elsif (!$patron->charge_ok) {
 140                 $circ->screen_msg("Patron Blocked");
 141     } elsif (!$item) {
 142                 $circ->screen_msg("Invalid Item");
 143     # holds checked inside do_checkout
 144     # } elsif ($item->hold_queue && @{$item->hold_queue} && ! $item->barcode_is_borrowernumber($patron_id, $item->hold_queue->[0]->{borrowernumber})) {
 145         #       $circ->screen_msg("Item on Hold for Another User");
 146     } elsif ($item->{patron} && ($item->{patron} ne $patron_id)) {
 147         # I can't deal with this right now
 148                 $circ->screen_msg("Item checked out to another patron");
 149     } else {
 150                 $circ->do_checkout();
 151                 if ($circ->ok){
 152                         $debug and warn "circ is ok";
 153                         # If the item is already associated with this patron, then
 154                         # we're renewing it.
 155                         $circ->renew_ok($item->{patron} && ($item->{patron} eq $patron_id));
 156
 157                         $item->{patron} = $patron_id;
 158                         $item->{due_date} = $circ->{due};
 159                         push(@{$patron->{items}}, $item_id);
 160                         $circ->desensitize(!$item->magnetic_media);
 161
 162                         syslog("LOG_DEBUG", "ILS::Checkout: patron %s has checked out %s",
 163                                 $patron_id, join(', ', @{$patron->{items}}));
 164                 }
 165                 else {
 166                         syslog("LOG_ERR", "ILS::Checkout Issue failed");
 167                 }
 168     }
 169     # END TRANSACTION
 170
 171     return $circ;
 172 }
 173
 174 sub checkin {
 175     my ($self, $item_id, $trans_date, $return_date,
 176         $current_loc, $item_props, $cancel) = @_;
 177     my ($patron, $item, $circ);
 178
 179     $circ = new ILS::Transaction::Checkin;
 180     # BEGIN TRANSACTION
 181     $circ->item($item = new ILS::Item $item_id);
 182
 183     if ($item) {
 184         $circ->do_checkin($current_loc, $return_date);
 185     } else {
 186         $circ->alert(1);
 187         $circ->alert_type(99);
 188         $circ->screen_msg('Invalid Item');
 189     }
 190         # It's ok to check it in if it exists, and if it was checked out
 191         $circ->ok($item && $item->{patron});
 192
 193     if ($circ->ok) {
 194                 $circ->patron($patron = new ILS::Patron $item->{patron});
 195                 delete $item->{patron};
 196                 delete $item->{due_date};
 197                 $patron->{items} = [ grep {$_ ne $item_id} @{$patron->{items}} ];
 198     }
 199     # END TRANSACTION
 200
 201     return $circ;
 202 }
 203
 204 # If the ILS caches patron information, this lets it free
 205 # it up
 206 sub end_patron_session {
 207     my ($self, $patron_id) = @_;
 208
 209     # success?, screen_msg, print_line
 210     return (1, 'Thank you !', '');
 211 }
 212
 213 sub pay_fee {
 214     my ($self, $patron_id, $patron_pwd, $fee_amt, $fee_type,
 215         $pay_type, $fee_id, $trans_id, $currency) = @_;
 216     my $trans;
 217     my $patron;
 218
 219 #    $trans = new ILS::Transaction::FeePayment;
 220
 221     $patron = new ILS::Patron $patron_id;
 222
 223     $trans->transaction_id($trans_id);
 224     $trans->patron($patron);
 225     $trans->ok(1);
 226
 227     return $trans;
 228 }
 229
 230 sub add_hold {
 231     my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
 232         $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
 233     my ($patron, $item);
 234
 235         my $trans = new ILS::Transaction::Hold;
 236
 237     $patron = new ILS::Patron $patron_id;
 238     if (!$patron
 239         || (defined($patron_pwd) && !$patron->check_password($patron_pwd))) {
 240                 $trans->screen_msg("Invalid Patron.");
 241                 return $trans;
 242     }
 243
 244         unless ($item = new ILS::Item ($item_id || $title_id)) {
 245                 $trans->screen_msg("No such item.");
 246                 return $trans;
 247         }
 248
 249    if ($item->fee and $fee_ack ne 'Y') {
 250                 $trans->screen_msg = "Fee required to place hold.";
 251                 return $trans;
 252     }
 253
 254     my $hold = {
 255         item_id         => $item->id,
 256         patron_id       => $patron->id,
 257         expiration_date => $expiry_date,
 258         pickup_location => $pickup_location,
 259         hold_type       => $hold_type,
 260     };
 261
 262     $trans->ok(1);
 263     $trans->patron($patron);
 264     $trans->item($item);
 265     $trans->pickup_location($pickup_location);
 266         $trans->do_hold;
 267
 268     push(@{$item->hold_queue},     $hold);
 269     push(@{$patron->{hold_items}}, $hold);
 270
 271     return $trans;
 272 }
 273
 274 sub cancel_hold {
 275     my ($self, $patron_id, $patron_pwd, $item_id, $title_id) = @_;
 276     my ($patron, $item, $hold);
 277
 278         my $trans = new ILS::Transaction::Hold;
 279
 280     $patron = new ILS::Patron $patron_id;
 281     if (!$patron) {
 282                 $trans->screen_msg("Invalid patron barcode.");
 283                 return $trans;
 284     } elsif (defined($patron_pwd) && !$patron->check_password($patron_pwd)) {
 285                 $trans->screen_msg('Invalid patron password.');
 286                 return $trans;
 287     }
 288
 289     unless ($item = new ILS::Item ($item_id || $title_id)) {
 290                 $trans->screen_msg("No such item.");
 291                 return $trans;
 292     }
 293
 294     $trans->patron($patron);
 295     $trans->item($item);
 296         $trans->drop_hold;
 297         unless ($trans->ok) {
 298                 $trans->screen_msg("Error with transaction drop_hold: " . $trans->screen_msg);
 299                 return $trans;
 300         }
 301     # Remove the hold from the patron's record first
 302     $trans->ok($patron->drop_hold($item_id));   # different than the transaction drop!
 303
 304     unless ($trans->ok) {
 305                 # We didn't find it on the patron record
 306                 $trans->screen_msg("No such hold on patron record.");
 307                 return $trans;
 308     }
 309
 310     # Now, remove it from the item record.  If it was on the patron
 311     # record but not on the item record, we'll treat that as success.
 312     foreach my $i (0 .. scalar @{$item->hold_queue}) {
 313                 $hold = $item->hold_queue->[$i];
 314                 if ($item->barcode_is_borrowernumber($patron->id, $hold->{borrowernumber})) {
 315                     # found it: delete it.
 316                     splice @{$item->hold_queue}, $i, 1;
 317                     last;               # ?? should we keep going, in case there are multiples
 318                 }
 319     }
 320
 321     $trans->screen_msg("Hold Cancelled.");
 322
 323     return $trans;
 324 }
 325
 326
 327 # The patron and item id's can't be altered, but the
 328 # date, location, and type can.
 329 sub alter_hold {
 330     my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
 331         $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
 332     my ($patron, $item);
 333     my $hold;
 334     my $trans;
 335
 336     $trans = new ILS::Transaction::Hold;
 337
 338     # BEGIN TRANSACTION
 339     $patron = new ILS::Patron $patron_id;
 340     unless ($patron) {
 341                 $trans->screen_msg("Invalid patron barcode: '$patron_id'.");
 342                 return $trans;
 343     }
 344
 345     foreach my $i (0 .. scalar @{$patron->{hold_items}}) {
 346                 $hold = $patron->{hold_items}[$i];
 347
 348         if ($hold->{item_id} eq $item_id) {
 349             # Found it.  So fix it.
 350             $hold->{expiration_date} = $expiry_date     if $expiry_date;
 351             $hold->{pickup_location} = $pickup_location if $pickup_location;
 352             $hold->{hold_type}       = $hold_type       if $hold_type;
 353                 $trans->change_hold();
 354             # $trans->ok(1);
 355             $trans->screen_msg("Hold updated.");
 356             $trans->patron($patron);
 357             $trans->item(new ILS::Item $hold->{item_id});
 358             last;
 359         }
 360     }
 361
 362     # The same hold structure is linked into both the patron's
 363     # list of hold items and into the queue of outstanding holds
 364     # for the item, so we don't need to search the hold queue for
 365     # the item, since it's already been updated by the patron code.
 366
 367     if (!$trans->ok) {
 368                 $trans->screen_msg("No such outstanding hold.");
 369     }
 370
 371     return $trans;
 372 }
 373
 374 sub renew {
 375     my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
 376         $no_block, $nb_due_date, $third_party,
 377         $item_props, $fee_ack) = @_;
 378     my ($patron, $item);
 379     my $trans;
 380
 381     $trans = new ILS::Transaction::Renew;
 382     $trans->patron($patron = new ILS::Patron $patron_id);
 383
 384     if (!$patron) {
 385                 $trans->screen_msg("Invalid patron barcode.");
 386                 return $trans;
 387     } elsif (!$patron->renew_ok) {
 388                 $trans->screen_msg("Renewals not allowed.");
 389                 return $trans;
 390     }
 391
 392         # Previously: renewing a title, rather than an item (sort of)
 393         # This is gross, but in a real ILS it would be better
 394
 395     # if (defined($title_id)) {
 396         #       foreach my $i (@{$patron->{items}}) {
 397         #               $item = new ILS::Item $i;
 398         #               last if ($title_id eq $item->title_id);
 399         #               $item = undef;
 400         #       }
 401     # } else {
 402                 my $j = 0;
 403                 my $count = scalar @{$patron->{items}};
 404                 foreach my $i (@{$patron->{items}}) {
 405             unless (defined $i->{barcode}) {    # FIXME: using data instead of objects may violate the abstraction layer
 406                 syslog("LOG_ERR", "No barcode for item %s of %s: $item_id", $j+1, $count);
 407                 next;
 408             }
 409             syslog("LOG_DEBUG", "checking item %s of %s: $item_id vs. %s", ++$j, $count, $i->{barcode});
 410             if ($i->{barcode} eq $item_id) {
 411                                 # We have it checked out
 412                                 $item = new ILS::Item $item_id;
 413                                 last;
 414                         }
 415                 }
 416     # }
 417
 418     $trans->item($item);
 419
 420     if (!defined($item)) {
 421                 $trans->screen_msg("Item not checked out to " . $patron->name);     # not checked out to $patron_id
 422         $trans->ok(0);
 423     } elsif (!$item->available($patron_id)) {
 424                 $trans->screen_msg("Item unavailable due to outstanding holds");
 425         $trans->ok(0);
 426     } else {
 427                 $trans->renewal_ok(1);
 428                 $trans->desensitize(0); # It's already checked out
 429                 $trans->do_renew();
 430                 syslog("LOG_DEBUG", "done renew (ok:%s): %s renews %s", $trans->renewal_ok, $patron_id, $item_id);
 431
 432 #               $item->{due_date} = $nb_due_date if $no_block eq 'Y';
 433 #               $item->{sip_item_properties} = $item_props if $item_props;
 434     }
 435
 436     return $trans;
 437 }
 438
 439 sub renew_all {
 440     my ($self, $patron_id, $patron_pwd, $fee_ack) = @_;
 441     my ($patron, $item_id);
 442     my $trans;
 443
 444     $trans = new ILS::Transaction::RenewAll;
 445
 446     $trans->patron($patron = new ILS::Patron $patron_id);
 447     if (defined $patron) {
 448         syslog("LOG_DEBUG", "ILS::renew_all: patron '%s': renew_ok: %s", $patron->name, $patron->renew_ok);
 449     } else {
 450         syslog("LOG_DEBUG", "ILS::renew_all: Invalid patron id: '%s'", $patron_id);
 451     }
 452
 453     if (!defined($patron)) {
 454                 $trans->screen_msg("Invalid patron barcode.");
 455                 return $trans;
 456     } elsif (!$patron->renew_ok) {
 457                 $trans->screen_msg("Renewals not allowed.");
 458                 return $trans;
 459     } elsif (defined($patron_pwd) && !$patron->check_password($patron_pwd)) {
 460                 $trans->screen_msg("Invalid patron password.");
 461                 return $trans;
 462     }
 463
 464         $trans->do_renew_all;
 465     $trans->ok(1);
 466     return $trans;
 467 }
 468
 469 1;
 470 __END__
 471