C4/SIP/ILS.pm

   1 #
   2 # ILS.pm: Koha ILS interface module
   3 #
   4
   5 package C4::SIP::ILS;
   6
   7 use warnings;
   8 use strict;
   9 use C4::SIP::Sip qw(siplog);
  10 use Data::Dumper;
  11
  12 use C4::SIP::ILS::Item;
  13 use C4::SIP::ILS::Patron;
  14 use C4::SIP::ILS::Transaction;
  15 use C4::SIP::ILS::Transaction::Checkout;
  16 use C4::SIP::ILS::Transaction::Checkin;
  17 use C4::SIP::ILS::Transaction::FeePayment;
  18 use C4::SIP::ILS::Transaction::Hold;
  19 use C4::SIP::ILS::Transaction::Renew;
  20 use C4::SIP::ILS::Transaction::RenewAll;
  21
  22 my $debug = 0;
  23
  24 my %supports = (
  25     'magnetic media'        => 1,
  26     'security inhibit'      => 0,
  27     'offline operation'     => 0,
  28     "patron status request" => 1,
  29     "checkout"              => 1,
  30     "checkin"               => 1,
  31     "block patron"          => 1,
  32     "acs status"            => 1,
  33     "login"                 => 1,
  34     "patron information"    => 1,
  35     "end patron session"    => 1,
  36     "fee paid"              => 1,
  37     "item information"      => 1,
  38     "item status update"    => 0,
  39     "patron enable"         => 1,
  40     "hold"                  => 1,
  41     "renew"                 => 1,
  42     "renew all"             => 1,
  43 );
  44
  45 sub new {
  46     my ($class, $institution) = @_;
  47     my $type = ref($class) || $class;
  48     my $self = {};
  49         $debug and warn "new ILS: INSTITUTION: " . Dumper($institution);
  50     siplog("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 C4::SIP::ILS::Patron->new(@_);
  59 }
  60
  61 sub find_item {
  62     my $self = shift;
  63         $debug and warn "ILS: finding item";
  64     return C4::SIP::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         siplog("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, $fee_ack, $account ) = @_;
 130     my ( $patron, $item, $circ );
 131
 132     $circ = C4::SIP::ILS::Transaction::Checkout->new();
 133
 134     # BEGIN TRANSACTION
 135     $circ->patron( $patron = C4::SIP::ILS::Patron->new($patron_id) );
 136     $circ->item( $item     = C4::SIP::ILS::Item->new($item_id) );
 137     if ($fee_ack) {
 138         $circ->fee_ack($fee_ack);
 139     }
 140
 141     if ( !$patron ) {
 142         $circ->screen_msg("Invalid Patron");
 143     }
 144     elsif ( !$patron->charge_ok ) {
 145         $circ->screen_msg("Patron Blocked");
 146     }
 147     elsif ( !$item ) {
 148         $circ->screen_msg("Invalid Item");
 149     }
 150     elsif ( $item->{borrowernumber}
 151         && !_ci_cardnumber_cmp( $item->{borrowernumber}, $patron->borrowernumber ) )
 152     {
 153         $circ->screen_msg("Item checked out to another patron");
 154     }
 155     else {
 156         $circ->do_checkout($account);
 157         if ( $circ->ok ) {
 158             $debug and warn "circ is ok";
 159
 160             # If the item is already associated with this patron, then
 161             # we're renewing it.
 162             $circ->renew_ok( $item->{borrowernumber}
 163                   && _ci_cardnumber_cmp( $item->{borrowernumber}, $patron->borrowernumber ) );
 164
 165             $item->{borrowernumber}   = $patron_id;
 166             $item->{due_date} = $circ->{due};
 167             push( @{ $patron->{items} }, { barcode => $item_id } );
 168             $circ->desensitize( !$item->magnetic_media );
 169
 170             siplog(
 171                 "LOG_DEBUG", "ILS::Checkout: patron %s has checked out %s",
 172                 $patron_id, join( ', ', map{ $_->{barcode} } @{ $patron->{items} } )
 173             );
 174         }
 175         else {
 176             siplog( "LOG_ERR", "ILS::Checkout Issue failed" );
 177         }
 178     }
 179
 180     # END TRANSACTION
 181
 182     return $circ;
 183 }
 184
 185 sub _ci_cardnumber_cmp {
 186     my ( $s1, $s2) = @_;
 187     # As the database is case insensitive we need to normalize two strings
 188     # before comparing them
 189     return ( uc($s1) eq uc($s2) );
 190 }
 191
 192 # wrapper which allows above to be called for testing
 193
 194 sub test_cardnumber_compare {
 195     my ($self, $str1, $str2) = @_;
 196     return _ci_cardnumber_cmp($str1, $str2);
 197 }
 198
 199 sub checkin {
 200     my ( $self, $item_id, $trans_date, $return_date, $current_loc, $item_props, $cancel, $account ) = @_;
 201
 202     my $checked_in_ok     = $account->{checked_in_ok};
 203     my $cv_triggers_alert = $account->{cv_triggers_alert};
 204     my $holds_block_checkin  = $account->{holds_block_checkin};
 205
 206     my ( $patron, $item, $circ );
 207
 208     $circ = C4::SIP::ILS::Transaction::Checkin->new();
 209
 210     # BEGIN TRANSACTION
 211     $circ->item( $item = C4::SIP::ILS::Item->new($item_id) );
 212
 213     my $data;
 214     if ($item) {
 215         $data = $circ->do_checkin( $current_loc, $return_date, $account );
 216     }
 217     else {
 218         $circ->alert(1);
 219         $circ->alert_type(99);
 220         $circ->ok( 0 );
 221         $circ->screen_msg('Invalid Item');
 222         return $circ;
 223     }
 224
 225     if ( !$circ->ok && $circ->alert_type && $circ->alert_type == 98 ) { # data corruption
 226         $circ->screen_msg("Checkin failed: data problem");
 227         siplog( "LOG_WARNING", "Problem with issue_id in issues and old_issues; check the about page" );
 228     } elsif ( $data->{messages}->{ResFound} && !$circ->ok && $holds_block_checkin ) {
 229         $circ->screen_msg("Item is on hold, please return to circulation desk");
 230         siplog ("LOG_DEBUG", "C4::SIP::ILS::Checkin - item on hold");
 231     } elsif ( $data->{messages}->{withdrawn} && !$circ->ok && C4::Context->preference("BlockReturnOfWithdrawnItems") ) {
 232             $circ->screen_msg("Item withdrawn, return not allowed");
 233             siplog ("LOG_DEBUG", "C4::SIP::ILS::Checkin - item withdrawn");
 234     } elsif ( $data->{messages}->{WasLost} && !$circ->ok && C4::Context->preference("BlockReturnOfLostItems") ) {
 235             $circ->screen_msg("Item lost, return not allowed");
 236             siplog("LOG_DEBUG", "C4::SIP::ILS::Checkin - item lost");
 237     } elsif ( !$item->{borrowernumber} ) {
 238         if ( $checked_in_ok ) { # Mark checkin ok although book not checked out
 239             $circ->ok( 1 );
 240             siplog("LOG_DEBUG", "C4::SIP::ILS::Checkin - using checked_in_ok");
 241         } else {
 242             $circ->screen_msg("Item not checked out");
 243             siplog("LOG_DEBUG", "C4::SIP::ILS::Checkin - item not checked out");
 244         }
 245     } elsif ( $circ->ok ) {
 246         $circ->patron( $patron = C4::SIP::ILS::Patron->new( { borrowernumber => $item->{borrowernumber} } ) );
 247         delete $item->{borrowernumber};
 248         delete $item->{due_date};
 249         $patron->{items} = [ grep { $_ ne $item_id } @{ $patron->{items} } ];
 250     } else {
 251         # Checkin failed: Wrongbranch or withdrawn?
 252         # Bug 10748 with pref BlockReturnOfLostItems adds another case to come
 253         # here: returning a lost item when the pref is set.
 254         $circ->screen_msg("Checkin failed");
 255         siplog( "LOG_WARNING", "Checkin failed: probably for Wrongbranch or withdrawn" );
 256     }
 257
 258     return $circ;
 259 }
 260
 261 # If the ILS caches patron information, this lets it free
 262 # it up
 263 sub end_patron_session {
 264     my ($self, $patron_id) = @_;
 265
 266     # success?, screen_msg, print_line
 267     return (1, 'Thank you !', '');
 268 }
 269
 270 sub pay_fee {
 271     my ($self, $patron_id, $patron_pwd, $fee_amt, $fee_type, $pay_type, $fee_id, $trans_id, $currency, $is_writeoff, $disallow_overpayment, $register_id) = @_;
 272
 273     my $trans = C4::SIP::ILS::Transaction::FeePayment->new();
 274
 275     $trans->transaction_id($trans_id);
 276     my $patron;
 277     $trans->patron($patron = C4::SIP::ILS::Patron->new($patron_id));
 278     if (!$patron) {
 279         $trans->screen_msg('Invalid patron barcode.');
 280         return $trans;
 281     }
 282     my $trans_result = $trans->pay( $patron->{borrowernumber}, $fee_amt, $pay_type, $fee_id, $is_writeoff, $disallow_overpayment, $register_id );
 283     my $ok = $trans_result->{ok};
 284     $trans->ok($ok);
 285
 286     return {
 287         status       => $trans,
 288         pay_response => $trans_result->{pay_response}
 289     };
 290 }
 291
 292 sub add_hold {
 293     my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
 294         $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
 295     my ($patron, $item);
 296
 297         my $trans = C4::SIP::ILS::Transaction::Hold->new();
 298
 299     $patron = C4::SIP::ILS::Patron->new( $patron_id );
 300     if ( !$patron ) {
 301         $trans->screen_msg("Invalid patron barcode.");
 302         return $trans;
 303     }
 304
 305         unless ($item = C4::SIP::ILS::Item->new($item_id || $title_id)) {
 306                 $trans->screen_msg("No such item.");
 307                 return $trans;
 308         }
 309
 310     if ( $patron->holds_blocked_by_excessive_fees() ) {
 311         $trans->screen_msg("Excessive fees blocking placement of hold.");
 312     }
 313
 314    if ($item->fee and $fee_ack ne 'Y') {
 315                 $trans->screen_msg = "Fee required to place hold.";
 316                 return $trans;
 317     }
 318
 319     my $hold = {
 320         item_id         => $item->id,
 321         patron_id       => $patron->id,
 322         expiration_date => $expiry_date,
 323         pickup_location => $pickup_location,
 324         hold_type       => $hold_type,
 325     };
 326
 327     $trans->ok(1);
 328     $trans->patron($patron);
 329     $trans->item($item);
 330     $trans->pickup_location($pickup_location);
 331         $trans->do_hold;
 332
 333     push(@{$item->hold_queue},     $hold);
 334     push(@{$patron->{hold_items}}, $hold);
 335
 336     return $trans;
 337 }
 338
 339 sub cancel_hold {
 340     my ($self, $patron_id, $patron_pwd, $item_id, $title_id) = @_;
 341     my ($patron, $item, $hold);
 342
 343         my $trans = C4::SIP::ILS::Transaction::Hold->new();
 344
 345     $patron = C4::SIP::ILS::Patron->new( $patron_id );
 346     if (!$patron) {
 347                 $trans->screen_msg("Invalid patron barcode.");
 348                 return $trans;
 349     }
 350
 351     unless ($item = C4::SIP::ILS::Item->new($item_id || $title_id)) {
 352                 $trans->screen_msg("No such item.");
 353                 return $trans;
 354     }
 355
 356     $trans->patron($patron);
 357     $trans->item($item);
 358         $trans->drop_hold;
 359         unless ($trans->ok) {
 360                 $trans->screen_msg("Error with transaction drop_hold: " . $trans->screen_msg);
 361                 return $trans;
 362         }
 363     # Remove the hold from the patron's record first
 364     $trans->ok($patron->drop_hold($item_id));   # different than the transaction drop!
 365
 366     unless ($trans->ok) {
 367                 # We didn't find it on the patron record
 368                 $trans->screen_msg("No such hold on patron record.");
 369                 return $trans;
 370     }
 371
 372     # Now, remove it from the item record.  If it was on the patron
 373     # record but not on the item record, we'll treat that as success.
 374     foreach my $i (0 .. scalar @{$item->hold_queue}) {
 375                 $hold = $item->hold_queue->[$i];
 376                 if ($item->barcode_is_borrowernumber($patron->id, $hold->{borrowernumber})) {
 377                     # found it: delete it.
 378                     splice @{$item->hold_queue}, $i, 1;
 379                     last;               # ?? should we keep going, in case there are multiples
 380                 }
 381     }
 382
 383     $trans->screen_msg("Hold Cancelled.");
 384
 385     return $trans;
 386 }
 387
 388
 389 # The patron and item id's can't be altered, but the
 390 # date, location, and type can.
 391 sub alter_hold {
 392     my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
 393         $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
 394     my ($patron, $item);
 395     my $hold;
 396     my $trans;
 397
 398     $trans = C4::SIP::ILS::Transaction::Hold->new();
 399
 400     # BEGIN TRANSACTION
 401     $patron = C4::SIP::ILS::Patron->new( $patron_id );
 402     unless ($patron) {
 403                 $trans->screen_msg("Invalid patron barcode: '$patron_id'.");
 404                 return $trans;
 405     }
 406
 407     foreach my $i (0 .. scalar @{$patron->{hold_items}}) {
 408                 $hold = $patron->{hold_items}[$i];
 409
 410         if ($hold->{item_id} eq $item_id) {
 411             # Found it.  So fix it.
 412             $hold->{expiration_date} = $expiry_date     if $expiry_date;
 413             $hold->{pickup_location} = $pickup_location if $pickup_location;
 414             $hold->{hold_type}       = $hold_type       if $hold_type;
 415                 $trans->change_hold();
 416             # $trans->ok(1);
 417             $trans->screen_msg("Hold updated.");
 418             $trans->patron($patron);
 419             $trans->item(C4::SIP::ILS::Item->new( $hold->{item_id}));
 420             last;
 421         }
 422     }
 423
 424     # The same hold structure is linked into both the patron's
 425     # list of hold items and into the queue of outstanding holds
 426     # for the item, so we don't need to search the hold queue for
 427     # the item, since it's already been updated by the patron code.
 428
 429     if (!$trans->ok) {
 430                 $trans->screen_msg("No such outstanding hold.");
 431     }
 432
 433     return $trans;
 434 }
 435
 436 sub renew {
 437     my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
 438         $no_block, $nb_due_date, $third_party,
 439         $item_props, $fee_ack) = @_;
 440     my ($patron, $item);
 441     my $trans;
 442
 443     $trans = C4::SIP::ILS::Transaction::Renew->new();
 444     $trans->patron($patron = C4::SIP::ILS::Patron->new( $patron_id ));
 445
 446     if (!$patron) {
 447                 $trans->screen_msg("Invalid patron barcode.");
 448                 return $trans;
 449     } elsif (!$patron->renew_ok) {
 450                 $trans->screen_msg("Renewals not allowed.");
 451                 return $trans;
 452     }
 453
 454         # Previously: renewing a title, rather than an item (sort of)
 455         # This is gross, but in a real ILS it would be better
 456
 457     # if (defined($title_id)) {
 458         #       foreach my $i (@{$patron->{items}}) {
 459         #               $item = new ILS::Item $i;
 460         #               last if ($title_id eq $item->title_id);
 461         #               $item = undef;
 462         #       }
 463     # } else {
 464                 my $j = 0;
 465                 my $count = scalar @{$patron->{items}};
 466                 foreach my $i (@{$patron->{items}}) {
 467             unless (defined $i->{barcode}) {    # FIXME: using data instead of objects may violate the abstraction layer
 468                 siplog("LOG_ERR", "No barcode for item %s of %s: $item_id", $j+1, $count);
 469                 next;
 470             }
 471             siplog("LOG_DEBUG", "checking item %s of %s: $item_id vs. %s", ++$j, $count, $i->{barcode});
 472             if ($i->{barcode} eq $item_id) {
 473                                 # We have it checked out
 474                                 $item = C4::SIP::ILS::Item->new( $item_id );
 475                                 last;
 476                         }
 477                 }
 478     # }
 479
 480     $trans->item($item);
 481
 482     if (!defined($item)) {
 483                 $trans->screen_msg("Item not checked out to " . $patron->name);     # not checked out to $patron_id
 484         $trans->ok(0);
 485     } else {
 486         $trans->do_renew();
 487         if ($trans->renewal_ok()) {
 488             $item->{due_date} = $trans->{due};
 489             $trans->desensitize(0);
 490         }
 491     }
 492
 493     return $trans;
 494 }
 495
 496 sub renew_all {
 497     my ($self, $patron_id, $patron_pwd, $fee_ack) = @_;
 498     my ($patron, $item_id);
 499     my $trans;
 500
 501     $trans = C4::SIP::ILS::Transaction::RenewAll->new();
 502
 503     $trans->patron($patron = C4::SIP::ILS::Patron->new( $patron_id ));
 504     if (defined $patron) {
 505         siplog("LOG_DEBUG", "ILS::renew_all: patron '%s': renew_ok: %s", $patron->name, $patron->renew_ok);
 506     } else {
 507         siplog("LOG_DEBUG", "ILS::renew_all: Invalid patron id: '%s'", $patron_id);
 508     }
 509
 510     if (!$patron) {
 511                 $trans->screen_msg("Invalid patron barcode.");
 512                 return $trans;
 513     } elsif (!$patron->renew_ok) {
 514                 $trans->screen_msg("Renewals not allowed.");
 515                 return $trans;
 516     }
 517
 518         $trans->do_renew_all;
 519     $trans->ok(1);
 520     return $trans;
 521 }
 522
 523 1;
 524 __END__
 525