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"              => 1,
  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);
 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 (!defined($item->{patron})) {
 194                 $circ->screen_msg("Item not checked out");
 195         } else {
 196                 if ($circ->ok) {
 197                         $circ->patron($patron = new ILS::Patron $item->{patron});
 198                         delete $item->{patron};
 199                         delete $item->{due_date};
 200                         $patron->{items} = [ grep {$_ ne $item_id} @{$patron->{items}} ];
 201                 }
 202         }
 203     # END TRANSACTION
 204
 205     return $circ;
 206 }
 207
 208 # If the ILS caches patron information, this lets it free
 209 # it up
 210 sub end_patron_session {
 211     my ($self, $patron_id) = @_;
 212
 213     # success?, screen_msg, print_line
 214     return (1, 'Thank you !', '');
 215 }
 216
 217 sub pay_fee {
 218     my ($self, $patron_id, $patron_pwd, $fee_amt, $fee_type,
 219         $pay_type, $fee_id, $trans_id, $currency) = @_;
 220     my $trans;
 221
 222     $trans = ILS::Transaction::FeePayment->new();
 223
 224
 225     $trans->transaction_id($trans_id);
 226     my $patron;
 227     $trans->patron($patron = ILS::Patron->new($patron_id));
 228     if (!$patron) {
 229         $trans->screen_msg('Invalid patron barcode.');
 230         return $trans;
 231     }
 232     $trans->pay($patron->{borrowernumber},$fee_amt);
 233     $trans->ok(1);
 234
 235     return $trans;
 236 }
 237
 238 sub add_hold {
 239     my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
 240         $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
 241     my ($patron, $item);
 242
 243         my $trans = new ILS::Transaction::Hold;
 244
 245     $patron = new ILS::Patron $patron_id;
 246     if (!$patron
 247         || (defined($patron_pwd) && !$patron->check_password($patron_pwd))) {
 248                 $trans->screen_msg("Invalid Patron.");
 249                 return $trans;
 250     }
 251
 252         unless ($item = new ILS::Item ($item_id || $title_id)) {
 253                 $trans->screen_msg("No such item.");
 254                 return $trans;
 255         }
 256
 257    if ($item->fee and $fee_ack ne 'Y') {
 258                 $trans->screen_msg = "Fee required to place hold.";
 259                 return $trans;
 260     }
 261
 262     my $hold = {
 263         item_id         => $item->id,
 264         patron_id       => $patron->id,
 265         expiration_date => $expiry_date,
 266         pickup_location => $pickup_location,
 267         hold_type       => $hold_type,
 268     };
 269
 270     $trans->ok(1);
 271     $trans->patron($patron);
 272     $trans->item($item);
 273     $trans->pickup_location($pickup_location);
 274         $trans->do_hold;
 275
 276     push(@{$item->hold_queue},     $hold);
 277     push(@{$patron->{hold_items}}, $hold);
 278
 279     return $trans;
 280 }
 281
 282 sub cancel_hold {
 283     my ($self, $patron_id, $patron_pwd, $item_id, $title_id) = @_;
 284     my ($patron, $item, $hold);
 285
 286         my $trans = new ILS::Transaction::Hold;
 287
 288     $patron = new ILS::Patron $patron_id;
 289     if (!$patron) {
 290                 $trans->screen_msg("Invalid patron barcode.");
 291                 return $trans;
 292     } elsif (defined($patron_pwd) && !$patron->check_password($patron_pwd)) {
 293                 $trans->screen_msg('Invalid patron password.');
 294                 return $trans;
 295     }
 296
 297     unless ($item = new ILS::Item ($item_id || $title_id)) {
 298                 $trans->screen_msg("No such item.");
 299                 return $trans;
 300     }
 301
 302     $trans->patron($patron);
 303     $trans->item($item);
 304         $trans->drop_hold;
 305         unless ($trans->ok) {
 306                 $trans->screen_msg("Error with transaction drop_hold: " . $trans->screen_msg);
 307                 return $trans;
 308         }
 309     # Remove the hold from the patron's record first
 310     $trans->ok($patron->drop_hold($item_id));   # different than the transaction drop!
 311
 312     unless ($trans->ok) {
 313                 # We didn't find it on the patron record
 314                 $trans->screen_msg("No such hold on patron record.");
 315                 return $trans;
 316     }
 317
 318     # Now, remove it from the item record.  If it was on the patron
 319     # record but not on the item record, we'll treat that as success.
 320     foreach my $i (0 .. scalar @{$item->hold_queue}) {
 321                 $hold = $item->hold_queue->[$i];
 322                 if ($item->barcode_is_borrowernumber($patron->id, $hold->{borrowernumber})) {
 323                     # found it: delete it.
 324                     splice @{$item->hold_queue}, $i, 1;
 325                     last;               # ?? should we keep going, in case there are multiples
 326                 }
 327     }
 328
 329     $trans->screen_msg("Hold Cancelled.");
 330
 331     return $trans;
 332 }
 333
 334
 335 # The patron and item id's can't be altered, but the
 336 # date, location, and type can.
 337 sub alter_hold {
 338     my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
 339         $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
 340     my ($patron, $item);
 341     my $hold;
 342     my $trans;
 343
 344     $trans = new ILS::Transaction::Hold;
 345
 346     # BEGIN TRANSACTION
 347     $patron = new ILS::Patron $patron_id;
 348     unless ($patron) {
 349                 $trans->screen_msg("Invalid patron barcode: '$patron_id'.");
 350                 return $trans;
 351     }
 352
 353     foreach my $i (0 .. scalar @{$patron->{hold_items}}) {
 354                 $hold = $patron->{hold_items}[$i];
 355
 356         if ($hold->{item_id} eq $item_id) {
 357             # Found it.  So fix it.
 358             $hold->{expiration_date} = $expiry_date     if $expiry_date;
 359             $hold->{pickup_location} = $pickup_location if $pickup_location;
 360             $hold->{hold_type}       = $hold_type       if $hold_type;
 361                 $trans->change_hold();
 362             # $trans->ok(1);
 363             $trans->screen_msg("Hold updated.");
 364             $trans->patron($patron);
 365             $trans->item(new ILS::Item $hold->{item_id});
 366             last;
 367         }
 368     }
 369
 370     # The same hold structure is linked into both the patron's
 371     # list of hold items and into the queue of outstanding holds
 372     # for the item, so we don't need to search the hold queue for
 373     # the item, since it's already been updated by the patron code.
 374
 375     if (!$trans->ok) {
 376                 $trans->screen_msg("No such outstanding hold.");
 377     }
 378
 379     return $trans;
 380 }
 381
 382 sub renew {
 383     my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
 384         $no_block, $nb_due_date, $third_party,
 385         $item_props, $fee_ack) = @_;
 386     my ($patron, $item);
 387     my $trans;
 388
 389     $trans = new ILS::Transaction::Renew;
 390     $trans->patron($patron = new ILS::Patron $patron_id);
 391
 392     if (!$patron) {
 393                 $trans->screen_msg("Invalid patron barcode.");
 394                 return $trans;
 395     } elsif (!$patron->renew_ok) {
 396                 $trans->screen_msg("Renewals not allowed.");
 397                 return $trans;
 398     }
 399
 400         # Previously: renewing a title, rather than an item (sort of)
 401         # This is gross, but in a real ILS it would be better
 402
 403     # if (defined($title_id)) {
 404         #       foreach my $i (@{$patron->{items}}) {
 405         #               $item = new ILS::Item $i;
 406         #               last if ($title_id eq $item->title_id);
 407         #               $item = undef;
 408         #       }
 409     # } else {
 410                 my $j = 0;
 411                 my $count = scalar @{$patron->{items}};
 412                 foreach my $i (@{$patron->{items}}) {
 413             unless (defined $i->{barcode}) {    # FIXME: using data instead of objects may violate the abstraction layer
 414                 syslog("LOG_ERR", "No barcode for item %s of %s: $item_id", $j+1, $count);
 415                 next;
 416             }
 417             syslog("LOG_DEBUG", "checking item %s of %s: $item_id vs. %s", ++$j, $count, $i->{barcode});
 418             if ($i->{barcode} eq $item_id) {
 419                                 # We have it checked out
 420                                 $item = new ILS::Item $item_id;
 421                                 last;
 422                         }
 423                 }
 424     # }
 425
 426     $trans->item($item);
 427
 428     if (!defined($item)) {
 429                 $trans->screen_msg("Item not checked out to " . $patron->name);     # not checked out to $patron_id
 430         $trans->ok(0);
 431     } elsif (!$item->available($patron_id)) {
 432                 $trans->screen_msg("Item unavailable due to outstanding holds");
 433         $trans->ok(0);
 434     } else {
 435                 $trans->renewal_ok(1);
 436                 $trans->desensitize(0); # It's already checked out
 437                 $trans->do_renew();
 438                 syslog("LOG_DEBUG", "done renew (ok:%s): %s renews %s", $trans->renewal_ok, $patron_id, $item_id);
 439
 440 #               $item->{due_date} = $nb_due_date if $no_block eq 'Y';
 441 #               $item->{sip_item_properties} = $item_props if $item_props;
 442     }
 443
 444     return $trans;
 445 }
 446
 447 sub renew_all {
 448     my ($self, $patron_id, $patron_pwd, $fee_ack) = @_;
 449     my ($patron, $item_id);
 450     my $trans;
 451
 452     $trans = new ILS::Transaction::RenewAll;
 453
 454     $trans->patron($patron = new ILS::Patron $patron_id);
 455     if (defined $patron) {
 456         syslog("LOG_DEBUG", "ILS::renew_all: patron '%s': renew_ok: %s", $patron->name, $patron->renew_ok);
 457     } else {
 458         syslog("LOG_DEBUG", "ILS::renew_all: Invalid patron id: '%s'", $patron_id);
 459     }
 460
 461     if (!defined($patron)) {
 462                 $trans->screen_msg("Invalid patron barcode.");
 463                 return $trans;
 464     } elsif (!$patron->renew_ok) {
 465                 $trans->screen_msg("Renewals not allowed.");
 466                 return $trans;
 467     } elsif (defined($patron_pwd) && !$patron->check_password($patron_pwd)) {
 468                 $trans->screen_msg("Invalid patron password.");
 469                 return $trans;
 470     }
 471
 472         $trans->do_renew_all;
 473     $trans->ok(1);
 474     return $trans;
 475 }
 476
 477 1;
 478 __END__
 479