1 # ---------------------------------------------------------------
2 # Copyright © 2014 Jason J.A. Stephenson <jason@sigio.com>
4 # This file is part of NCIPServer.
6 # NCIPServer is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # NCIPServer is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with NCIPServer. If not, see <http://www.gnu.org/licenses/>.
18 # ---------------------------------------------------------------
19 package NCIP::ILS::Evergreen;
22 use XML::LibXML::Simple qw(XMLin);
24 use DateTime::Format::ISO8601;
25 use Digest::MD5 qw/md5_hex/;
27 use OpenSRF::AppSession;
28 use OpenSRF::Utils qw/:datetime/;
29 use OpenSRF::Utils::SettingsClient;
30 use OpenILS::Utils::Fieldmapper;
31 use OpenILS::Utils::Normalize qw(clean_marc);
32 use OpenILS::Application::AppUtils;
33 use OpenILS::Const qw/:const/;
37 use List::MoreUtils qw/uniq/;
38 use POSIX qw/strftime/;
40 # We need a bunch of NCIP::* objects.
44 use NCIP::User::OptionalFields;
45 use NCIP::User::AddressInformation;
47 use NCIP::User::BlockOrTrap;
48 use NCIP::User::Privilege;
49 use NCIP::User::PrivilegeStatus;
50 use NCIP::StructuredPersonalUserName;
51 use NCIP::StructuredAddress;
52 use NCIP::ElectronicAddress;
56 # Inherit from NCIP::ILS.
57 use parent qw(NCIP::ILS);
61 Evergreen - Evergreen driver for NCIPServer
65 my $ils = NCIP::ILS::Evergreen->new(name => $config->{NCIP.ils.value});
69 NCIP::ILS::Evergreen is the default driver for Evergreen and
70 NCIPServer. It was initially developed to work with Auto-Graphics'
71 SHAREit software using a subset of an unspecified ILL/DCB profile.
75 # Default values we define for things that might be missing in our
76 # runtime environment or configuration file that absolutely must have
79 # OILS_NCIP_CONFIG_DEFAULT is the default location to find our
80 # driver's configuration file. This location can be overridden by
81 # setting the path in the OILS_NCIP_CONFIG environment variable.
83 # BIB_SOURCE_DEFAULT is the config.bib_source.id to use when creating
84 # "short" bibs. It is used only if no entry is supplied in the
85 # configuration file. The provided default is 2, the id of the
86 # "System Local" source that comes with a default Evergreen
89 OILS_NCIP_CONFIG_DEFAULT => '/openils/conf/oils_ncip.xml',
90 BIB_SOURCE_DEFAULT => 2
93 # A common Evergreen code shortcut to use AppUtils:
94 my $U = 'OpenILS::Application::AppUtils';
96 # The usual constructor:
99 $class = ref($class) if (ref $class);
101 # Instantiate our parent with the rest of the arguments. It
102 # creates a blessed hashref.
103 my $self = $class->SUPER::new(@_);
105 # Look for our configuration file, load, and parse it:
108 # Bootstrap OpenSRF and prepare some OpenILS components.
111 # Initialize the rest of our internal state.
117 =head1 HANDLER METHODS
121 $ils->lookupuser($request);
123 Processes a LookupUser request.
131 # Check our session and login if necessary.
132 $self->login() unless ($self->checkauth());
134 my $message_type = $self->parse_request_type($request);
136 # Let's go ahead and create our response object. We need this even
137 # if there is a problem.
138 my $response = NCIP::Response->new({type => $message_type . "Response"});
139 $response->header($self->make_header($request));
141 # Need to parse the request object to get the user barcode.
142 my ($barcode, $idfield) = $self->find_user_barcode($request);
144 # If we did not find a barcode, then report the problem.
145 if (ref($barcode) eq 'NCIP::Problem') {
146 $response->problem($barcode);
150 # Look up our patron by barcode:
151 my $user = $self->retrieve_user_by_barcode($barcode, $idfield);
152 if (ref($user) eq 'NCIP::Problem') {
153 $response->problem($user);
157 # We got the information, so lets fill in our userdata.
158 my $userdata = NCIP::User->new();
160 # Make an array of the user's active barcodes.
162 foreach my $card (@{$user->cards()}) {
163 if ($U->is_true($card->active())) {
164 my $id = NCIP::User::Id->new({
165 UserIdentifierType => 'Barcode',
166 UserIdentifierValue => $card->barcode()
171 $userdata->UserId($ids);
173 # Check if they requested any optional fields and return those.
174 my $elements = $request->{$message_type}->{UserElementType};
176 $elements = [$elements] unless (ref $elements eq 'ARRAY');
177 my $optionalfields = NCIP::User::OptionalFields->new();
179 # First, we'll look for name information.
180 if (grep {$_ eq 'Name Information'} @$elements) {
181 my $name = NCIP::StructuredPersonalUserName->new();
182 $name->Surname($user->family_name());
183 $name->GivenName($user->first_given_name());
184 $name->Prefix($user->prefix());
185 $name->Suffix($user->suffix());
186 $optionalfields->NameInformation($name);
189 # Next, check for user address information.
190 if (grep {$_ eq 'User Address Information'} @$elements) {
193 # See if the user has any valid, physcial addresses.
194 foreach my $addr (@{$user->addresses()}) {
195 next if ($U->is_true($addr->pending()));
196 my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>$addr->address_type()});
197 my $physical = NCIP::StructuredAddress->new();
198 $physical->Line1($addr->street1());
199 $physical->Line2($addr->street2());
200 $physical->Locality($addr->city());
201 $physical->Region($addr->state());
202 $physical->PostalCode($addr->post_code());
203 $physical->Country($addr->country());
204 $address->PhysicalAddress($physical);
205 push @$addresses, $address;
208 # Right now, we're only sharing email address if the user
209 # has it. We don't share phone numbers.
210 if ($user->email()) {
211 my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>'Email Address'});
212 $address->ElectronicAddress(
213 NCIP::ElectronicAddress->new({
214 Type=>'Email Address',
218 push @$addresses, $address;
221 $optionalfields->UserAddressInformation($addresses);
224 # Check for User Privilege.
225 if (grep {$_ eq 'User Privilege'} @$elements) {
226 # Get the user's group:
227 my $pgt = $U->simplereq(
229 'open-ils.pcrud.retrieve.pgt',
230 $self->{session}->{authtoken},
234 my $privilege = NCIP::User::Privilege->new();
235 $privilege->AgencyId($user->home_ou->shortname());
236 $privilege->AgencyUserPrivilegeType($pgt->name());
237 $privilege->ValidToDate($user->expire_date());
238 $privilege->ValidFromDate($user->create_date());
240 my $status = 'Active';
241 if (_expired($user)) {
243 } elsif ($U->is_true($user->barred())) {
245 } elsif (!$U->is_true($user->active())) {
246 $status = 'Inactive';
249 $privilege->UserPrivilegeStatus(
250 NCIP::User::PrivilegeStatus->new({
251 UserPrivilegeStatusType => $status
256 $optionalfields->UserPrivilege([$privilege]);
260 # Check for Block Or Trap.
261 if (grep {$_ eq 'Block Or Trap'} @$elements) {
264 # First, let's check if the profile is blocked from ILL.
265 if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
266 my $block = NCIP::User::BlockOrTrap->new();
267 $block->AgencyId($user->home_ou->shortname());
268 $block->BlockOrTrapType('Block Interlibrary Loan');
269 push @$blocks, $block;
272 # Next, we loop through the user's standing penalties
273 # looking for blocks on CIRC, HOLD, and RENEW.
274 my ($have_circ, $have_renew, $have_hold) = (0,0,0);
275 foreach my $penalty (@{$user->standing_penalties()}) {
276 next unless($penalty->standing_penalty->block_list());
277 my @block_list = split(/\|/, $penalty->standing_penalty->block_list());
278 my $ou = $U->simplereq(
280 'open-ils.pcrud.retrieve.aou',
281 $self->{session}->{authtoken},
286 if (!$have_circ && grep {$_ eq 'CIRC'} @block_list) {
287 my $bot = NCIP::User::BlockOrTrap->new();
288 $bot->AgencyId($ou->shortname());
289 $bot->BlockOrTrapType('Block Checkout');
295 if (!$have_hold && grep {$_ eq 'HOLD' || $_ eq 'FULFILL'} @block_list) {
296 my $bot = NCIP::User::BlockOrTrap->new();
297 $bot->AgencyId($ou->shortname());
298 $bot->BlockOrTrapType('Block Holds');
304 if (!$have_renew && grep {$_ eq 'RENEW'} @block_list) {
305 my $bot = NCIP::User::BlockOrTrap->new();
306 $bot->AgencyId($ou->shortname());
307 $bot->BlockOrTrapType('Block Renewals');
312 # Stop after we report one of each, even if more
314 last if ($have_circ && $have_renew && $have_hold);
317 $optionalfields->BlockOrTrap($blocks);
320 $userdata->UserOptionalFields($optionalfields);
323 $response->data($userdata);
330 $ils->acceptitem($request);
332 Processes an AcceptItem request.
340 # Check our session and login if necessary.
341 $self->login() unless ($self->checkauth());
343 # Common preparation.
344 my $message = $self->parse_request_type($request);
345 my $response = NCIP::Response->new({type => $message . 'Response'});
346 $response->header($self->make_header($request));
348 # We only accept holds for the time being.
349 if ($request->{$message}->{RequestedActionType} !~ /^hold\w/i) {
350 # We need the item id or we can't do anything at all.
351 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
352 if (ref($item_barcode) eq 'NCIP::Problem') {
353 $response->problem($item_barcode);
357 # We need to find a patron barcode or we can't look anyone up
359 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request, 'UserIdentifierValue');
360 if (ref($user_barcode) eq 'NCIP::Problem') {
361 $response->problem($user_barcode);
364 # Look up our patron by barcode:
365 my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
366 if (ref($user) eq 'NCIP::Problem') {
367 $response->problem($user);
370 # We're doing patron checks before looking for bibliographic
371 # information and creating the item because problems with the
372 # patron are more likely to occur.
373 my $problem = $self->check_user_for_problems($user, 'HOLD');
375 $response->problem($problem);
379 # Check if the item barcode already exists:
380 my $item = $self->retrieve_copy_details_by_barcode($item_barcode);
382 # What to do here was not defined in the
383 # specification. Since the copies that we create this way
384 # should get deleted when checked in, it would be an error
385 # if we try to create another one. It means that something
386 # has gone wrong somewhere.
390 ProblemType => 'Duplicate Item',
391 ProblemDetail => "Item with barcode $item_barcode already exists.",
392 ProblemElement => $item_idfield,
393 ProblemValue => $item_barcode
400 # Now, we have to create our new copy and/or bib and call number.
402 # First, we have to gather the necessary information from the
403 # request. Store in a hashref for convenience. We may write a
404 # method to get this information in the future if we find we
405 # need it in other handlers. Such a function would be a
406 # candidate to go into our parent, NCIP::ILS.
408 barcode => $item_barcode,
409 call_number => $request->{$message}->{ItemOptionalFields}->{ItemDescription}->{CallNumber},
410 title => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{Author},
411 author => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{Title},
412 publisher => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{Publisher},
413 publication_date => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{PublicationDate},
414 medium => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{MediumType},
415 electronic => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{ElectronicResource}
418 if ($self->{config}->{items}->{use_precats}) {
419 # We only need to create a precat copy.
420 $item = $self->create_precat_copy($item_info);
422 # We have to create a "partial" bib record, a call number and a copy.
423 $item = $self->create_fuller_copy($item_info);
426 # If we failed to create the copy, report a problem.
430 ProblemType => 'Temporary Processing Failure',
431 ProblemDetail => 'Failed to create the item in the system',
432 ProblemElement => $item_idfield,
433 ProblemValue => $item_barcode
439 # We try to find the pickup location in our database. It's OK
440 # if it does not exist, the user's home library will be used
442 my $location = $request->{$message}->{PickupLocation};
444 $location = $self->retrieve_org_unit_by_shortname($location);
447 # Now, we place the hold on the newly created copy on behalf
448 # of the patron retrieved above.
449 my $hold = $self->place_hold($item, $user, $location);
450 if (ref($hold) eq 'NCIP::Problem') {
451 $response->problem($hold);
455 # We return the RequestId and optionally, the ItemID. We'll
456 # just return what was sent to us, since we ignored all of it
459 $data->{RequestId} = NCIP::RequestId->new(
461 AgencyId => $request->{$message}->{RequestId}->{AgencyId},
462 RequestIdentifierType => $request->{$message}->{RequestId}->{RequestIdentifierType},
463 RequestIdentifierValue => $request->{$message}->{RequestId}->{RequestIdentifierValue}
466 $data->{ItemId} = NCIP::Item::Id->new(
468 AgencyId => $request->{$message}->{ItemId}->{AgencyId},
469 ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
470 ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
473 $response->data($data);
476 my $problem = NCIP::Problem->new();
477 $problem->ProblemType('Unauthorized Combination Of Element Values For System');
478 $problem->ProblemDetail('We only support Hold For Pickup');
479 $problem->ProblemElement('RequestedActionType');
480 $problem->ProblemValue($request->{$message}->{RequestedActionType});
481 $response->problem($problem);
489 $response = $ils->checkinitem($request);
491 Checks the item in if we can find the barcode in the message. It
492 returns problems if it cannot find the item in the system or if the
493 item is not checked out.
495 It could definitely use some more brains at some point as it does not
496 fully support everything that the standard allows. It also does not
497 really check if the checkin succeeded or not.
505 # Check our session and login if necessary:
506 $self->login() unless ($self->checkauth());
509 my $message = $self->parse_request_type($request);
510 my $response = NCIP::Response->new({type => $message . 'Response'});
511 $response->header($self->make_header($request));
513 # We need the copy barcode from the message.
514 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
515 if (ref($item_barcode) eq 'NCIP::Problem') {
516 $response->problem($item_barcode);
520 # Retrieve the copy details.
521 my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
523 # Return an Unkown Item problem unless we find the copy.
527 ProblemType => 'Unknown Item',
528 ProblemDetail => "Item with barcode $item_barcode is not known.",
529 ProblemElement => $item_idfield,
530 ProblemValue => $item_barcode
537 # Check if a UserId was provided. If so, this is the patron to
538 # whom the copy should be checked out.
540 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
541 # We ignore the problem, because the UserId is optional.
542 if (ref($user_barcode) ne 'NCIP::Problem') {
543 $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
544 # We don't ignore a problem here, however.
545 if (ref($user) eq 'NCIP::Problem') {
546 $response->problem($user);
552 my $copy = $details->{copy};
554 # Look for a circulation and examine its information:
555 my $circ = $details->{circ};
557 # Check the circ details to see if the copy is checked out and, if
558 # the patron was provided, that it is checked out to the patron in
559 # question. We also verify the copy ownership and circulation
561 my $problem = $self->check_circ_details($circ, $copy, $user);
563 # We need to fill in some information, however.
564 if (!$problem->ProblemValue() && !$problem->ProblemElement()) {
565 $problem->ProblemValue($user_barcode);
566 $problem->ProblemElement($user_idfield);
567 } elsif (!$problem->ProblemElement()) {
568 $problem->ProblemElement($item_idfield);
570 $response->problem($problem);
574 # Checkin parameters. We want to skip hold targeting or making
575 # transits, to force the checkin despite the copy status, as
576 # well as void overdues.
578 copy_barcode => $copy->barcode(),
583 my $result = $U->simplereq(
585 'open-ils.circ.checkin.override',
586 $self->{session}->{authtoken},
589 if (ref($result) eq 'ARRAY') {
590 $result = $result->[0];
592 if ($result->{textcode} eq 'SUCCESS') {
593 # Delete the copy. Since delete_copy checks ownership
594 # before attempting to delete the copy, we don't bother
595 # checking who owns it.
596 $self->delete_copy($copy);
597 # We need the circulation user for the information below, so we retrieve it.
598 my $circ_user = $self->retrieve_user_by_id($circ->usr());
600 ItemId => NCIP::Item::Id->new(
602 AgencyId => $request->{$message}->{ItemId}->{AgencyId},
603 ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
604 ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
607 UserId => NCIP::User::Id->new(
609 UserIdentifierType => 'Barcode Id',
610 UserIdentifierValue => $circ_user->card->barcode()
615 $response->data($data);
617 # At some point in the future, we should probably check if
618 # they requested optional user or item elements and return
619 # those. For the time being, we ignore those at the risk of
620 # being considered non-compliant.
622 $response->problem(_problem_from_event('Checkin Failed', $result));
630 $response = $ils->renewitem($request);
632 Handle the RenewItem message.
640 # Check our session and login if necessary:
641 $self->login() unless ($self->checkauth());
644 my $message = $self->parse_request_type($request);
645 my $response = NCIP::Response->new({type => $message . 'Response'});
646 $response->header($self->make_header($request));
648 # We need the copy barcode from the message.
649 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
650 if (ref($item_barcode) eq 'NCIP::Problem') {
651 $response->problem($item_barcode);
655 # Retrieve the copy details.
656 my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
658 # Return an Unkown Item problem unless we find the copy.
662 ProblemType => 'Unknown Item',
663 ProblemDetail => "Item with barcode $item_barcode is not known.",
664 ProblemElement => $item_idfield,
665 ProblemValue => $item_barcode
672 # User is required for RenewItem.
673 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
674 if (ref($user_barcode) eq 'NCIP::Problem') {
675 $response->problem($user_barcode);
678 my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
679 if (ref($user) eq 'NCIP::Problem') {
680 $response->problem($user);
685 my $copy = $details->{copy};
687 # Look for a circulation and examine its information:
688 my $circ = $details->{circ};
690 # Check the circ details to see if the copy is checked out and, if
691 # the patron was provided, that it is checked out to the patron in
692 # question. We also verify the copy ownership and circulation
694 my $problem = $self->check_circ_details($circ, $copy, $user);
696 # We need to fill in some information, however.
697 if (!$problem->ProblemValue() && !$problem->ProblemElement()) {
698 $problem->ProblemValue($user_barcode);
699 $problem->ProblemElement($user_idfield);
700 } elsif (!$problem->ProblemElement()) {
701 $problem->ProblemElement($item_idfield);
703 $response->problem($problem);
707 # Check if user is blocked from renewals:
708 $problem = $self->check_user_for_problems($user, 'RENEW');
710 # Replace the ProblemElement and ProblemValue fields.
711 $problem->ProblemElement($user_idfield);
712 $problem->ProblemValue($user_barcode);
713 $response->problem($problem);
717 # Check if the duration rule allows renewals. It should have been
718 # fleshed during the copy details retrieve.
719 my $rule = $circ->duration_rule();
720 unless (ref($rule)) {
721 $rule = $U->simplereq(
723 'open-ils.pcrud.retrieve.crcd',
724 $self->{session}->{authtoken},
728 if ($rule->max_renewals() < 1) {
732 ProblemType => 'Item Not Renewable',
733 ProblemDetail => 'Item may not be renewed.',
734 ProblemElement => $item_idfield,
735 ProblemValue => $item_barcode
742 # Check if there are renewals remaining on the latest circ:
743 if ($circ->renewal_remaining() < 1) {
747 ProblemType => 'Maximum Renewals Exceeded',
748 ProblemDetail => 'Renewal cannot proceed because the User has already renewed the Item the maximum number of times permitted.',
749 ProblemElement => $item_idfield,
750 ProblemValue => $item_barcode
757 # Now, we attempt the renewal. If it fails, we simply say that the
758 # user is not allowed to renew this item, without getting into
762 patron_id => $user->id(),
765 my $r = $U->simplereq(
767 'open-ils.circ.renew.override',
768 $self->{session}->{authtoken},
772 # We only look at the first one, since more than one usually means
774 if (ref($r) eq 'ARRAY') {
777 if ($r->{textcode} ne 'SUCCESS') {
778 $problem = _problem_from_event('Renewal Failed', $r);
779 $response->problem($problem);
782 ItemId => NCIP::Item::Id->new(
784 AgencyId => $request->{$message}->{ItemId}->{AgencyId},
785 ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
786 ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
789 UserId => NCIP::User::Id->new(
791 UserIdentifierType => 'Barcode Id',
792 UserIdentifierValue => $user->card->barcode()
796 # We need to retrieve the copy details again to refresh our
797 # circ information to get the new due date.
798 $details = $self->retrieve_copy_details_by_barcode($item_barcode);
799 $circ = $details->{circ};
800 my $due = DateTime::Format::ISO8601->parse_datetime(cleanse_ISO8601($circ->due_date()));
801 $due->set_time_zone('UTC');
802 $data->{DateDue} = $due->iso8601();
804 $response->data($data);
807 # At some point in the future, we should probably check if
808 # they requested optional user or item elements and return
809 # those. For the time being, we ignore those at the risk of
810 # being considered non-compliant.
817 $response = $ils->checkoutitem($request);
819 Handle the Checkoutitem message.
827 # Check our session and login if necessary:
828 $self->login() unless ($self->checkauth());
831 my $message = $self->parse_request_type($request);
832 my $response = NCIP::Response->new({type => $message . 'Response'});
833 $response->header($self->make_header($request));
835 # We need the copy barcode from the message.
836 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
837 if (ref($item_barcode) eq 'NCIP::Problem') {
838 $response->problem($item_barcode);
842 # Retrieve the copy details.
843 my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
845 # Return an Unkown Item problem unless we find the copy.
849 ProblemType => 'Unknown Item',
850 ProblemDetail => "Item with barcode $item_barcode is not known.",
851 ProblemElement => $item_idfield,
852 ProblemValue => $item_barcode
859 # User is required for CheckOutItem.
860 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
861 if (ref($user_barcode) eq 'NCIP::Problem') {
862 $response->problem($user_barcode);
865 my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
866 if (ref($user) eq 'NCIP::Problem') {
867 $response->problem($user);
872 my $copy = $details->{copy};
874 # Check if the copy can circulate.
875 unless ($self->copy_can_circulate($copy)) {
879 ProblemType => 'Item Does Not Circulate',
880 ProblemDetail => "Item with barcode $item_barcode does not circulate.",
881 ProblemElement => $item_idfield,
882 ProblemValue => $item_barcode
889 # Look for a circulation and examine its information:
890 my $circ = $details->{circ};
892 # Check if the item is already checked out.
893 if ($circ && !$circ->checkin_time()) {
897 ProblemType => 'Item Already Checked Out',
898 ProblemDetail => "Item with barcode $item_barcode is already checked out.",
899 ProblemElement => $item_idfield,
900 ProblemValue => $item_barcode
907 # Check if user is blocked from circulation:
908 my $problem = $self->check_user_for_problems($user, 'CIRC');
910 # Replace the ProblemElement and ProblemValue fields.
911 $problem->ProblemElement($user_idfield);
912 $problem->ProblemValue($user_barcode);
913 $response->problem($problem);
917 # Now, we attempt the check out. If it fails, we simply say that
918 # the user is not allowed to check out this item, without getting
922 patron_id => $user->id(),
924 my $r = $U->simplereq(
926 'open-ils.circ.checkout.full.override',
927 $self->{session}->{authtoken},
931 # We only look at the first one, since more than one usually means
933 if (ref($r) eq 'ARRAY') {
936 if ($r->{textcode} ne 'SUCCESS') {
937 $problem = _problem_from_event('Check Out Failed', $r);
938 $response->problem($problem);
941 ItemId => NCIP::Item::Id->new(
943 AgencyId => $request->{$message}->{ItemId}->{AgencyId},
944 ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
945 ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
948 UserId => NCIP::User::Id->new(
950 UserIdentifierType => 'Barcode Id',
951 UserIdentifierValue => $user->card->barcode()
955 # We need to retrieve the copy details again to refresh our
956 # circ information to get the due date.
957 $details = $self->retrieve_copy_details_by_barcode($item_barcode);
958 $circ = $details->{circ};
959 my $due = DateTime::Format::ISO8601->parse_datetime(cleanse_ISO8601($circ->due_date()));
960 $due->set_time_zone('UTC');
961 $data->{DateDue} = $due->iso8601();
963 $response->data($data);
966 # At some point in the future, we should probably check if
967 # they requested optional user or item elements and return
968 # those. For the time being, we ignore those at the risk of
969 # being considered non-compliant.
976 $response = $ils->requestitem($request);
978 Handle the NCIP RequestItem message.
985 # Check our session and login if necessary:
986 $self->login() unless ($self->checkauth());
989 my $message = $self->parse_request_type($request);
990 my $response = NCIP::Response->new({type => $message . 'Response'});
991 $response->header($self->make_header($request));
993 # Because we need to have a user to place a hold, because the user
994 # is likely to have problems, and because getting the item
995 # information for the hold is trickier than getting the user
996 # information, we'll do the user first and short circuit out of
997 # the function if there is a problem with the user.
998 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
999 if (ref($user_barcode) eq 'NCIP::Problem') {
1000 $response->problem($user_barcode);
1003 my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
1004 if (ref($user) eq 'NCIP::Problem') {
1005 $response->problem($user);
1008 my $problem = $self->check_user_for_problems($user, 'HOLD');
1010 $response->problem($problem);
1014 # RequestItem is a blast. We need to check if we have a copy
1015 # barcode and if we have BibliographicId. If we have both or
1016 # either, we then need to figure out what we're placing the hold
1017 # on, a copy, a volume or a bib. We don't currently do part holds,
1018 # but maybe we should some day.
1020 # We want $copy_details visible in the whole function, though we
1021 # only retrieve it if we have a barcode.
1023 # We need the copy barcode from the message.
1024 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
1025 if (ref($item_barcode) ne 'NCIP::Problem') {
1026 # Retrieve the copy details.
1027 $copy_details = $self->retrieve_copy_details_by_barcode($item_barcode);
1028 unless ($copy_details) {
1029 # Return an Unkown Item problem unless we find the copy.
1033 ProblemType => 'Unknown Item',
1034 ProblemDetail => "Item with barcode $item_barcode is not known.",
1035 ProblemElement => $item_idfield,
1036 ProblemValue => $item_barcode
1044 # We need to look for BibliographicId.
1046 my $biblio_id = $self->find_bibliographic_id($request, 'SYSNUMBER');
1049 if (ref($biblio_id) eq 'NCIP::Item::BibliographicRecordId') {
1050 $bibid = $biblio_id->BibliographicRecordIdentifier();
1052 $bibid = $biblio_id->BibliographicItemIdentifier();
1054 $bre = $self->retrieve_biblio_record_entry($bibid) if ($bibid);
1055 undef($bre) if ($bre && $U->is_true($bre->deleted()));
1058 # Now, we can determine what "item" we're putting on hold: a
1061 if ($copy_details) {
1062 $item = $copy_details->{volume};
1067 # If we don't have an item, then blow up with a problem that may
1068 # have been set when we went looking for the ItemId.
1070 if (ref($item_barcode) eq 'NCIP::Problem') {
1071 $response->problem($item_barcode);
1076 ProblemType => 'Request Item Not Found',
1077 ProblemDetail => 'Unable to determine the item to request from input message.',
1078 ProblemElement => 'NULL',
1079 ProblemValue => 'NULL'
1087 # See if we were given a PickupLocation.
1089 if ($request->{$message}->{PickupLocation}) {
1090 my $loc = $request->{$message}->{PickupLocation};
1091 $loc =~ s/^.*://; # strip everything up to the last
1092 # semi-colon, if any.
1093 $location = $self->retrieve_org_unit_by_shortname($loc);
1097 my $hold = $self->place_hold($item, $user, $location);
1098 if (ref($hold) eq 'NCIP::Problem') {
1099 $response->problem($hold);
1102 RequestId => NCIP::RequestId->new(
1103 RequestIdentifierType => 'SYSNUMBER',
1104 RequestIdentifierValue => $hold->id()
1106 UserId => NCIP::User::Id->new(
1108 UserIdentifierType => 'Barcode Id',
1109 UserIdentifierValue => $user->card->barcode()
1112 RequestType => $request->{$message}->{RequestType},
1113 RequestScopeType => ($hold->hold_type() eq 'V') ? "item" : "bibliographic item"
1115 $response->data($data);
1121 =head1 METHODS USEFUL to SUBCLASSES
1127 Login to Evergreen via OpenSRF. It uses internal state from the
1128 configuration file to login.
1132 # Login via OpenSRF to Evergreen.
1136 # Get the authentication seed.
1137 my $seed = $U->simplereq(
1139 'open-ils.auth.authenticate.init',
1140 $self->{config}->{credentials}->{username}
1145 my $response = $U->simplereq(
1147 'open-ils.auth.authenticate.complete',
1149 username => $self->{config}->{credentials}->{username},
1150 password => md5_hex(
1151 $seed . md5_hex($self->{config}->{credentials}->{password})
1154 workstation => $self->{config}->{credentials}->{workstation}
1158 $self->{session}->{authtoken} = $response->{payload}->{authtoken};
1159 $self->{session}->{authtime} = $response->{payload}->{authtime};
1161 # Set/reset the work_ou and user data in case something changed.
1163 # Retrieve the work_ou as an object.
1164 $self->{session}->{work_ou} = $U->simplereq(
1166 'open-ils.pcrud.search.aou',
1167 $self->{session}->{authtoken},
1168 {shortname => $self->{config}->{credentials}->{work_ou}}
1171 # We need the user information in order to do some things.
1172 $self->{session}->{user} = $U->check_user_session($self->{session}->{authtoken});
1180 $valid = $ils->checkauth();
1182 Returns 1 if the object a 'valid' authtoken, 0 if not.
1189 # We use AppUtils to do the heavy lifting.
1190 if (defined($self->{session})) {
1191 if ($U->check_user_session($self->{session}->{authtoken})) {
1198 # If we reach here, we don't have a session, so we are definitely
1203 =head2 retrieve_user_by_barcode
1205 $user = $ils->retrieve_user_by_barcode($user_barcode, $user_idfield);
1207 Do a fleshed retrieve of a patron by barcode. Return the patron if
1208 found and valid. Return a NCIP::Problem of 'Unknown User' otherwise.
1210 The id field argument is used for the ProblemElement field in the
1211 NCIP::Problem object.
1213 An invalid patron is one where the barcode is not found in the
1214 database, the patron is deleted, or the barcode used to retrieve the
1215 patron is not active. The problem element is also returned if an error
1216 occurs during the retrieval.
1220 sub retrieve_user_by_barcode {
1221 my ($self, $barcode, $idfield) = @_;
1222 my $result = $U->simplereq(
1224 'open-ils.actor.user.fleshed.retrieve_by_barcode',
1225 $self->{session}->{authtoken},
1230 # Check for a failure, or a deleted, inactive, or expired user,
1231 # and if so, return empty userdata.
1232 if (!$result || $U->event_code($result) || $U->is_true($result->deleted())
1233 || !grep {$_->barcode() eq $barcode && $U->is_true($_->active())} @{$result->cards()}) {
1235 my $problem = NCIP::Problem->new();
1236 $problem->ProblemType('Unknown User');
1237 $problem->ProblemDetail("User with barcode $barcode unknown");
1238 $problem->ProblemElement($idfield);
1239 $problem->ProblemValue($barcode);
1246 =head2 retrieve_user_by_id
1248 $user = $ils->retrieve_user_by_id($id);
1250 Similar to C<retrieve_user_by_barcode> but takes the user's database
1251 id rather than barcode. This is useful when you have a circulation or
1252 hold and need to get information about the user's involved in the hold
1255 It returns a fleshed user on success or undef on failure.
1259 sub retrieve_user_by_id {
1260 my ($self, $id) = @_;
1262 # Do a fleshed retrieve of the patron, and flesh the fields that
1263 # we would normally use.
1264 my $result = $U->simplereq(
1266 'open-ils.actor.user.fleshed.retrieve',
1267 $self->{session}->{authtoken},
1269 [ 'card', 'cards', 'standing_penalties', 'addresses', 'home_ou' ]
1271 # Check for an error.
1272 undef($result) if ($result && $U->event_code($result));
1277 =head2 check_user_for_problems
1279 $problem = $ils>check_user_for_problems($user, 'HOLD, 'CIRC', 'RENEW');
1281 This function checks if a user has a blocked profile or any from a
1282 list of provided blocks. If it does, then a NCIP::Problem object is
1283 returned, otherwise an undefined value is returned.
1285 The list of blocks appears as additional arguments after the user. You
1286 can provide any value(s) that might appear in a standing penalty block
1287 lit in Evergreen. The example above checks for HOLD, CIRC, and
1288 RENEW. Any number of such values can be provided. If none are
1289 provided, the function only checks if the patron's profiles appears in
1290 the object's blocked profiles list.
1292 It stops on the first matching block, if any.
1296 sub check_user_for_problems {
1301 # Fill this in if we have a problem, otherwise just return it.
1304 # First, check the user's profile.
1305 if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
1306 $problem = NCIP::Problem->new(
1308 ProblemType => 'User Blocked',
1309 ProblemDetail => 'User blocked from inter-library loan',
1310 ProblemElement => 'NULL',
1311 ProblemValue => 'NULL'
1316 # Next, check if the patron has one of the indicated blocks.
1318 foreach my $block (@blocks) {
1319 if (grep {$_->standing_penalty->block_list() =~ /$block/} @{$user->standing_penalties()}) {
1320 $problem = NCIP::Problem->new(
1322 ProblemType => 'User Blocked',
1323 ProblemDetail => 'User blocked from ' .
1324 ($block eq 'HOLD') ? 'holds' : (($block eq 'RENEW') ? 'renewals' :
1325 (($block eq 'CIRC') ? 'checkout' : lc($block))),
1326 ProblemElement => 'NULL',
1327 ProblemValue => 'NULL'
1338 =head2 check_circ_details
1340 $problem = $ils->check_circ_details($circ, $copy, $user);
1342 Checks if we can checkin or renew a circulation. That is, the
1343 circulation is still open (i.e. the copy is still checked out), if we
1344 either own the copy or are the circulation location, and if the
1345 circulation is for the optional $user argument. $circ and $copy are
1346 required. $user is optional.
1348 Returns a problem if any of the above conditions fail. Returns undef
1349 if they pass and we can proceed with the checkin or renewal.
1351 If the failure occurred on the copy-related checks, then the
1352 ProblemElement field will be undefined and needs to be filled in with
1353 the item id field name. If the check for the copy being checked out to
1354 the provided user fails, then both ProblemElement and ProblemValue
1355 fields will be empty and need to be filled in by the caller.
1359 sub check_circ_details {
1360 my ($self, $circ, $copy, $user) = @_;
1362 # Shortcut for the next check.
1363 my $ou_id = $self->{session}->{work_ou}->id();
1365 if (!$circ || $circ->checkin_time() || ($circ->circ_lib() != $ou_id && $copy->circ_lib() != $ou_id)) {
1366 # Item isn't checked out.
1367 return NCIP::Problem->new(
1369 ProblemType => 'Item Not Checked Out',
1370 ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out.',
1371 ProblemValue => $copy->barcode()
1375 # Get data on the patron who has it checked out.
1376 my $circ_user = $self->retrieve_user_by_id($circ->usr());
1377 if ($user && $circ_user && $user->id() != $circ_user->id()) {
1378 # The ProblemElement and ProblemValue field need to be
1379 # filled in by the caller.
1380 return NCIP::Problem->new(
1382 ProblemType => 'Item Not Checked Out To This User',
1383 ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out to this user.',
1388 # If we get here, we're good to go.
1392 =head2 retrieve_copy_details_by_barcode
1394 $copy = $ils->retrieve_copy_details_by_barcode($copy_barcode);
1396 Look up and retrieve some copy details by the copy barcode. This
1397 method returns either a hashref with the copy details or undefined if
1398 no copy exists with that barcode or if some error occurs.
1400 The hashref has the fields copy, hold, transit, circ, volume, and mvr.
1402 This method differs from C<retrieve_user_by_barcode> in that a copy
1403 cannot be invalid if it exists and it is not always an error if no
1404 copy exists. In some cases, when handling AcceptItem, we might prefer
1405 there to be no copy.
1409 sub retrieve_copy_details_by_barcode {
1411 my $barcode = shift;
1413 my $copy = $U->simplereq(
1415 'open-ils.circ.copy_details.retrieve.barcode',
1416 $self->{session}->{authtoken},
1420 # If $copy is an event, return undefined.
1421 if ($copy && $U->event_code($copy)) {
1428 =head2 retrieve_org_unit_by_shortname
1430 $org_unit = $ils->retrieve_org_unit_by_shortname($shortname);
1432 Retrieves an org. unit from the database by shortname. Returns the
1433 org. unit as a Fieldmapper object or undefined.
1437 sub retrieve_org_unit_by_shortname {
1439 my $shortname = shift;
1441 my $aou = $U->simplereq(
1443 'open-ils.actor.org_unit.retrieve_by_shortname',
1450 =head2 retrieve_copy_location
1452 $location = $ils->retrieve_copy_location($location_id);
1454 Retrive a copy location based on id.
1458 sub retrieve_copy_location {
1462 my $location = $U->simplereq(
1464 'open-ils.pcrud.retrieve.acpl',
1465 $self->{session}->{authtoken},
1472 =head2 retrieve_biblio_record_entry
1474 $bre = $ils->retrieve_biblio_record_entry($bre_id);
1476 Given a biblio.record_entry.id, this method retrieves a bre object.
1480 sub retrieve_biblio_record_entry {
1484 my $bre = $U->simplereq(
1486 'open-ils.pcrud.retrieve.bre',
1487 $self->{session}->{authtoken},
1494 =head2 create_precat_copy
1497 barcode => '312340123456789',
1498 author => 'Public, John Q.',
1499 title => 'Magnum Opus',
1500 call_number => '005.82',
1501 publisher => 'Brick House',
1502 publication_date => '2014'
1505 $item = $ils->create_precat_copy($item_info);
1508 Create a "precat" copy to use for the incoming item using a hashref of
1509 item information. At a minimum, the barcode, author and title fields
1510 need to be filled in. The other fields are ignored if provided.
1512 This method is called by the AcceptItem handler if the C<use_precats>
1513 configuration option is turned on.
1517 sub create_precat_copy {
1519 my $item_info = shift;
1521 my $item = Fieldmapper::asset::copy->new();
1522 $item->barcode($item_info->{barcode});
1523 $item->call_number(OILS_PRECAT_CALL_NUMBER);
1524 $item->dummy_title($item_info->{title});
1525 $item->dummy_author($item_info->{author});
1526 $item->circ_lib($self->{session}->{work_ou}->id());
1527 $item->circulate('t');
1528 $item->holdable('t');
1529 $item->opac_visible('f');
1530 $item->deleted('f');
1531 $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
1532 $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
1535 $item->editor($self->{session}->{user}->id());
1536 $item->creator($self->{session}->{user}->id());
1539 # Actually create it:
1541 my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
1544 $xact = $ses->request(
1545 'open-ils.pcrud.transaction.begin',
1546 $self->{session}->{authtoken}
1548 $item = $ses->request(
1549 'open-ils.pcrud.create.acp',
1550 $self->{session}->{authtoken},
1553 $xact = $ses->request(
1554 'open-ils.pcrud.transaction.commit',
1555 $self->{session}->{authtoken}
1563 'open-ils.pcrud.transaction.rollback',
1564 $self->{session}->{authtoken}
1574 =head2 create_fuller_copy
1577 barcode => '31234003456789',
1578 author => 'Public, John Q.',
1579 title => 'Magnum Opus',
1580 call_number => '005.82',
1581 publisher => 'Brick House',
1582 publication_date => '2014'
1585 $item = $ils->create_fuller_copy($item_info);
1587 Creates a skeletal bibliographic record, call number, and copy for the
1588 incoming item using a hashref with item information in it. At a
1589 minimum, the barcode, author, title, and call_number fields must be
1592 This method is used by the AcceptItem handler if the C<use_precats>
1593 configuration option is NOT set.
1597 sub create_fuller_copy {
1599 my $item_info = shift;
1603 # We do everything in one transaction, because it should be atomic.
1604 my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
1608 $xact = $ses->request(
1609 'open-ils.pcrud.transaction.begin',
1610 $self->{session}->{authtoken}
1617 # The rest depends on there being a transaction.
1620 # Create the MARC record.
1621 my $record = MARC::Record->new();
1622 $record->encoding('UTF-8');
1623 $record->leader('00881nam a2200193 4500');
1624 my $datespec = strftime("%Y%m%d%H%M%S.0", localtime);
1626 push(@fields, MARC::Field->new('005', $datespec));
1627 push(@fields, MARC::Field->new('082', '0', '4', 'a' => $item_info->{call_number}));
1628 push(@fields, MARC::Field->new('245', '0', '0', 'a' => $item_info->{title}));
1629 # Publisher is a little trickier:
1630 if ($item_info->{publisher}) {
1631 my $pub = MARC::Field->new('260', ' ', ' ', 'a' => '[S.l.]', 'b' => $item_info->{publisher});
1632 $pub->add_subfields('c' => $item_info->{publication_date}) if ($item_info->{publication_date});
1633 push(@fields, $pub);
1635 # We have no idea if the author is personal corporate or something else, so we use a 720.
1636 push(@fields, MARC::Field->new('720', ' ', ' ', 'a' => $item_info->{author}, '4' => 'aut'));
1637 $record->append_fields(@fields);
1638 my $marc = clean_marc($record);
1640 # Create the bib object.
1641 my $bib = Fieldmapper::biblio::record_entry->new();
1642 $bib->creator($self->{session}->{user}->id());
1643 $bib->editor($self->{session}->{user}->id());
1644 $bib->source($self->{bib_source}->id());
1651 $bib = $ses->request(
1652 'open-ils.pcrud.create.bre',
1653 $self->{session}->{authtoken},
1661 'open-ils.pcrud.transaction.rollback',
1662 $self->{session}->{authtoken}
1667 # Create the call number
1670 $acn = Fieldmapper::asset::call_number->new();
1671 $acn->creator($self->{session}->{user}->id());
1672 $acn->editor($self->{session}->{user}->id());
1673 $acn->label($item_info->{call_number});
1674 $acn->record($bib->id());
1675 $acn->owning_lib($self->{session}->{work_ou}->id());
1680 $acn = $ses->request(
1681 'open-ils.pcrud.create.acn',
1682 $self->{session}->{authtoken},
1690 'open-ils.pcrud.transaction.rollback',
1691 $self->{session}->{authtoken}
1699 $item = Fieldmapper::asset::copy->new();
1700 $item->barcode($item_info->{barcode});
1701 $item->call_number($acn->id());
1702 $item->circ_lib($self->{session}->{work_ou}->id);
1703 $item->circulate('t');
1704 if ($self->{config}->{items}->{use_force_holds}) {
1705 $item->holdable('f');
1707 $item->holdable('t');
1709 $item->opac_visible('f');
1710 $item->deleted('f');
1711 $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
1712 $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
1715 $item->editor($self->{session}->{user}->id);
1716 $item->creator($self->{session}->{user}->id);
1720 $item = $ses->request(
1721 'open-ils.pcrud.create.acp',
1722 $self->{session}->{authtoken},
1726 # Cross our fingers and commit the work.
1727 $xact = $ses->request(
1728 'open-ils.pcrud.transaction.commit',
1729 $self->{session}->{authtoken}
1736 'open-ils.pcrud.transaction.rollback',
1737 $self->{session}->{authtoken}
1738 )->gather(1) if ($xact);
1744 # We need to disconnect our session.
1747 # Now, we handle our asset stat_cat entries.
1749 # It would be nice to do these in the above transaction, but
1750 # pcrud does not support the ascecm object, yet.
1751 foreach my $entry (@{$self->{stat_cat_entries}}) {
1752 my $map = Fieldmapper::asset::stat_cat_entry_copy_map->new();
1754 $map->stat_cat($entry->stat_cat());
1755 $map->stat_cat_entry($entry->id());
1756 $map->owning_copy($item->id());
1757 # We don't really worry if it succeeds or not.
1760 'open-ils.circ.stat_cat.asset.copy_map.create',
1761 $self->{session}->{authtoken},
1772 $hold = $ils->place_hold($item, $user, $location);
1774 This function places a hold on $item for $user for pickup at
1775 $location. If location is not provided or undefined, the user's home
1776 library is used as a fallback.
1778 $item can be a copy (asset::copy), volume (asset::call_number), or bib
1779 (biblio::record_entry). The appropriate hold type will be placed
1780 depending on the object.
1782 On success, the method returns the object representing the hold. On
1783 failure, a NCIP::Problem object, describing the failure, is returned.
1791 my $location = shift;
1793 # If $location is undefined, use the user's home_ou, which should
1794 # have been fleshed when the user was retrieved.
1795 $location = $user->home_ou() unless ($location);
1797 # $hold is the hold. $params is for the is_possible check.
1798 my ($hold, $params);
1800 # Prep the hold with fields common to all hold types:
1801 $hold = Fieldmapper::action::hold_request->new();
1802 $hold->isnew(1); # Just to make sure.
1803 $hold->target($item->id());
1804 $hold->usr($user->id());
1805 $hold->pickup_lib($location->id());
1806 if (!$user->email()) {
1807 $hold->email_notify('f');
1808 $hold->phone_notify($user->day_phone()) if ($user->day_phone());
1810 $hold->email_notify('t');
1814 $params = { pickup_lib => $location->id(), patronid => $user->id() };
1816 if (ref($item) eq 'Fieldmapper::asset::copy') {
1817 my $type = ($self->{config}->{items}->{use_force_holds}) ? 'F' : 'C';
1818 $hold->hold_type($type);
1819 $hold->current_copy($item->id());
1820 $params->{hold_type} = $type;
1821 $params->{copy_id} = $item->id();
1822 } elsif (ref($item) eq 'Fieldmapper::asset::call_number') {
1823 $hold->hold_type('V');
1824 $params->{hold_type} = 'V';
1825 $params->{volume_id} = $item->id();
1826 } elsif (ref($item) eq 'Fieldmapper::biblio::record_entry') {
1827 $hold->hold_type('T');
1828 $params->{hold_type} = 'T';
1829 $params->{titleid} = $item->id();
1832 # Check for a duplicate hold:
1833 my $duplicate = $U->simplereq(
1835 'open-ils.pcrud.search.ahr',
1836 $self->{session}->{authtoken},
1838 hold_type => $hold->hold_type(),
1839 target => $hold->target(),
1840 usr => $hold->usr(),
1841 expire_time => {'>' => 'now'},
1842 cancel_time => undef,
1843 fulfillment_time => undef
1847 return NCIP::Problem->new(
1849 ProblemType => 'Duplicate Request',
1850 ProblemDetail => 'A request for this item already exists for this patron.',
1851 ProblemElement => 'NULL',
1852 ProblemValue => 'NULL'
1857 # Check if the hold is possible:
1858 my $r = $U->simplereq(
1860 'open-ils.circ.title_hold.is_possible',
1861 $self->{session}->{authtoken},
1865 if ($r->{success}) {
1866 $hold = $U->simplereq(
1868 'open-ils.circ.holds.create.override',
1869 $self->{session}->{authtoken},
1872 if (ref($hold) eq 'HASH') {
1873 $hold = _problem_from_event('Request Not Possible', $hold);
1875 } elsif ($r->{last_event}) {
1876 $hold = _problem_from_event('Request Not Possible', $r->{last_event});
1877 } elsif ($r->{textcode}) {
1878 $hold = _problem_from_event('Request Not Possible', $r);
1880 $hold = _problem_from_event('Request Not Possible');
1888 $ils->delete_copy($copy);
1890 Deletes the copy, and if it is owned by our work_ou and not a precat,
1891 we also delete the volume and bib on which the copy depends.
1899 # Shortcut for ownership checks below.
1900 my $ou_id = $self->{session}->{work_ou}->id();
1902 # First, make sure the copy is not already deleted and we own it.
1903 return undef if ($U->is_true($copy->deleted()) || $copy->circ_lib() != $ou_id);
1905 # Indicate we want to delete the copy.
1906 $copy->isdeleted(1);
1908 # Delete the copy using a backend call that will delete the copy,
1909 # the call number, and bib when appropriate.
1910 my $result = $U->simplereq(
1912 'open-ils.cat.asset.copy.fleshed.batch.update.override',
1913 $self->{session}->{authtoken},
1917 # We are currently not checking for succes or failure of the
1918 # above. At some point, someone may want to.
1923 =head2 copy_can_circulate
1925 $can_circulate = $ils->copy_can_circulate($copy);
1927 Check if the copy's location and the copy itself allow
1928 circulation. Return true if they do, and false if they do not.
1932 sub copy_can_circulate {
1936 my $location = $copy->location();
1937 unless (ref($location)) {
1938 $location = $self->retrieve_copy_location($location);
1941 return ($U->is_true($copy->circulate()) && $U->is_true($location->circulate()));
1944 =head2 copy_can_fulfill
1946 $can_fulfill = $ils->copy_can_fulfill($copy);
1948 Check if the copy's location and the copy itself allow
1949 holds. Return true if they do, and false if they do not.
1953 sub copy_can_fulfill {
1957 my $location = $copy->location();
1958 unless (ref($location)) {
1959 $location = $self->retrieve_copy_location($location);
1962 return ($U->is_true($copy->holdable()) && $U->is_true($location->holdable()));
1965 =head1 OVERRIDDEN PARENT METHODS
1967 =head2 find_user_barcode
1969 We dangerously override our parent's C<find_user_barcode> to return
1970 either the $barcode or a Problem object. In list context the barcode
1971 or problem will be the first argument and the id field, if any, will
1972 be the second. We also add a second, optional, argument to indicate a
1973 default value for the id field in the event of a failure to find
1974 anything at all. (Perl lets us get away with this.)
1978 sub find_user_barcode {
1980 my $request = shift;
1981 my $default = shift;
1984 my $message = $self->parse_request_type($request);
1985 if ($message eq 'LookupUser') {
1986 $default = 'AuthenticationInputData';
1988 $default = 'UserIdentifierValue';
1992 my ($value, $idfield) = $self->SUPER::find_user_barcode($request);
1995 $idfield = $default unless ($idfield);
1996 $value = NCIP::Problem->new();
1997 $value->ProblemType('Needed Data Missing');
1998 $value->ProblemDetail('Cannot find user barcode in message.');
1999 $value->ProblemElement($idfield);
2000 $value->ProblemValue('NULL');
2003 return (wantarray) ? ($value, $idfield) : $value;
2006 =head2 find_item_barcode
2008 We do pretty much the same thing as with C<find_user_barcode> for
2009 C<find_item_barcode>.
2013 sub find_item_barcode {
2015 my $request = shift;
2016 my $default = shift || 'ItemIdentifierValue';
2018 my ($value, $idfield) = $self->SUPER::find_item_barcode($request);
2021 $idfield = $default unless ($idfield);
2022 $value = NCIP::Problem->new();
2023 $value->ProblemType('Needed Data Missing');
2024 $value->ProblemDetail('Cannot find item barcode in message.');
2025 $value->ProblemElement($idfield);
2026 $value->ProblemValue('NULL');
2029 return (wantarray) ? ($value, $idfield) : $value;
2032 # private subroutines not meant to be used directly by subclasses.
2033 # Most have to do with setup and/or state checking of implementation
2036 # Find, load, and parse our configuration file:
2040 # Find the configuration file via variables:
2041 my $file = OILS_NCIP_CONFIG_DEFAULT;
2042 $file = $ENV{OILS_NCIP_CONFIG} if ($ENV{OILS_NCIP_CONFIG});
2044 $self->{config} = XMLin($file, NormaliseSpace => 2,
2045 ForceArray => ['block_profile', 'stat_cat_entry']);
2048 # Bootstrap OpenSRF::System and load the IDL.
2052 my $bootstrap_config = $self->{config}->{bootstrap};
2053 OpenSRF::System->bootstrap_client(config_file => $bootstrap_config);
2055 my $idl = OpenSRF::Utils::SettingsClient->new->config_value("IDL");
2056 Fieldmapper->import(IDL => $idl);
2059 # Login and then initialize some object data based on the
2064 # Login to Evergreen.
2067 # Load the barred groups as pgt objects into a blocked_profiles
2069 $self->{blocked_profiles} = [];
2070 foreach (@{$self->{config}->{patrons}->{block_profile}}) {
2073 $pgt = $U->simplereq(
2075 'open-ils.pcrud.retrieve.pgt',
2076 $self->{session}->{authtoken},
2080 $pgt = $U->simplereq(
2082 'open-ils.pcrud.search.pgt',
2083 $self->{session}->{authtoken},
2087 push(@{$self->{blocked_profiles}}, $pgt) if ($pgt);
2090 # Load the bib source if we're not using precats.
2091 unless ($self->{config}->{items}->{use_precats}) {
2092 # Retrieve the default
2093 $self->{bib_source} = $U->simplereq(
2095 'open-ils.pcrud.retrieve.cbs',
2096 $self->{session}->{authtoken},
2097 BIB_SOURCE_DEFAULT);
2098 my $data = $self->{config}->{items}->{bib_source};
2100 $data = $data->[0] if (ref($data) eq 'ARRAY');
2103 $result = $U->simplereq(
2105 'open-ils.pcrud.retrieve.cbs',
2106 $self->{session}->{authtoken},
2110 $result = $U->simplereq(
2112 'open-ils.pcrud.search.cbs',
2113 $self->{session}->{authtoken},
2117 $self->{bib_source} = $result if ($result);
2121 # Load the required asset.stat_cat_entries:
2122 $self->{stat_cat_entries} = [];
2123 # First, make a regex for our ou and ancestors:
2124 my $ancestors = join("|", @{$U->get_org_ancestors($self->{session}->{work_ou}->id())});
2125 my $re = qr/(?:$ancestors)/;
2126 # Get the uniq stat_cat ids from the configuration:
2127 my @cats = uniq map {$_->{stat_cat}} @{$self->{config}->{items}->{stat_cat_entry}};
2128 # Retrieve all of the fleshed stat_cats and entries for the above.
2129 my $stat_cats = $U->simplereq(
2131 'open-ils.circ.stat_cat.asset.retrieve.batch',
2132 $self->{session}->{authtoken},
2135 foreach my $entry (@{$self->{config}->{items}->{stat_cat_entry}}) {
2136 # Must have the stat_cat attr and the name, so we must have a
2138 next unless(ref $entry);
2139 my ($stat) = grep {$_->id() == $entry->{stat_cat}} @$stat_cats;
2140 push(@{$self->{stat_cat_entries}}, grep {$_->owner() =~ $re && $_->value() eq $entry->{content}} @{$stat->entries()});
2144 # Standalone, "helper" functions. These do not take an object or
2147 # Check if a user is past their expiration date.
2152 # Users might not expire. If so, they have no expire_date.
2153 if ($user->expire_date()) {
2154 my $expires = DateTime::Format::ISO8601->parse_datetime(
2155 cleanse_ISO8601($user->expire_date())
2157 my $now = DateTime->now()->epoch();
2158 $expired = $now > $expires;
2164 # Creates a NCIP Problem from an event. Takes a string for the problem
2165 # type, the event hashref (or a string to use for the detail), and
2166 # optional arguments for the ProblemElement and ProblemValue fields.
2167 sub _problem_from_event {
2168 my ($type, $evt, $element, $value) = @_;
2174 my ($textcode, $desc);
2176 # Get the textcode, if available. We favor those defined in
2177 # ils_events.xml over those made up on the fly.
2178 if ($evt->{ilsevent} && $evt->{ilsevent}->{textcode}) {
2179 $textcode = $evt->{ilsevent}->{textcode};
2180 } elsif ($evt->{textcode}) {
2181 $textcode = $evt->{textcode};
2184 # Get the description. We favor translated descriptions over
2185 # the English in ils_events.xml.
2187 $desc = $evt->{desc};
2188 } elsif ($evt->{ilsevent} && $evt->{ilsevent}->{desc}) {
2189 $desc = $evt->{ilsevent}->{desc};
2192 # Check if $type was set. As an "undocumented" feature, you
2193 # can pass undef, and we'll use the textcode from the event.
2200 # Set the detail from some combination of the above.
2203 } elsif ($textcode eq 'PERM_FAILURE') {
2204 if ($evt->{ilsperm}) {
2205 $detail = "Permission denied: " . $evt->{ilsperm};
2206 $detail =~ s/\.override$//;
2208 } elsif ($textcode) {
2209 $detail = "ILS returned $textcode error.";
2211 $detail = 'Detail not available.';
2218 return NCIP::Problem->new(
2220 ProblemType => ($type) ? $type : 'Temporary Processing Failure',
2221 ProblemDetail => ($detail) ? $detail : 'Detail not available.',
2222 ProblemElement => ($element) ? $element : 'NULL',
2223 ProblemValue => ($value) ? $value : 'NULL'