2 # ILS.pm: Koha ILS interface module
9 use Sys
::Syslog
qw(syslog);
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
;
25 'magnetic media' => 1,
26 'security inhibit' => 0,
27 'offline operation' => 0,
28 "patron status request" => 1,
34 "patron information" => 1,
35 "end patron session" => 1,
37 "item information" => 1,
38 "item status update" => 0,
46 my ($class, $institution) = @_;
47 my $type = ref($class) || $class;
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;
57 $debug and warn "ILS: finding patron";
58 return C4
::SIP
::ILS
::Patron
->new(@_);
63 $debug and warn "ILS: finding item";
64 return C4
::SIP
::ILS
::Item
->new(@_);
69 return $self->{institution
}->{id
}; # consider making this return the whole institution
74 return $self->{institution
}->{id
};
79 return (exists($supports{$op}) && $supports{$op});
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
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
101 return (exists($self->{institution
}->{policy
}->{checkout
})
102 && to_bool
($self->{institution
}->{policy
}->{checkout
}));
106 return (exists($self->{institution
}->{policy
}->{checkin
})
107 && to_bool
($self->{institution
}->{policy
}->{checkin
}));
109 sub status_update_ok
{
111 return (exists($self->{institution
}->{policy
}->{status_update
})
112 && to_bool
($self->{institution
}->{policy
}->{status_update
}));
116 return (exists($self->{institution
}->{policy
}->{offline
})
117 && to_bool
($self->{institution
}->{policy
}->{offline
}));
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
129 my ($self, $patron_id, $item_id, $sc_renew, $fee_ack) = @_;
130 my ($patron, $item, $circ);
132 $circ = C4
::SIP
::ILS
::Transaction
::Checkout
->new();
134 $circ->patron($patron = C4
::SIP
::ILS
::Patron
->new( $patron_id));
135 $circ->item($item = C4
::SIP
::ILS
::Item
->new( $item_id));
137 $circ->fee_ack($fee_ack);
141 $circ->screen_msg("Invalid Patron");
142 } elsif (!$patron->charge_ok) {
143 $circ->screen_msg("Patron Blocked");
145 $circ->screen_msg("Invalid Item");
146 # holds checked inside do_checkout
147 # } elsif ($item->hold_queue && @{$item->hold_queue} && ! $item->barcode_is_borrowernumber($patron_id, $item->hold_queue->[0]->{borrowernumber})) {
148 # $circ->screen_msg("Item on Hold for Another User");
149 } elsif ($item->{patron
} && ($item->{patron
} ne $patron_id)) {
150 # I can't deal with this right now
151 $circ->screen_msg("Item checked out to another patron");
153 $circ->do_checkout();
155 $debug and warn "circ is ok";
156 # If the item is already associated with this patron, then
158 $circ->renew_ok($item->{patron
} && ($item->{patron
} eq $patron_id));
160 $item->{patron
} = $patron_id;
161 $item->{due_date
} = $circ->{due
};
162 push(@
{$patron->{items
}}, $item_id);
163 $circ->desensitize(!$item->magnetic_media);
165 syslog
("LOG_DEBUG", "ILS::Checkout: patron %s has checked out %s",
166 $patron_id, join(', ', @
{$patron->{items
}}));
169 syslog
("LOG_ERR", "ILS::Checkout Issue failed");
178 my ( $self, $item_id, $trans_date, $return_date, $current_loc, $item_props, $cancel, $checked_in_ok ) = @_;
179 my ( $patron, $item, $circ );
181 $circ = C4
::SIP
::ILS
::Transaction
::Checkin
->new();
184 $circ->item( $item = C4
::SIP
::ILS
::Item
->new($item_id) );
187 $circ->do_checkin( $current_loc, $return_date );
191 $circ->alert_type(99);
192 $circ->screen_msg('Invalid Item');
195 # It's ok to check it in if it exists, and if it was checked out
196 # or it was not checked out but the checked_in_ok flag was set
197 $circ->ok( ( $checked_in_ok && $item ) || ( $item && $item->{patron
} ) );
198 syslog
("LOG_DEBUG", "C4::SIP::ILS::checkin - using checked_in_ok") if $checked_in_ok;
200 if ( !defined( $item->{patron
} ) ) {
201 $circ->screen_msg("Item not checked out") unless $checked_in_ok;
202 syslog
("LOG_DEBUG", "C4::SIP::ILS::checkin - item not checked out");
206 $circ->patron( $patron = C4
::SIP
::ILS
::Patron
->new( $item->{patron
} ) );
207 delete $item->{patron
};
208 delete $item->{due_date
};
209 $patron->{items
} = [ grep { $_ ne $item_id } @
{ $patron->{items
} } ];
218 # If the ILS caches patron information, this lets it free
220 sub end_patron_session
{
221 my ($self, $patron_id) = @_;
223 # success?, screen_msg, print_line
224 return (1, 'Thank you !', '');
228 my ($self, $patron_id, $patron_pwd, $fee_amt, $fee_type,
229 $pay_type, $fee_id, $trans_id, $currency) = @_;
232 $trans = C4
::SIP
::ILS
::Transaction
::FeePayment
->new();
235 $trans->transaction_id($trans_id);
237 $trans->patron($patron = C4
::SIP
::ILS
::Patron
->new($patron_id));
239 $trans->screen_msg('Invalid patron barcode.');
242 $trans->pay($patron->{borrowernumber
},$fee_amt, $pay_type);
249 my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
250 $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
253 my $trans = C4
::SIP
::ILS
::Transaction
::Hold
->new();
255 $patron = C4
::SIP
::ILS
::Patron
->new( $patron_id);
257 || (defined($patron_pwd) && !$patron->check_password($patron_pwd))) {
258 $trans->screen_msg("Invalid Patron.");
262 unless ($item = C4
::SIP
::ILS
::Item
->new($item_id || $title_id)) {
263 $trans->screen_msg("No such item.");
267 if ( $patron->holds_blocked_by_excessive_fees() ) {
268 $trans->screen_msg("Excessive fees blocking placement of hold.");
271 if ($item->fee and $fee_ack ne 'Y') {
272 $trans->screen_msg = "Fee required to place hold.";
277 item_id
=> $item->id,
278 patron_id
=> $patron->id,
279 expiration_date
=> $expiry_date,
280 pickup_location
=> $pickup_location,
281 hold_type
=> $hold_type,
285 $trans->patron($patron);
287 $trans->pickup_location($pickup_location);
290 push(@
{$item->hold_queue}, $hold);
291 push(@
{$patron->{hold_items
}}, $hold);
297 my ($self, $patron_id, $patron_pwd, $item_id, $title_id) = @_;
298 my ($patron, $item, $hold);
300 my $trans = C4
::SIP
::ILS
::Transaction
::Hold
->new();
302 $patron = C4
::SIP
::ILS
::Patron
->new( $patron_id );
304 $trans->screen_msg("Invalid patron barcode.");
306 } elsif (defined($patron_pwd) && !$patron->check_password($patron_pwd)) {
307 $trans->screen_msg('Invalid patron password.');
311 unless ($item = C4
::SIP
::ILS
::Item
->new($item_id || $title_id)) {
312 $trans->screen_msg("No such item.");
316 $trans->patron($patron);
319 unless ($trans->ok) {
320 $trans->screen_msg("Error with transaction drop_hold: " . $trans->screen_msg);
323 # Remove the hold from the patron's record first
324 $trans->ok($patron->drop_hold($item_id)); # different than the transaction drop!
326 unless ($trans->ok) {
327 # We didn't find it on the patron record
328 $trans->screen_msg("No such hold on patron record.");
332 # Now, remove it from the item record. If it was on the patron
333 # record but not on the item record, we'll treat that as success.
334 foreach my $i (0 .. scalar @
{$item->hold_queue}) {
335 $hold = $item->hold_queue->[$i];
336 if ($item->barcode_is_borrowernumber($patron->id, $hold->{borrowernumber
})) {
337 # found it: delete it.
338 splice @
{$item->hold_queue}, $i, 1;
339 last; # ?? should we keep going, in case there are multiples
343 $trans->screen_msg("Hold Cancelled.");
349 # The patron and item id's can't be altered, but the
350 # date, location, and type can.
352 my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
353 $expiry_date, $pickup_location, $hold_type, $fee_ack) = @_;
358 $trans = C4
::SIP
::ILS
::Transaction
::Hold
->new();
361 $patron = C4
::SIP
::ILS
::Patron
->new( $patron_id );
363 $trans->screen_msg("Invalid patron barcode: '$patron_id'.");
367 foreach my $i (0 .. scalar @
{$patron->{hold_items
}}) {
368 $hold = $patron->{hold_items
}[$i];
370 if ($hold->{item_id
} eq $item_id) {
371 # Found it. So fix it.
372 $hold->{expiration_date
} = $expiry_date if $expiry_date;
373 $hold->{pickup_location
} = $pickup_location if $pickup_location;
374 $hold->{hold_type
} = $hold_type if $hold_type;
375 $trans->change_hold();
377 $trans->screen_msg("Hold updated.");
378 $trans->patron($patron);
379 $trans->item(C4
::SIP
::ILS
::Item
->new( $hold->{item_id
}));
384 # The same hold structure is linked into both the patron's
385 # list of hold items and into the queue of outstanding holds
386 # for the item, so we don't need to search the hold queue for
387 # the item, since it's already been updated by the patron code.
390 $trans->screen_msg("No such outstanding hold.");
397 my ($self, $patron_id, $patron_pwd, $item_id, $title_id,
398 $no_block, $nb_due_date, $third_party,
399 $item_props, $fee_ack) = @_;
403 $trans = C4
::SIP
::ILS
::Transaction
::Renew
->new();
404 $trans->patron($patron = C4
::SIP
::ILS
::Patron
->new( $patron_id ));
407 $trans->screen_msg("Invalid patron barcode.");
409 } elsif (!$patron->renew_ok) {
410 $trans->screen_msg("Renewals not allowed.");
414 # Previously: renewing a title, rather than an item (sort of)
415 # This is gross, but in a real ILS it would be better
417 # if (defined($title_id)) {
418 # foreach my $i (@{$patron->{items}}) {
419 # $item = new ILS::Item $i;
420 # last if ($title_id eq $item->title_id);
425 my $count = scalar @
{$patron->{items
}};
426 foreach my $i (@
{$patron->{items
}}) {
427 unless (defined $i->{barcode
}) { # FIXME: using data instead of objects may violate the abstraction layer
428 syslog
("LOG_ERR", "No barcode for item %s of %s: $item_id", $j+1, $count);
431 syslog
("LOG_DEBUG", "checking item %s of %s: $item_id vs. %s", ++$j, $count, $i->{barcode
});
432 if ($i->{barcode
} eq $item_id) {
433 # We have it checked out
434 $item = C4
::SIP
::ILS
::Item
->new( $item_id );
442 if (!defined($item)) {
443 $trans->screen_msg("Item not checked out to " . $patron->name); # not checked out to $patron_id
447 if ($trans->renewal_ok()) {
448 $item->{due_date
} = $trans->{due
};
449 $trans->desensitize(0);
457 my ($self, $patron_id, $patron_pwd, $fee_ack) = @_;
458 my ($patron, $item_id);
461 $trans = C4
::SIP
::ILS
::Transaction
::RenewAll
->new();
463 $trans->patron($patron = C4
::SIP
::ILS
::Patron
->new( $patron_id ));
464 if (defined $patron) {
465 syslog
("LOG_DEBUG", "ILS::renew_all: patron '%s': renew_ok: %s", $patron->name, $patron->renew_ok);
467 syslog
("LOG_DEBUG", "ILS::renew_all: Invalid patron id: '%s'", $patron_id);
470 if (!defined($patron)) {
471 $trans->screen_msg("Invalid patron barcode.");
473 } elsif (!$patron->renew_ok) {
474 $trans->screen_msg("Renewals not allowed.");
476 } elsif (defined($patron_pwd) && !$patron->check_password($patron_pwd)) {
477 $trans->screen_msg("Invalid patron password.");
481 $trans->do_renew_all;