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;
55 use NCIP::Item::OptionalFields;
56 use NCIP::Item::BibliographicDescription;
57 use NCIP::Item::BibliographicItemId;
58 use NCIP::Item::BibliographicRecordId;
59 use NCIP::Item::Description;
61 # Inherit from NCIP::ILS.
62 use parent qw(NCIP::ILS);
66 Evergreen - Evergreen driver for NCIPServer
70 my $ils = NCIP::ILS::Evergreen->new(name => $config->{NCIP.ils.value});
74 NCIP::ILS::Evergreen is the default driver for Evergreen and
75 NCIPServer. It was initially developed to work with Auto-Graphics'
76 SHAREit software using a subset of an unspecified ILL/DCB profile.
80 # Default values we define for things that might be missing in our
81 # runtime environment or configuration file that absolutely must have
84 # OILS_NCIP_CONFIG_DEFAULT is the default location to find our
85 # driver's configuration file. This location can be overridden by
86 # setting the path in the OILS_NCIP_CONFIG environment variable.
88 # BIB_SOURCE_DEFAULT is the config.bib_source.id to use when creating
89 # "short" bibs. It is used only if no entry is supplied in the
90 # configuration file. The provided default is 2, the id of the
91 # "System Local" source that comes with a default Evergreen
94 OILS_NCIP_CONFIG_DEFAULT => '/openils/conf/oils_ncip.xml',
95 BIB_SOURCE_DEFAULT => 2
98 # A common Evergreen code shortcut to use AppUtils:
99 my $U = 'OpenILS::Application::AppUtils';
101 # The usual constructor:
104 $class = ref($class) if (ref $class);
106 # Instantiate our parent with the rest of the arguments. It
107 # creates a blessed hashref.
108 my $self = $class->SUPER::new(@_);
110 # Look for our configuration file, load, and parse it:
113 # Bootstrap OpenSRF and prepare some OpenILS components.
116 # Initialize the rest of our internal state.
122 =head1 HANDLER METHODS
126 $ils->lookupuser($request);
128 Processes a LookupUser request.
136 # Check our session and login if necessary.
137 $self->login() unless ($self->checkauth());
139 my $message_type = $self->parse_request_type($request);
141 # Let's go ahead and create our response object. We need this even
142 # if there is a problem.
143 my $response = NCIP::Response->new({type => $message_type . "Response"});
144 $response->header($self->make_header($request));
146 # Need to parse the request object to get the user barcode.
147 my ($barcode, $idfield) = $self->find_user_barcode($request);
149 # If we did not find a barcode, then report the problem.
150 if (ref($barcode) eq 'NCIP::Problem') {
151 $response->problem($barcode);
155 # Look up our patron by barcode:
156 my $user = $self->retrieve_user_by_barcode($barcode, $idfield);
157 if (ref($user) eq 'NCIP::Problem') {
158 $response->problem($user);
162 # We got the information, so lets fill in our userdata.
163 my $userdata = NCIP::User->new();
165 # Make an array of the user's active barcodes.
167 foreach my $card (@{$user->cards()}) {
168 if ($U->is_true($card->active())) {
169 my $id = NCIP::User::Id->new({
170 UserIdentifierType => 'Barcode',
171 UserIdentifierValue => $card->barcode()
176 $userdata->UserId($ids);
178 # Check if they requested any optional fields and return those.
179 my $elements = $request->{$message_type}->{UserElementType};
181 $elements = [$elements] unless (ref $elements eq 'ARRAY');
182 my $optionalfields = $self->handle_user_elements($user, $elements);
183 $userdata->UserOptionalFields($optionalfields);
186 $response->data($userdata);
193 $ils->acceptitem($request);
195 Processes an AcceptItem request.
203 # Check our session and login if necessary.
204 $self->login() unless ($self->checkauth());
206 # Common preparation.
207 my $message = $self->parse_request_type($request);
208 my $response = NCIP::Response->new({type => $message . 'Response'});
209 $response->header($self->make_header($request));
211 # We only accept holds for the time being.
212 if ($request->{$message}->{RequestedActionType} =~ /^hold\W/i) {
213 # We need the item id or we can't do anything at all.
214 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
215 if (ref($item_barcode) eq 'NCIP::Problem') {
216 $response->problem($item_barcode);
220 # We need to find a patron barcode or we can't look anyone up
222 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request, 'UserIdentifierValue');
223 if (ref($user_barcode) eq 'NCIP::Problem') {
224 $response->problem($user_barcode);
227 # Look up our patron by barcode:
228 my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
229 if (ref($user) eq 'NCIP::Problem') {
230 $response->problem($user);
233 # We're doing patron checks before looking for bibliographic
234 # information and creating the item because problems with the
235 # patron are more likely to occur.
236 my $problem = $self->check_user_for_problems($user, 'HOLD');
238 $response->problem($problem);
242 # Check if the item barcode already exists:
243 my $item = $self->retrieve_copy_details_by_barcode($item_barcode);
245 # What to do here was not defined in the
246 # specification. Since the copies that we create this way
247 # should get deleted when checked in, it would be an error
248 # if we try to create another one. It means that something
249 # has gone wrong somewhere.
253 ProblemType => 'Duplicate Item',
254 ProblemDetail => "Item with barcode $item_barcode already exists.",
255 ProblemElement => $item_idfield,
256 ProblemValue => $item_barcode
263 # Now, we have to create our new copy and/or bib and call number.
265 # First, we have to gather the necessary information from the
266 # request. Store in a hashref for convenience. We may write a
267 # method to get this information in the future if we find we
268 # need it in other handlers. Such a function would be a
269 # candidate to go into our parent, NCIP::ILS.
271 barcode => $item_barcode,
272 call_number => $request->{$message}->{ItemOptionalFields}->{ItemDescription}->{CallNumber},
273 title => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{Author},
274 author => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{Title},
275 publisher => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{Publisher},
276 publication_date => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{PublicationDate},
277 medium => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{MediumType},
278 electronic => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{ElectronicResource}
281 if ($self->{config}->{items}->{use_precats}) {
282 # We only need to create a precat copy.
283 $item = $self->create_precat_copy($item_info);
285 # We have to create a "partial" bib record, a call number and a copy.
286 $item = $self->create_fuller_copy($item_info);
289 # If we failed to create the copy, report a problem.
293 ProblemType => 'Temporary Processing Failure',
294 ProblemDetail => 'Failed to create the item in the system',
295 ProblemElement => $item_idfield,
296 ProblemValue => $item_barcode
302 # We try to find the pickup location in our database. It's OK
303 # if it does not exist, the user's home library will be used
305 my $location = $request->{$message}->{PickupLocation};
307 $location = $self->retrieve_org_unit_by_shortname($location);
310 # Now, we place the hold on the newly created copy on behalf
311 # of the patron retrieved above.
312 my $hold = $self->place_hold($item, $user, $location);
313 if (ref($hold) eq 'NCIP::Problem') {
314 $response->problem($hold);
318 # We return the RequestId and optionally, the ItemID. We'll
319 # just return what was sent to us, since we ignored all of it
322 $data->{RequestId} = NCIP::RequestId->new(
324 AgencyId => $request->{$message}->{RequestId}->{AgencyId},
325 RequestIdentifierType => $request->{$message}->{RequestId}->{RequestIdentifierType},
326 RequestIdentifierValue => $request->{$message}->{RequestId}->{RequestIdentifierValue}
329 $data->{ItemId} = NCIP::Item::Id->new(
331 AgencyId => $request->{$message}->{ItemId}->{AgencyId},
332 ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
333 ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
336 $response->data($data);
339 my $problem = NCIP::Problem->new();
340 $problem->ProblemType('Unauthorized Combination Of Element Values For System');
341 $problem->ProblemDetail('We only support Hold For Pickup');
342 $problem->ProblemElement('RequestedActionType');
343 $problem->ProblemValue($request->{$message}->{RequestedActionType});
344 $response->problem($problem);
352 $response = $ils->checkinitem($request);
354 Checks the item in if we can find the barcode in the message. It
355 returns problems if it cannot find the item in the system or if the
356 item is not checked out.
358 It could definitely use some more brains at some point as it does not
359 fully support everything that the standard allows. It also does not
360 really check if the checkin succeeded or not.
368 # Check our session and login if necessary:
369 $self->login() unless ($self->checkauth());
372 my $message = $self->parse_request_type($request);
373 my $response = NCIP::Response->new({type => $message . 'Response'});
374 $response->header($self->make_header($request));
376 # We need the copy barcode from the message.
377 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
378 if (ref($item_barcode) eq 'NCIP::Problem') {
379 $response->problem($item_barcode);
383 # Retrieve the copy details.
384 my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
386 # Return an Unknown Item problem unless we find the copy.
390 ProblemType => 'Unknown Item',
391 ProblemDetail => "Item with barcode $item_barcode is not known.",
392 ProblemElement => $item_idfield,
393 ProblemValue => $item_barcode
400 # Check if a UserId was provided. If so, this is the patron to
401 # whom the copy should be checked out.
403 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
404 # We ignore the problem, because the UserId is optional.
405 if (ref($user_barcode) ne 'NCIP::Problem') {
406 $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
407 # We don't ignore a problem here, however.
408 if (ref($user) eq 'NCIP::Problem') {
409 $response->problem($user);
415 my $copy = $details->{copy};
417 # Look for a circulation and examine its information:
418 my $circ = $details->{circ};
420 # Check the circ details to see if the copy is checked out and, if
421 # the patron was provided, that it is checked out to the patron in
422 # question. We also verify the copy ownership and circulation
424 my $problem = $self->check_circ_details($circ, $copy, $user);
426 # We need to fill in some information, however.
427 if (!$problem->ProblemValue() && !$problem->ProblemElement()) {
428 $problem->ProblemValue($user_barcode);
429 $problem->ProblemElement($user_idfield);
430 } elsif (!$problem->ProblemElement()) {
431 $problem->ProblemElement($item_idfield);
433 $response->problem($problem);
437 # Checkin parameters. We want to skip hold targeting or making
438 # transits, to force the checkin despite the copy status, as
439 # well as void overdues.
441 copy_barcode => $copy->barcode(),
446 my $result = $U->simplereq(
448 'open-ils.circ.checkin.override',
449 $self->{session}->{authtoken},
452 if (ref($result) eq 'ARRAY') {
453 $result = $result->[0];
455 if ($result->{textcode} eq 'SUCCESS') {
456 # Delete the copy. Since delete_copy checks ownership
457 # before attempting to delete the copy, we don't bother
458 # checking who owns it.
459 $self->delete_copy($copy);
460 # We need the circulation user for the information below, so we retrieve it.
461 my $circ_user = $self->retrieve_user_by_id($circ->usr());
463 ItemId => NCIP::Item::Id->new(
465 AgencyId => $request->{$message}->{ItemId}->{AgencyId},
466 ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
467 ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
470 UserId => NCIP::User::Id->new(
472 UserIdentifierType => 'Barcode Id',
473 UserIdentifierValue => $circ_user->card->barcode()
478 # Look for UserElements requested and add it to the response:
479 my $elements = $request->{$message}->{UserElementType};
481 $elements = [$elements] unless (ref $elements eq 'ARRAY');
482 my $optionalfields = $self->handle_user_elements($circ_user, $elements);
483 $data->{UserOptionalFields} = $optionalfields;
485 $elements = $request->{$message}->{ItemElementType};
487 $elements = [$elements] unless (ref $elements eq 'ARRAY');
488 my $optionalfields = $self->handle_item_elements($copy, $elements);
489 $data->{ItemOptionalFields} = $optionalfields;
492 $response->data($data);
494 # At some point in the future, we should probably check if
495 # they requested optional user or item elements and return
496 # those. For the time being, we ignore those at the risk of
497 # being considered non-compliant.
499 $response->problem(_problem_from_event('Checkin Failed', $result));
507 $response = $ils->renewitem($request);
509 Handle the RenewItem message.
517 # Check our session and login if necessary:
518 $self->login() unless ($self->checkauth());
521 my $message = $self->parse_request_type($request);
522 my $response = NCIP::Response->new({type => $message . 'Response'});
523 $response->header($self->make_header($request));
525 # We need the copy barcode from the message.
526 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
527 if (ref($item_barcode) eq 'NCIP::Problem') {
528 $response->problem($item_barcode);
532 # Retrieve the copy details.
533 my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
535 # Return an Unknown Item problem unless we find the copy.
539 ProblemType => 'Unknown Item',
540 ProblemDetail => "Item with barcode $item_barcode is not known.",
541 ProblemElement => $item_idfield,
542 ProblemValue => $item_barcode
549 # User is required for RenewItem.
550 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
551 if (ref($user_barcode) eq 'NCIP::Problem') {
552 $response->problem($user_barcode);
555 my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
556 if (ref($user) eq 'NCIP::Problem') {
557 $response->problem($user);
562 my $copy = $details->{copy};
564 # Look for a circulation and examine its information:
565 my $circ = $details->{circ};
567 # Check the circ details to see if the copy is checked out and, if
568 # the patron was provided, that it is checked out to the patron in
569 # question. We also verify the copy ownership and circulation
571 my $problem = $self->check_circ_details($circ, $copy, $user);
573 # We need to fill in some information, however.
574 if (!$problem->ProblemValue() && !$problem->ProblemElement()) {
575 $problem->ProblemValue($user_barcode);
576 $problem->ProblemElement($user_idfield);
577 } elsif (!$problem->ProblemElement()) {
578 $problem->ProblemElement($item_idfield);
580 $response->problem($problem);
584 # Check if user is blocked from renewals:
585 $problem = $self->check_user_for_problems($user, 'RENEW');
587 # Replace the ProblemElement and ProblemValue fields.
588 $problem->ProblemElement($user_idfield);
589 $problem->ProblemValue($user_barcode);
590 $response->problem($problem);
594 # Check if the duration rule allows renewals. It should have been
595 # fleshed during the copy details retrieve.
596 my $rule = $circ->duration_rule();
597 unless (ref($rule)) {
598 $rule = $U->simplereq(
600 'open-ils.pcrud.retrieve.crcd',
601 $self->{session}->{authtoken},
605 if ($rule->max_renewals() < 1) {
609 ProblemType => 'Item Not Renewable',
610 ProblemDetail => 'Item may not be renewed.',
611 ProblemElement => $item_idfield,
612 ProblemValue => $item_barcode
619 # Check if there are renewals remaining on the latest circ:
620 if ($circ->renewal_remaining() < 1) {
624 ProblemType => 'Maximum Renewals Exceeded',
625 ProblemDetail => 'Renewal cannot proceed because the User has already renewed the Item the maximum number of times permitted.',
626 ProblemElement => $item_idfield,
627 ProblemValue => $item_barcode
634 # Now, we attempt the renewal. If it fails, we simply say that the
635 # user is not allowed to renew this item, without getting into
638 copy_id => $copy->id(),
639 patron_id => $user->id(),
642 my $r = $U->simplereq(
644 'open-ils.circ.renew.override',
645 $self->{session}->{authtoken},
649 # We only look at the first one, since more than one usually means
651 if (ref($r) eq 'ARRAY') {
654 if ($r->{textcode} ne 'SUCCESS') {
655 $problem = _problem_from_event('Renewal Failed', $r);
656 $response->problem($problem);
659 ItemId => NCIP::Item::Id->new(
661 AgencyId => $request->{$message}->{ItemId}->{AgencyId},
662 ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
663 ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
666 UserId => NCIP::User::Id->new(
668 UserIdentifierType => 'Barcode Id',
669 UserIdentifierValue => $user->card->barcode()
673 # We need to retrieve the copy details again to refresh our
674 # circ information to get the new due date.
675 $details = $self->retrieve_copy_details_by_barcode($item_barcode);
676 $circ = $details->{circ};
677 $data->{DateDue} = _fix_date($circ->due_date());
679 # Look for UserElements requested and add it to the response:
680 my $elements = $request->{$message}->{UserElementType};
682 $elements = [$elements] unless (ref $elements eq 'ARRAY');
683 my $optionalfields = $self->handle_user_elements($user, $elements);
684 $data->{UserOptionalFields} = $optionalfields;
686 $elements = $request->{$message}->{ItemElementType};
688 $elements = [$elements] unless (ref $elements eq 'ARRAY');
689 my $optionalfields = $self->handle_item_elements($details->{copy}, $elements);
690 $data->{ItemOptionalFields} = $optionalfields;
693 $response->data($data);
696 # At some point in the future, we should probably check if
697 # they requested optional user or item elements and return
698 # those. For the time being, we ignore those at the risk of
699 # being considered non-compliant.
706 $response = $ils->checkoutitem($request);
708 Handle the Checkoutitem message.
716 # Check our session and login if necessary:
717 $self->login() unless ($self->checkauth());
720 my $message = $self->parse_request_type($request);
721 my $response = NCIP::Response->new({type => $message . 'Response'});
722 $response->header($self->make_header($request));
724 # We need the copy barcode from the message.
725 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
726 if (ref($item_barcode) eq 'NCIP::Problem') {
727 $response->problem($item_barcode);
731 # Retrieve the copy details.
732 my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
734 # Return an Unknown Item problem unless we find the copy.
738 ProblemType => 'Unknown Item',
739 ProblemDetail => "Item with barcode $item_barcode is not known.",
740 ProblemElement => $item_idfield,
741 ProblemValue => $item_barcode
748 # User is required for CheckOutItem.
749 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
750 if (ref($user_barcode) eq 'NCIP::Problem') {
751 $response->problem($user_barcode);
754 my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
755 if (ref($user) eq 'NCIP::Problem') {
756 $response->problem($user);
761 my $copy = $details->{copy};
763 # Check if the copy can circulate.
764 unless ($self->copy_can_circulate($copy)) {
768 ProblemType => 'Item Does Not Circulate',
769 ProblemDetail => "Item with barcode $item_barcode does not circulate.",
770 ProblemElement => $item_idfield,
771 ProblemValue => $item_barcode
778 # Look for a circulation and examine its information:
779 my $circ = $details->{circ};
781 # Check if the item is already checked out.
782 if ($circ && !$circ->checkin_time()) {
786 ProblemType => 'Item Already Checked Out',
787 ProblemDetail => "Item with barcode $item_barcode is already checked out.",
788 ProblemElement => $item_idfield,
789 ProblemValue => $item_barcode
796 # Check if user is blocked from circulation:
797 my $problem = $self->check_user_for_problems($user, 'CIRC');
799 # Replace the ProblemElement and ProblemValue fields.
800 $problem->ProblemElement($user_idfield);
801 $problem->ProblemValue($user_barcode);
802 $response->problem($problem);
806 # Now, we attempt the check out. If it fails, we simply say that
807 # the user is not allowed to check out this item, without getting
810 copy_id => $copy->id(),
811 patron_id => $user->id(),
813 my $r = $U->simplereq(
815 'open-ils.circ.checkout.full.override',
816 $self->{session}->{authtoken},
820 # We only look at the first one, since more than one usually means
822 if (ref($r) eq 'ARRAY') {
825 if ($r->{textcode} ne 'SUCCESS') {
826 $problem = _problem_from_event('Check Out Failed', $r);
827 $response->problem($problem);
830 ItemId => NCIP::Item::Id->new(
832 AgencyId => $request->{$message}->{ItemId}->{AgencyId},
833 ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
834 ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
837 UserId => NCIP::User::Id->new(
839 UserIdentifierType => 'Barcode Id',
840 UserIdentifierValue => $user->card->barcode()
844 # We need to retrieve the copy details again to refresh our
845 # circ information to get the due date.
846 $details = $self->retrieve_copy_details_by_barcode($item_barcode);
847 $circ = $details->{circ};
848 $data->{DateDue} = _fix_date($circ->due_date());
850 # Look for UserElements requested and add it to the response:
851 my $elements = $request->{$message}->{UserElementType};
853 $elements = [$elements] unless (ref $elements eq 'ARRAY');
854 my $optionalfields = $self->handle_user_elements($user, $elements);
855 $data->{UserOptionalFields} = $optionalfields;
857 $elements = $request->{$message}->{ItemElementType};
859 $elements = [$elements] unless (ref $elements eq 'ARRAY');
860 my $optionalfields = $self->handle_item_elements($details->{copy}, $elements);
861 $data->{ItemOptionalFields} = $optionalfields;
864 $response->data($data);
867 # At some point in the future, we should probably check if
868 # they requested optional user or item elements and return
869 # those. For the time being, we ignore those at the risk of
870 # being considered non-compliant.
877 $response = $ils->requestitem($request);
879 Handle the NCIP RequestItem message.
886 # Check our session and login if necessary:
887 $self->login() unless ($self->checkauth());
890 my $message = $self->parse_request_type($request);
891 my $response = NCIP::Response->new({type => $message . 'Response'});
892 $response->header($self->make_header($request));
894 # Because we need to have a user to place a hold, because the user
895 # is likely to have problems, and because getting the item
896 # information for the hold is trickier than getting the user
897 # information, we'll do the user first and short circuit out of
898 # the function if there is a problem with the user.
899 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
900 if (ref($user_barcode) eq 'NCIP::Problem') {
901 $response->problem($user_barcode);
904 my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
905 if (ref($user) eq 'NCIP::Problem') {
906 $response->problem($user);
909 my $problem = $self->check_user_for_problems($user, 'HOLD');
911 $response->problem($problem);
915 # RequestItem is a blast. We need to check if we have a copy
916 # barcode and/or if we have BibliographicIds. If we have both or
917 # either, we then need to figure out what we're placing the hold
918 # on, a copy, a volume or a bib. We don't currently do part holds,
919 # but maybe we should some day. We can also be sent more than 1
920 # BibliographicId, so we look for certain identifiers first, and
921 # then others in decreasing preference: SYSNUMBER, ISBN, and ISSN.
923 # Not to mention that there are two kinds of BibliographicId field
924 # with different field names, and both can be intermixed in an
925 # incoming message! (I just /love/ this nonsense.)
927 # This here is the thing we're going to put on hold:
930 # We need copy details if we find in a couple of places below.
933 # We need the copy barcode from the message.
934 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
935 if (ref($item_barcode) ne 'NCIP::Problem') {
936 # Retrieve the copy details.
937 $copy_details = $self->retrieve_copy_details_by_barcode($item_barcode);
938 unless ($copy_details) {
939 # Return an Unknown Item problem unless we find the copy.
943 ProblemType => 'Unknown Item',
944 ProblemDetail => "Item with barcode $item_barcode is not known.",
945 ProblemElement => $item_idfield,
946 ProblemValue => $item_barcode
952 $item = $copy_details->{volume}; # We place a volume hold.
955 # We weren't given copy information to target, or we can't find
956 # it, so we need to look for a target via BibliographicId.
958 my @biblio_ids = $self->find_bibliographic_ids($request);
960 $item = $self->find_target_via_bibliographic_id(@biblio_ids);
964 # If we don't have an item, then blow up with a problem that may
965 # have been set when we went looking for the ItemId.
967 if (ref($item_barcode) eq 'NCIP::Problem') {
968 $response->problem($item_barcode);
973 ProblemType => 'Request Item Not Found',
974 ProblemDetail => 'Unable to determine the item to request from input message.',
975 ProblemElement => 'NULL',
976 ProblemValue => 'NULL'
982 } elsif (ref($item) eq 'NCIP::Problem') {
983 $response->problem($item);
987 # See if we were given a PickupLocation.
989 if ($request->{$message}->{PickupLocation}) {
990 my $loc = $request->{$message}->{PickupLocation};
991 $loc =~ s/^.*://; # strip everything up to the last
992 # semi-colon, if any.
993 $location = $self->retrieve_org_unit_by_shortname($loc);
996 # Look for a NeedBeforeDate to use as expiration...
997 my $hold_expiration = $request->{$message}->{NeedBeforeDate};
1000 my $hold = $self->place_hold($item, $user, $location, $hold_expiration);
1001 if (ref($hold) eq 'NCIP::Problem') {
1002 $response->problem($hold);
1005 RequestId => NCIP::RequestId->new(
1007 RequestIdentifierType => 'SYSNUMBER',
1008 RequestIdentifierValue => $hold->id()
1011 UserId => NCIP::User::Id->new(
1013 UserIdentifierType => 'Barcode Id',
1014 UserIdentifierValue => $user->card->barcode()
1017 RequestType => $request->{$message}->{RequestType},
1018 RequestScopeType => ($hold->hold_type() eq 'V') ? "item" : "bibliographic item"
1020 # Look for UserElements requested and add it to the response:
1021 my $elements = $request->{$message}->{UserElementType};
1023 $elements = [$elements] unless (ref $elements eq 'ARRAY');
1024 my $optionalfields = $self->handle_user_elements($user, $elements);
1025 $data->{UserOptionalFields} = $optionalfields;
1027 $elements = $request->{$message}->{ItemElementType};
1029 $copy_details = $self->find_copy_details_by_item($item) unless ($copy_details);
1030 $elements = [$elements] unless (ref($elements) eq 'ARRAY');
1031 my $optionalfields = $self->handle_item_elements($copy_details->{copy}, $elements);
1032 $data->{ItemOptionalFields} = $optionalfields;
1035 $response->data($data);
1041 =head2 cancelrequestitem
1043 $response = $ils->cancelrequestitem($request);
1045 Handle the NCIP CancelRequestItem message.
1049 sub cancelrequestitem {
1051 my $request = shift;
1052 # Check our session and login if necessary:
1053 $self->login() unless ($self->checkauth());
1056 my $message = $self->parse_request_type($request);
1057 my $response = NCIP::Response->new({type => $message . 'Response'});
1058 $response->header($self->make_header($request));
1060 # UserId is required by the standard, but we might not really need it.
1061 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
1062 if (ref($user_barcode) eq 'NCIP::Problem') {
1063 $response->problem($user_barcode);
1066 my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
1067 if (ref($user) eq 'NCIP::Problem') {
1068 $response->problem($user);
1072 # See if we got a ItemId and a barcode:
1074 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
1075 if (ref($item_barcode) ne 'NCIP::Problem') {
1076 # Retrieve the copy details.
1077 $copy_details = $self->retrieve_copy_details_by_barcode($item_barcode);
1078 unless ($copy_details) {
1079 # Return an Unknown Item problem unless we find the copy.
1083 ProblemType => 'Unknown Item',
1084 ProblemDetail => "Item with barcode $item_barcode is not known.",
1085 ProblemElement => $item_idfield,
1086 ProblemValue => $item_barcode
1094 # See if we got a RequestId:
1096 if ($request->{$message}->{RequestId}) {
1097 $requestid = NCIP::RequestId->new(
1099 AgencyId => $request->{$message}->{RequestId}->{AgencyId},
1100 RequestIdentifierType => $request->{$message}->{RequestId}->{RequestIdentifierType},
1101 RequestIdentifierValue => $request->{$message}->{RequestId}->{RequestIdentifierValue}
1106 # Just a note: In the below, we cannot rely on the hold or transit
1107 # fields of the copy_details, even if we have retrieved it. This
1108 # is because that hold and transit may not be the ones that we're
1109 # looking for, i.e. they could be for another patron, etc.
1111 # See if we can find the hold:
1114 $hold = $U->simplereq(
1116 'open-ils.pcrud.retrieve.ahr',
1117 $self->{session}->{authtoken},
1118 $requestid->{RequestIdentifierValue},
1119 {flesh => 1, flesh_fields => {ahr => ['transit']}}
1122 # Report a problem that we couldn't find a hold by that id.
1126 ProblemType => 'Unknown Request',
1127 ProblemDetail => 'No request with this identifier found',
1128 ProblemElement => 'RequestIdentifierValue',
1129 ProblemValue => $requestid->{RequestIdentifierValue}
1133 } elsif ($hold->cancel_time()) {
1137 ProblemType => 'Request Already Canceled',
1138 ProblemDetail => 'Request has already been canceled',
1139 ProblemElement => 'RequestIdentifierValue',
1140 ProblemValue => $requestid->{RequestIdentifierValue}
1144 } elsif ($hold->transit()) {
1148 ProblemType => 'Request Already Processed',
1149 ProblemDetail => 'Request has already been processed',
1150 ProblemElement => 'RequestIdentifierValue',
1151 ProblemValue => $requestid->{RequestIdentifierValue}
1155 } elsif ($hold->usr() == $user->id()) {
1156 # Check the target matches the copy information, if any,
1157 # that we were given.
1159 if ($copy_details) {
1160 if ($hold->hold_type() eq 'V') {
1161 $obj_id = $copy_details->{volume}->id();
1162 } elsif ($hold->hold_type() eq 'T') {
1163 $obj_id = $copy_details->{mvr}->doc_id();
1164 } elsif ($hold->hold_type() eq 'C' || $hold->hold_type() eq 'F') {
1165 $obj_id = $copy_details->{copy}->id();
1168 if ($obj_id && $hold->target() != $obj_id) {
1172 ProblemType => 'Request Not For This Item',
1173 ProblemDetail => "Request is not for this item",
1174 ProblemElement => $item_idfield,
1175 ProblemElement => $item_barcode
1180 $self->cancel_hold($hold);
1182 RequestId => $requestid,
1183 UserId => NCIP::User::Id->new(
1185 UserIdentifierType => 'Barcode Id',
1186 UserIdentifierValue => $user->card->barcode()
1190 # Look for UserElements requested and add it to the response:
1191 my $elements = $request->{$message}->{UserElementType};
1193 $elements = [$elements] unless (ref $elements eq 'ARRAY');
1194 my $optionalfields = $self->handle_user_elements($user, $elements);
1195 $data->{UserOptionalFields} = $optionalfields;
1197 $elements = $request->{$message}->{ItemElementType};
1198 if ($elements && $copy_details) {
1199 $elements = [$elements] unless (ref $elements eq 'ARRAY');
1200 my $optionalfields = $self->handle_item_elements($copy_details->{copy}, $elements);
1201 $data->{ItemOptionalFields} = $optionalfields;
1203 $response->data($data);
1206 # Report a problem that the hold is not for this user.
1210 ProblemType => 'Request Not For This User',
1211 ProblemDetail => 'Request is not for this user.',
1212 ProblemElement => $user_idfield,
1213 ProblemValue => $user_barcode
1219 # At this point, we *must have* an ItemId and therefore
1220 # $copy_details, so return the problem from looking up the
1221 # barcode if we don't have $copy_details.
1222 if (!$copy_details) {
1223 $response->problem($item_barcode);
1225 # We have to search for the hold based on the copy details and
1226 # the user. We'll need to search for copy (or force) holds, a
1227 # volume hold, or a title hold.
1228 $hold = $self->_hold_search($user, $copy_details);
1229 if ($hold && $hold->transit()) {
1233 ProblemType => 'Request Already Processed',
1234 ProblemDetail => 'Request has already been processed',
1235 ProblemElement => 'RequestIdentifierValue',
1236 ProblemValue => $requestid->{RequestIdentifierValue}
1241 $self->cancel_hold($hold);
1243 RequestId => NCIP::RequestId->new(
1245 RequestIdentifierType => 'SYSNUMBER',
1246 RequestIdentifierValue => $hold->id()
1249 UserId => NCIP::User::Id->new(
1251 UserIdentifierType => 'Barcode Id',
1252 UserIdentifierValue => $user->card->barcode()
1256 # Look for UserElements requested and add it to the response:
1257 my $elements = $request->{$message}->{UserElementType};
1259 $elements = [$elements] unless (ref $elements eq 'ARRAY');
1260 my $optionalfields = $self->handle_user_elements($user, $elements);
1261 $data->{UserOptionalFields} = $optionalfields;
1263 $elements = $request->{$message}->{ItemElementType};
1264 if ($elements && $copy_details) {
1265 $elements = [$elements] unless (ref $elements eq 'ARRAY');
1266 my $optionalfields = $self->handle_item_elements($copy_details->{copy}, $elements);
1267 $data->{ItemOptionalFields} = $optionalfields;
1269 $response->data($data);
1274 ProblemType => 'Unknown Request',
1275 ProblemDetail => 'No request found for the item and user',
1276 ProblemElement => 'NULL',
1277 ProblemValue => 'NULL'
1288 =head1 METHODS USEFUL to SUBCLASSES
1290 =head2 handle_user_elements
1291 $useroptionalfield = $ils->handle_user_elements($user, $elements);
1293 Returns NCIP::User::OptionalFields for the given user and arrayref of
1298 sub handle_user_elements {
1301 my $elements = shift;
1302 my $optionalfields = NCIP::User::OptionalFields->new();
1304 # First, we'll look for name information.
1305 if (grep {$_ eq 'Name Information'} @$elements) {
1306 my $name = NCIP::StructuredPersonalUserName->new();
1307 $name->Surname($user->family_name());
1308 $name->GivenName($user->first_given_name());
1309 $name->Prefix($user->prefix());
1310 $name->Suffix($user->suffix());
1311 $optionalfields->NameInformation($name);
1314 # Next, check for user address information.
1315 if (grep {$_ eq 'User Address Information'} @$elements) {
1318 # See if the user has any valid, physcial addresses.
1319 foreach my $addr (@{$user->addresses()}) {
1320 next if ($U->is_true($addr->pending()));
1321 my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>$addr->address_type()});
1322 my $physical = NCIP::StructuredAddress->new();
1323 $physical->Line1($addr->street1());
1324 $physical->Line2($addr->street2());
1325 $physical->Locality($addr->city());
1326 $physical->Region($addr->state());
1327 $physical->PostalCode($addr->post_code());
1328 $physical->Country($addr->country());
1329 $address->PhysicalAddress($physical);
1330 push @$addresses, $address;
1333 # Right now, we're only sharing email address if the user
1334 # has it. We don't share phone numbers.
1335 if ($user->email()) {
1336 my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>'Email Address'});
1337 $address->ElectronicAddress(
1338 NCIP::ElectronicAddress->new({
1339 Type=>'Email Address',
1340 Data=>$user->email()
1343 push @$addresses, $address;
1346 $optionalfields->UserAddressInformation($addresses);
1349 # Check for User Privilege.
1350 if (grep {$_ eq 'User Privilege'} @$elements) {
1351 # Get the user's group:
1352 my $pgt = $U->simplereq(
1354 'open-ils.pcrud.retrieve.pgt',
1355 $self->{session}->{authtoken},
1359 my $privilege = NCIP::User::Privilege->new();
1360 $privilege->AgencyId($user->home_ou->shortname());
1361 $privilege->AgencyUserPrivilegeType($pgt->name());
1362 $privilege->ValidToDate(_fix_date($user->expire_date()));
1363 $privilege->ValidFromDate(_fix_date($user->create_date()));
1365 my $status = 'Active';
1366 if (_expired($user)) {
1367 $status = 'Expired';
1368 } elsif ($U->is_true($user->barred())) {
1370 } elsif (!$U->is_true($user->active())) {
1371 $status = 'Inactive';
1374 $privilege->UserPrivilegeStatus(
1375 NCIP::User::PrivilegeStatus->new({
1376 UserPrivilegeStatusType => $status
1381 $optionalfields->UserPrivilege([$privilege]);
1385 # Check for Block Or Trap.
1386 if (grep {$_ eq 'Block Or Trap'} @$elements) {
1389 # First, let's check if the profile is blocked from ILL.
1390 if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
1391 my $block = NCIP::User::BlockOrTrap->new();
1392 $block->AgencyId($user->home_ou->shortname());
1393 $block->BlockOrTrapType('Block Interlibrary Loan');
1394 push @$blocks, $block;
1397 # Next, we loop through the user's standing penalties
1398 # looking for blocks on CIRC, HOLD, and RENEW.
1399 my ($have_circ, $have_renew, $have_hold) = (0,0,0);
1400 foreach my $penalty (@{$user->standing_penalties()}) {
1401 next unless($penalty->standing_penalty->block_list());
1402 my @block_list = split(/\|/, $penalty->standing_penalty->block_list());
1403 my $ou = $U->simplereq(
1405 'open-ils.pcrud.retrieve.aou',
1406 $self->{session}->{authtoken},
1407 $penalty->org_unit()
1411 if (!$have_circ && grep {$_ eq 'CIRC'} @block_list) {
1412 my $bot = NCIP::User::BlockOrTrap->new();
1413 $bot->AgencyId($ou->shortname());
1414 $bot->BlockOrTrapType('Block Checkout');
1415 push @$blocks, $bot;
1420 if (!$have_hold && grep {$_ eq 'HOLD' || $_ eq 'FULFILL'} @block_list) {
1421 my $bot = NCIP::User::BlockOrTrap->new();
1422 $bot->AgencyId($ou->shortname());
1423 $bot->BlockOrTrapType('Block Holds');
1424 push @$blocks, $bot;
1429 if (!$have_renew && grep {$_ eq 'RENEW'} @block_list) {
1430 my $bot = NCIP::User::BlockOrTrap->new();
1431 $bot->AgencyId($ou->shortname());
1432 $bot->BlockOrTrapType('Block Renewals');
1433 push @$blocks, $bot;
1437 # Stop after we report one of each, even if more
1439 last if ($have_circ && $have_renew && $have_hold);
1442 $optionalfields->BlockOrTrap($blocks);
1445 return $optionalfields;
1448 =head2 handle_item_elements
1452 sub handle_item_elements {
1455 my $elements = shift;
1456 my $optionalfields = NCIP::Item::OptionalFields->new();
1458 my $details; # In case we need for more than one.
1460 if (grep {$_ eq 'Bibliographic Description'} @$elements) {
1462 # Check for a precat copy, 'cause it is simple.
1463 if ($copy->dummy_title()) {
1464 $description = NCIP::Item::BibliographicDescription->new();
1465 $description->Title($copy->dummy_title());
1466 $description->Author($copy->dummy_author());
1467 if ($copy->dummy_isbn()) {
1468 $description->BibliographicItemId(
1469 NCIP::Item::BibliographicItemId->new(
1471 BibliographicItemIdentifier => $copy->dummy_isbn(),
1472 BibliographicItemIdentifierCode => 'ISBN'
1478 $details = $self->retrieve_copy_details_by_barcode($copy->barcode()) unless($details);
1479 $description = NCIP::Item::BibliographicDescription->new();
1480 $description->Title($details->{mvr}->title());
1481 $description->Author($details->{mvr}->author());
1482 $description->BibliographicRecordId(
1483 NCIP::Item::BibliographicRecordId->new(
1485 BibliographicRecordIdentifier => $details->{mvr}->doc_id(),
1486 BibliographicRecordIdentifierCode => 'SYSNUMBER'
1490 if ($details->{mvr}->publisher()) {
1491 $description->Publisher($details->{mvr}->publisher());
1493 if ($details->{mvr}->pubdate()) {
1494 $description->PublicationDate($details->{mvr}->pubdate());
1496 if ($details->{mvr}->edition()) {
1497 $description->Edition($details->{mvr}->edition());
1500 $optionalfields->BibliographicDescription($description) if ($description);
1503 if (grep {$_ eq 'Item Description'} @$elements) {
1504 $details = $self->retrieve_copy_details_by_barcode($copy->barcode()) unless($details);
1505 # Call Number is the only field we currently return. We also
1506 # do not attempt to retun a prefix and suffix. Someone else
1507 # can deal with that if they want it.
1508 if ($details->{volume}) {
1509 $optionalfields->ItemDescription(
1510 NCIP::Item::Description->new(
1511 {CallNumber => $details->{volume}->label()}
1517 if (grep {$_ eq 'Circulation Status'} @$elements) {
1518 my $status = $copy->status();
1519 $status = $self->retrieve_copy_status($status) unless (ref($status));
1520 $optionalfields->CirculationStatus($status->name()) if ($status);
1523 if (grep {$_ eq 'Date Due'} @$elements) {
1524 $details = $self->retrieve_copy_details_by_barcode($copy->barcode()) unless($details);
1525 if ($details->{circ}) {
1526 if (!$details->{circ}->checkin_time()) {
1527 $optionalfields->DateDue(_fix_date($details->{circ}->due_date()));
1532 if (grep {$_ eq 'Item Use Restriction Type'} @$elements) {
1533 $optionalfields->ItemUseRestrictionType('None');
1536 if (grep {$_ eq 'Physical Condition'} @$elements) {
1537 $optionalfields->PhysicalCondition(
1538 NCIP::Item::PhysicalCondition->new(
1539 {PhysicalConditionType => 'Unknown'}
1544 return $optionalfields;
1551 Login to Evergreen via OpenSRF. It uses internal state from the
1552 configuration file to login.
1556 # Login via OpenSRF to Evergreen.
1560 # Get the authentication seed.
1561 my $seed = $U->simplereq(
1563 'open-ils.auth.authenticate.init',
1564 $self->{config}->{credentials}->{username}
1569 my $response = $U->simplereq(
1571 'open-ils.auth.authenticate.complete',
1573 username => $self->{config}->{credentials}->{username},
1574 password => md5_hex(
1575 $seed . md5_hex($self->{config}->{credentials}->{password})
1578 workstation => $self->{config}->{credentials}->{workstation}
1582 $self->{session}->{authtoken} = $response->{payload}->{authtoken};
1583 $self->{session}->{authtime} = $response->{payload}->{authtime};
1585 # Set/reset the work_ou and user data in case something changed.
1587 # Retrieve the work_ou as an object.
1588 $self->{session}->{work_ou} = $U->simplereq(
1590 'open-ils.pcrud.search.aou',
1591 $self->{session}->{authtoken},
1592 {shortname => $self->{config}->{credentials}->{work_ou}}
1595 # We need the user information in order to do some things.
1596 $self->{session}->{user} = $U->check_user_session($self->{session}->{authtoken});
1604 $valid = $ils->checkauth();
1606 Returns 1 if the object a 'valid' authtoken, 0 if not.
1613 # We use AppUtils to do the heavy lifting.
1614 if (defined($self->{session})) {
1615 if ($U->check_user_session($self->{session}->{authtoken})) {
1622 # If we reach here, we don't have a session, so we are definitely
1627 =head2 retrieve_user_by_barcode
1629 $user = $ils->retrieve_user_by_barcode($user_barcode, $user_idfield);
1631 Do a fleshed retrieve of a patron by barcode. Return the patron if
1632 found and valid. Return a NCIP::Problem of 'Unknown User' otherwise.
1634 The id field argument is used for the ProblemElement field in the
1635 NCIP::Problem object.
1637 An invalid patron is one where the barcode is not found in the
1638 database, the patron is deleted, or the barcode used to retrieve the
1639 patron is not active. The problem element is also returned if an error
1640 occurs during the retrieval.
1644 sub retrieve_user_by_barcode {
1645 my ($self, $barcode, $idfield) = @_;
1646 my $result = $U->simplereq(
1648 'open-ils.actor.user.fleshed.retrieve_by_barcode',
1649 $self->{session}->{authtoken},
1654 # Check for a failure, or a deleted, inactive, or expired user,
1655 # and if so, return empty userdata.
1656 if (!$result || $U->event_code($result) || $U->is_true($result->deleted())
1657 || !grep {$_->barcode() eq $barcode && $U->is_true($_->active())} @{$result->cards()}) {
1659 my $problem = NCIP::Problem->new();
1660 $problem->ProblemType('Unknown User');
1661 $problem->ProblemDetail("User with barcode $barcode unknown");
1662 $problem->ProblemElement($idfield);
1663 $problem->ProblemValue($barcode);
1670 =head2 retrieve_user_by_id
1672 $user = $ils->retrieve_user_by_id($id);
1674 Similar to C<retrieve_user_by_barcode> but takes the user's database
1675 id rather than barcode. This is useful when you have a circulation or
1676 hold and need to get information about the user's involved in the hold
1679 It returns a fleshed user on success or undef on failure.
1683 sub retrieve_user_by_id {
1684 my ($self, $id) = @_;
1686 # Do a fleshed retrieve of the patron, and flesh the fields that
1687 # we would normally use.
1688 my $result = $U->simplereq(
1690 'open-ils.actor.user.fleshed.retrieve',
1691 $self->{session}->{authtoken},
1693 [ 'card', 'cards', 'standing_penalties', 'addresses', 'home_ou' ]
1695 # Check for an error.
1696 undef($result) if ($result && $U->event_code($result));
1701 =head2 check_user_for_problems
1703 $problem = $ils>check_user_for_problems($user, 'HOLD, 'CIRC', 'RENEW');
1705 This function checks if a user has a blocked profile or any from a
1706 list of provided blocks. If it does, then a NCIP::Problem object is
1707 returned, otherwise an undefined value is returned.
1709 The list of blocks appears as additional arguments after the user. You
1710 can provide any value(s) that might appear in a standing penalty block
1711 lit in Evergreen. The example above checks for HOLD, CIRC, and
1712 RENEW. Any number of such values can be provided. If none are
1713 provided, the function only checks if the patron's profiles appears in
1714 the object's blocked profiles list.
1716 It stops on the first matching block, if any.
1720 sub check_user_for_problems {
1725 # Fill this in if we have a problem, otherwise just return it.
1728 # First, check the user's profile.
1729 if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
1730 $problem = NCIP::Problem->new(
1732 ProblemType => 'User Blocked',
1733 ProblemDetail => 'User blocked from inter-library loan',
1734 ProblemElement => 'NULL',
1735 ProblemValue => 'NULL'
1740 # Next, check if the patron has one of the indicated blocks.
1742 foreach my $penalty (@{$user->standing_penalties()}) {
1743 if ($penalty->standing_penalty->block_list()) {
1744 my @pblocks = split(/\|/, $penalty->standing_penalty->block_list());
1745 foreach my $block (@blocks) {
1746 if (grep {$_ =~ /$block/} @pblocks) {
1747 $problem = NCIP::Problem->new(
1749 ProblemType => 'User Blocked',
1750 ProblemDetail => 'User blocked from ' .
1751 ($block eq 'HOLD') ? 'holds' : (($block eq 'RENEW') ? 'renewals' :
1752 (($block eq 'CIRC') ? 'checkout' : lc($block))),
1753 ProblemElement => 'NULL',
1754 ProblemValue => 'NULL'
1768 =head2 check_circ_details
1770 $problem = $ils->check_circ_details($circ, $copy, $user);
1772 Checks if we can checkin or renew a circulation. That is, the
1773 circulation is still open (i.e. the copy is still checked out), if we
1774 either own the copy or are the circulation location, and if the
1775 circulation is for the optional $user argument. $circ and $copy are
1776 required. $user is optional.
1778 Returns a problem if any of the above conditions fail. Returns undef
1779 if they pass and we can proceed with the checkin or renewal.
1781 If the failure occurred on the copy-related checks, then the
1782 ProblemElement field will be undefined and needs to be filled in with
1783 the item id field name. If the check for the copy being checked out to
1784 the provided user fails, then both ProblemElement and ProblemValue
1785 fields will be empty and need to be filled in by the caller.
1789 sub check_circ_details {
1790 my ($self, $circ, $copy, $user) = @_;
1792 # Shortcut for the next check.
1793 my $ou_id = $self->{session}->{work_ou}->id();
1795 if (!$circ || $circ->checkin_time() || ($circ->circ_lib() != $ou_id && $copy->circ_lib() != $ou_id)) {
1796 # Item isn't checked out.
1797 return NCIP::Problem->new(
1799 ProblemType => 'Item Not Checked Out',
1800 ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out.',
1801 ProblemValue => $copy->barcode()
1805 # Get data on the patron who has it checked out.
1806 my $circ_user = $self->retrieve_user_by_id($circ->usr());
1807 if ($user && $circ_user && $user->id() != $circ_user->id()) {
1808 # The ProblemElement and ProblemValue field need to be
1809 # filled in by the caller.
1810 return NCIP::Problem->new(
1812 ProblemType => 'Item Not Checked Out To This User',
1813 ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out to this user.',
1818 # If we get here, we're good to go.
1822 =head2 retrieve_copy_details_by_barcode
1824 $copy = $ils->retrieve_copy_details_by_barcode($copy_barcode);
1826 Look up and retrieve some copy details by the copy barcode. This
1827 method returns either a hashref with the copy details or undefined if
1828 no copy exists with that barcode or if some error occurs.
1830 The hashref has the fields copy, hold, transit, circ, volume, and mvr.
1832 This method differs from C<retrieve_user_by_barcode> in that a copy
1833 cannot be invalid if it exists and it is not always an error if no
1834 copy exists. In some cases, when handling AcceptItem, we might prefer
1835 there to be no copy.
1839 sub retrieve_copy_details_by_barcode {
1841 my $barcode = shift;
1843 my $copy = $U->simplereq(
1845 'open-ils.circ.copy_details.retrieve.barcode',
1846 $self->{session}->{authtoken},
1850 # If $copy is an event, return undefined.
1851 if ($copy && $U->event_code($copy)) {
1858 =head2 find_copy_details_by_item
1860 $copy_details = $ils->find_copy_details_by_item($item);
1862 This routine returns a copy_details hashref (See:
1863 retrieve_copy_details_by_barcode) for a given item. It attempts to
1864 find the "first" copy for the given item. If item is a call number it
1865 looks for the first, not deleted copy. If item is a bib, it looks for
1866 the first not deleted copy on the first not deleted call number. If
1867 item is a copy, it simply returns the details for the copy.
1871 sub find_copy_details_by_item {
1877 if (ref($item) eq 'Fieldmapper::biblio::record_entry') {
1878 my $acns = $U->simplereq(
1880 'open-ils.pcrud.search.acn.atomic',
1881 $self->{session}->{authtoken},
1883 record => $item->id(),
1887 ($item) = sort {$a->id() <=> $b->id()} @{$acns};
1890 if (ref($item) eq 'Fieldmapper::asset::call_number') {
1891 my $copies = $U->simplereq(
1893 'open-ils.pcrud.search.acp.atomic',
1894 $self->{session}->{authtoken},
1896 call_number => $item->id(),
1900 ($item) = sort {$a->id() <=> $b->id()} @{$copies};
1903 if (ref($item) eq 'Fieldmapper::asset::copy') {
1904 $details = $self->retrieve_copy_details_by_barcode($item->barcode());
1910 =head2 retrieve_copy_status
1912 $status = $ils->retrieve_copy_status($id);
1914 Retrive a copy status object by database ID.
1918 sub retrieve_copy_status {
1922 my $status = $U->simplereq(
1924 'open-ils.pcrud.retrieve.ccs',
1925 $self->{session}->{authtoken},
1932 =head2 retrieve_org_unit_by_shortname
1934 $org_unit = $ils->retrieve_org_unit_by_shortname($shortname);
1936 Retrieves an org. unit from the database by shortname. Returns the
1937 org. unit as a Fieldmapper object or undefined.
1941 sub retrieve_org_unit_by_shortname {
1943 my $shortname = shift;
1945 my $aou = $U->simplereq(
1947 'open-ils.actor.org_unit.retrieve_by_shortname',
1954 =head2 retrieve_copy_location
1956 $location = $ils->retrieve_copy_location($location_id);
1958 Retrieve a copy location based on id.
1962 sub retrieve_copy_location {
1966 my $location = $U->simplereq(
1968 'open-ils.pcrud.retrieve.acpl',
1969 $self->{session}->{authtoken},
1976 =head2 retrieve_biblio_record_entry
1978 $bre = $ils->retrieve_biblio_record_entry($bre_id);
1980 Given a biblio.record_entry.id, this method retrieves a bre object.
1984 sub retrieve_biblio_record_entry {
1988 my $bre = $U->simplereq(
1990 'open-ils.pcrud.retrieve.bre',
1991 $self->{session}->{authtoken},
1998 =head2 create_precat_copy
2001 barcode => '312340123456789',
2002 author => 'Public, John Q.',
2003 title => 'Magnum Opus',
2004 call_number => '005.82',
2005 publisher => 'Brick House',
2006 publication_date => '2014'
2009 $item = $ils->create_precat_copy($item_info);
2012 Create a "precat" copy to use for the incoming item using a hashref of
2013 item information. At a minimum, the barcode, author and title fields
2014 need to be filled in. The other fields are ignored if provided.
2016 This method is called by the AcceptItem handler if the C<use_precats>
2017 configuration option is turned on.
2021 sub create_precat_copy {
2023 my $item_info = shift;
2025 my $item = Fieldmapper::asset::copy->new();
2026 $item->barcode($item_info->{barcode});
2027 $item->call_number(OILS_PRECAT_CALL_NUMBER);
2028 $item->dummy_title($item_info->{title});
2029 $item->dummy_author($item_info->{author});
2030 $item->circ_lib($self->{session}->{work_ou}->id());
2031 $item->circulate('t');
2032 $item->holdable('t');
2033 $item->opac_visible('f');
2034 $item->deleted('f');
2035 $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
2036 $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
2039 $item->editor($self->{session}->{user}->id());
2040 $item->creator($self->{session}->{user}->id());
2043 # Actually create it:
2045 my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
2048 $xact = $ses->request(
2049 'open-ils.pcrud.transaction.begin',
2050 $self->{session}->{authtoken}
2052 $item = $ses->request(
2053 'open-ils.pcrud.create.acp',
2054 $self->{session}->{authtoken},
2057 $xact = $ses->request(
2058 'open-ils.pcrud.transaction.commit',
2059 $self->{session}->{authtoken}
2067 'open-ils.pcrud.transaction.rollback',
2068 $self->{session}->{authtoken}
2078 =head2 create_fuller_copy
2081 barcode => '31234003456789',
2082 author => 'Public, John Q.',
2083 title => 'Magnum Opus',
2084 call_number => '005.82',
2085 publisher => 'Brick House',
2086 publication_date => '2014'
2089 $item = $ils->create_fuller_copy($item_info);
2091 Creates a skeletal bibliographic record, call number, and copy for the
2092 incoming item using a hashref with item information in it. At a
2093 minimum, the barcode, author, title, and call_number fields must be
2096 This method is used by the AcceptItem handler if the C<use_precats>
2097 configuration option is NOT set.
2101 sub create_fuller_copy {
2103 my $item_info = shift;
2107 # We do everything in one transaction, because it should be atomic.
2108 my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
2112 $xact = $ses->request(
2113 'open-ils.pcrud.transaction.begin',
2114 $self->{session}->{authtoken}
2121 # The rest depends on there being a transaction.
2124 # Create the MARC record.
2125 my $record = MARC::Record->new();
2126 $record->encoding('UTF-8');
2127 $record->leader('00881nam a2200193 4500');
2128 my $datespec = strftime("%Y%m%d%H%M%S.0", localtime);
2130 push(@fields, MARC::Field->new('005', $datespec));
2131 push(@fields, MARC::Field->new('082', '0', '4', 'a' => $item_info->{call_number}));
2132 push(@fields, MARC::Field->new('245', '0', '0', 'a' => $item_info->{title}));
2133 # Publisher is a little trickier:
2134 if ($item_info->{publisher}) {
2135 my $pub = MARC::Field->new('260', ' ', ' ', 'a' => '[S.l.]', 'b' => $item_info->{publisher});
2136 $pub->add_subfields('c' => $item_info->{publication_date}) if ($item_info->{publication_date});
2137 push(@fields, $pub);
2139 # We have no idea if the author is personal corporate or something else, so we use a 720.
2140 push(@fields, MARC::Field->new('720', ' ', ' ', 'a' => $item_info->{author}, '4' => 'aut'));
2141 $record->append_fields(@fields);
2142 my $marc = clean_marc($record);
2144 # Create the bib object.
2145 my $bib = Fieldmapper::biblio::record_entry->new();
2146 $bib->creator($self->{session}->{user}->id());
2147 $bib->editor($self->{session}->{user}->id());
2148 $bib->source($self->{bib_source}->id());
2155 $bib = $ses->request(
2156 'open-ils.pcrud.create.bre',
2157 $self->{session}->{authtoken},
2165 'open-ils.pcrud.transaction.rollback',
2166 $self->{session}->{authtoken}
2171 # Create the call number
2174 $acn = Fieldmapper::asset::call_number->new();
2175 $acn->creator($self->{session}->{user}->id());
2176 $acn->editor($self->{session}->{user}->id());
2177 $acn->label($item_info->{call_number});
2178 $acn->record($bib->id());
2179 $acn->owning_lib($self->{session}->{work_ou}->id());
2184 $acn = $ses->request(
2185 'open-ils.pcrud.create.acn',
2186 $self->{session}->{authtoken},
2194 'open-ils.pcrud.transaction.rollback',
2195 $self->{session}->{authtoken}
2203 $item = Fieldmapper::asset::copy->new();
2204 $item->barcode($item_info->{barcode});
2205 $item->call_number($acn->id());
2206 $item->circ_lib($self->{session}->{work_ou}->id);
2207 $item->circulate('t');
2208 if ($self->{config}->{items}->{use_force_holds}) {
2209 $item->holdable('f');
2211 $item->holdable('t');
2213 $item->opac_visible('f');
2214 $item->deleted('f');
2215 $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
2216 $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
2219 $item->editor($self->{session}->{user}->id);
2220 $item->creator($self->{session}->{user}->id);
2224 $item = $ses->request(
2225 'open-ils.pcrud.create.acp',
2226 $self->{session}->{authtoken},
2230 # Cross our fingers and commit the work.
2231 $xact = $ses->request(
2232 'open-ils.pcrud.transaction.commit',
2233 $self->{session}->{authtoken}
2240 'open-ils.pcrud.transaction.rollback',
2241 $self->{session}->{authtoken}
2242 )->gather(1) if ($xact);
2248 # We need to disconnect our session.
2251 # Now, we handle our asset stat_cat entries.
2253 # It would be nice to do these in the above transaction, but
2254 # pcrud does not support the ascecm object, yet.
2255 foreach my $entry (@{$self->{stat_cat_entries}}) {
2256 my $map = Fieldmapper::asset::stat_cat_entry_copy_map->new();
2258 $map->stat_cat($entry->stat_cat());
2259 $map->stat_cat_entry($entry->id());
2260 $map->owning_copy($item->id());
2261 # We don't really worry if it succeeds or not.
2264 'open-ils.circ.stat_cat.asset.copy_map.create',
2265 $self->{session}->{authtoken},
2276 $hold = $ils->place_hold($item, $user, $location, $expiration);
2278 This function places a hold on $item for $user for pickup at
2279 $location. If location is not provided or undefined, the user's home
2280 library is used as a fallback.
2282 The $expiration argument is optional and must be a properly formatted
2283 ISO date time. It will be used as the hold expire time, if
2284 provided. Otherwise the system default time will be used.
2286 $item can be a copy (asset::copy), volume (asset::call_number), or bib
2287 (biblio::record_entry). The appropriate hold type will be placed
2288 depending on the object.
2290 On success, the method returns the object representing the hold. On
2291 failure, a NCIP::Problem object, describing the failure, is returned.
2299 my $location = shift;
2300 my $expiration = shift;
2302 # If $location is undefined, use the user's home_ou, which should
2303 # have been fleshed when the user was retrieved.
2304 $location = $user->home_ou() unless ($location);
2306 # $hold is the hold. $params is for the is_possible check.
2307 my ($hold, $params);
2309 # Prep the hold with fields common to all hold types:
2310 $hold = Fieldmapper::action::hold_request->new();
2311 $hold->isnew(1); # Just to make sure.
2312 $hold->target($item->id());
2313 $hold->usr($user->id());
2314 $hold->pickup_lib($location->id());
2315 $hold->expire_time(cleanse_ISO8601($expiration)) if ($expiration);
2316 if (!$user->email()) {
2317 $hold->email_notify('f');
2318 $hold->phone_notify($user->day_phone()) if ($user->day_phone());
2320 $hold->email_notify('t');
2324 $params = { pickup_lib => $location->id(), patronid => $user->id() };
2326 if (ref($item) eq 'Fieldmapper::asset::copy') {
2327 my $type = ($self->{config}->{items}->{use_force_holds}) ? 'F' : 'C';
2328 $hold->hold_type($type);
2329 $hold->current_copy($item->id());
2330 $params->{hold_type} = $type;
2331 $params->{copy_id} = $item->id();
2332 } elsif (ref($item) eq 'Fieldmapper::asset::call_number') {
2333 $hold->hold_type('V');
2334 $params->{hold_type} = 'V';
2335 $params->{volume_id} = $item->id();
2336 } elsif (ref($item) eq 'Fieldmapper::biblio::record_entry') {
2337 $hold->hold_type('T');
2338 $params->{hold_type} = 'T';
2339 $params->{titleid} = $item->id();
2342 # Check for a duplicate hold:
2343 my $duplicate = $U->simplereq(
2345 'open-ils.pcrud.search.ahr',
2346 $self->{session}->{authtoken},
2348 hold_type => $hold->hold_type(),
2349 target => $hold->target(),
2350 usr => $hold->usr(),
2351 expire_time => {'>' => 'now'},
2352 cancel_time => undef,
2353 fulfillment_time => undef
2357 return NCIP::Problem->new(
2359 ProblemType => 'Duplicate Request',
2360 ProblemDetail => 'A request for this item already exists for this patron.',
2361 ProblemElement => 'NULL',
2362 ProblemValue => 'NULL'
2367 # Check if the hold is possible:
2368 my $r = $U->simplereq(
2370 'open-ils.circ.title_hold.is_possible',
2371 $self->{session}->{authtoken},
2375 if ($r->{success}) {
2376 $hold = $U->simplereq(
2378 'open-ils.circ.holds.create.override',
2379 $self->{session}->{authtoken},
2383 $hold = $hold->[0] if (ref($hold) eq 'ARRAY');
2384 $hold = _problem_from_event('Request Not Possible', $hold);
2386 # open-ils.circ.holds.create.override returns the id on
2387 # success, so we retrieve the full hold object from the
2388 # database to return it.
2389 $hold = $U->simplereq(
2391 'open-ils.pcrud.retrieve.ahr',
2392 $self->{session}->{authtoken},
2396 } elsif ($r->{last_event}) {
2397 $hold = _problem_from_event('Request Not Possible', $r->{last_event});
2398 } elsif ($r->{textcode}) {
2399 $hold = _problem_from_event('Request Not Possible', $r);
2401 $hold = _problem_from_event('Request Not Possible');
2409 $ils->cancel_hold($hold);
2411 This method cancels the hold argument. It makes no checks on the hold,
2412 so if there are certain conditions that need to be fulfilled before
2413 the hold is canceled, then you must check them before calling this
2416 It returns undef on success or failure. If it fails, you've usually
2417 got bigger problems.
2425 my $r = $U->simplereq(
2427 'open-ils.circ.hold.cancel',
2428 $self->{session}->{authtoken},
2431 'Canceled via NCIPServer'
2439 $ils->delete_copy($copy);
2441 Deletes the copy, and if it is owned by our work_ou and not a precat,
2442 we also delete the volume and bib on which the copy depends.
2450 # Shortcut for ownership checks below.
2451 my $ou_id = $self->{session}->{work_ou}->id();
2453 # First, make sure the copy is not already deleted and we own it.
2454 return undef if ($U->is_true($copy->deleted()) || $copy->circ_lib() != $ou_id);
2456 # Indicate we want to delete the copy.
2457 $copy->isdeleted(1);
2459 # Delete the copy using a backend call that will delete the copy,
2460 # the call number, and bib when appropriate.
2461 my $result = $U->simplereq(
2463 'open-ils.cat.asset.copy.fleshed.batch.update.override',
2464 $self->{session}->{authtoken},
2468 # We are currently not checking for succes or failure of the
2469 # above. At some point, someone may want to.
2474 =head2 copy_can_circulate
2476 $can_circulate = $ils->copy_can_circulate($copy);
2478 Check if the copy's location and the copy itself allow
2479 circulation. Return true if they do, and false if they do not.
2483 sub copy_can_circulate {
2487 my $location = $copy->location();
2488 unless (ref($location)) {
2489 $location = $self->retrieve_copy_location($location);
2492 return ($U->is_true($copy->circulate()) && $U->is_true($location->circulate()));
2495 =head2 copy_can_fulfill
2497 $can_fulfill = $ils->copy_can_fulfill($copy);
2499 Check if the copy's location and the copy itself allow
2500 holds. Return true if they do, and false if they do not.
2504 sub copy_can_fulfill {
2508 my $location = $copy->location();
2509 unless (ref($location)) {
2510 $location = $self->retrieve_copy_location($location);
2513 return ($U->is_true($copy->holdable()) && $U->is_true($location->holdable()));
2516 =head1 OVERRIDDEN PARENT METHODS
2518 =head2 find_user_barcode
2520 We dangerously override our parent's C<find_user_barcode> to return
2521 either the $barcode or a Problem object. In list context the barcode
2522 or problem will be the first argument and the id field, if any, will
2523 be the second. We also add a second, optional, argument to indicate a
2524 default value for the id field in the event of a failure to find
2525 anything at all. (Perl lets us get away with this.)
2529 sub find_user_barcode {
2531 my $request = shift;
2532 my $default = shift;
2535 my $message = $self->parse_request_type($request);
2536 if ($message eq 'LookupUser') {
2537 $default = 'AuthenticationInputData';
2539 $default = 'UserIdentifierValue';
2543 my ($value, $idfield) = $self->SUPER::find_user_barcode($request);
2546 $idfield = $default unless ($idfield);
2547 $value = NCIP::Problem->new();
2548 $value->ProblemType('Needed Data Missing');
2549 $value->ProblemDetail('Cannot find user barcode in message.');
2550 $value->ProblemElement($idfield);
2551 $value->ProblemValue('NULL');
2554 return (wantarray) ? ($value, $idfield) : $value;
2557 =head2 find_item_barcode
2559 We do pretty much the same thing as with C<find_user_barcode> for
2560 C<find_item_barcode>.
2564 sub find_item_barcode {
2566 my $request = shift;
2567 my $default = shift || 'ItemIdentifierValue';
2569 my ($value, $idfield) = $self->SUPER::find_item_barcode($request);
2572 $idfield = $default unless ($idfield);
2573 $value = NCIP::Problem->new();
2574 $value->ProblemType('Needed Data Missing');
2575 $value->ProblemDetail('Cannot find item barcode in message.');
2576 $value->ProblemElement($idfield);
2577 $value->ProblemValue('NULL');
2580 return (wantarray) ? ($value, $idfield) : $value;
2583 =head2 find_target_via_bibliographic_id
2585 $item = $ils->find_target_via_bibliographic_id(@biblio_ids);
2587 Searches for a bibliographic record to put on hold and returns an
2588 appropriate hold target item depending upon what it finds. If an
2589 appropriate, single target cannot be found, it returns an
2590 NCIP::Problem with the problem message.
2592 Currently, we only look for SYSNUMBER, ISBN, and ISSN record
2593 identifiers. If nothing is found, this method can return undef. (Gotta
2594 love Perl and untyped/weakly typed languages in general!)
2596 TODO: Figure out how to search OCLC numbers. We probably need to use
2597 "MARC Expert Search" if we don't want to do a JSON query on
2602 sub find_target_via_bibliographic_id {
2604 my @biblio_ids = @_;
2606 # The item that we find:
2609 # Id for our bib in Evergreen:
2612 # First, let's look for a SYSNUMBER:
2614 { ($_->{BibliographicRecordIdentifierCode} && $_->{BibliographicRecordIdentifierCode} eq 'SYSNUMBER')
2615 || ($_->{BibliographicItemIdentifierCode} && $_->{BibliographicItemIdentifierCode} eq 'SYSNUMBER')
2620 # BibliographicRecordId can have an AgencyId field if the
2621 # BibliographicRecordIdentifierCode is absent.
2622 if ($idobj->{AgencyId}) {
2623 $bibid = $idobj->{BibliographicRecordIdentifier};
2624 my $locname = $idobj->{AgencyId};
2626 $locname =~ s/.*://;
2627 $loc = $self->retrieve_org_unit_by_shortname($locname);
2629 } elsif ($idobj->{BibliographicRecordIdentifierCode}) {
2630 $bibid = $idobj->{BibliographicRecordIdentifierCode}
2632 $bibid = $idobj->{BibliographicItemIdentifierCode}
2634 if ($bibid && $loc) {
2635 $item = $self->_call_number_search($bibid, $loc);
2637 $item = $U->simplereq(
2639 'open-ils.pcrud.retrieve.bre',
2640 $self->{session}->{authtoken},
2644 # Check if item is deleted so we'll look for more
2646 undef($item) if ($item && $U->is_true($item->deleted()));
2649 # Build an array of id objects based on the other identifier fields.
2652 ($_->{BibliographicRecordIdentifierCode} && $_->{BibliographicRecordIdentifierCode} eq 'ISBN')
2653 || ($_->{BibliographicItemIdentifierCode} && $_->{BibliographicItemIdentifierCode} eq 'ISBN')
2654 || ($_->{BibliographicRecordIdentifierCode} && $_->{BibliographicRecordIdentifierCode} eq 'ISSN')
2655 || ($_->{BibliographicItemIdentifierCode} && $_->{BibliographicItemIdentifierCode} eq 'ISSN')
2659 my $stashed_problem;
2660 # Reuse $idobj from above.
2661 foreach $idobj (@idobjs) {
2662 my ($idvalue, $idtype, $idfield);
2663 if ($_->{BibliographicItemIdentifier}) {
2664 $idvalue = $_->{BibliographicItemIdentifier};
2665 $idtype = $_->{BibliographicItemIdentifierCode};
2666 $idfield = 'BibliographicItemIdentifier';
2668 $idvalue = $_->{BibliographicRecordIdentifier};
2669 $idtype = $_->{BibliographicRecordIdentifierCode};
2670 $idfield = 'BibliographicRecordIdentifier';
2672 $item = $self->_bib_search($idvalue, $idtype);
2673 if (ref($item) eq 'NCIP::Problem') {
2674 $stashed_problem = $item unless($stashed_problem);
2675 $stashed_problem->ProblemElement($idfield);
2680 $item = $stashed_problem if (!$item && $stashed_problem);
2686 # private subroutines not meant to be used directly by subclasses.
2687 # Most have to do with setup and/or state checking of implementation
2690 # Find, load, and parse our configuration file:
2694 # Find the configuration file via variables:
2695 my $file = OILS_NCIP_CONFIG_DEFAULT;
2696 $file = $ENV{OILS_NCIP_CONFIG} if ($ENV{OILS_NCIP_CONFIG});
2698 $self->{config} = XMLin($file, NormaliseSpace => 2,
2699 ForceArray => ['block_profile', 'stat_cat_entry']);
2702 # Bootstrap OpenSRF::System and load the IDL.
2706 my $bootstrap_config = $self->{config}->{bootstrap};
2707 OpenSRF::System->bootstrap_client(config_file => $bootstrap_config);
2709 my $idl = OpenSRF::Utils::SettingsClient->new->config_value("IDL");
2710 Fieldmapper->import(IDL => $idl);
2713 # Login and then initialize some object data based on the
2718 # Login to Evergreen.
2721 # Load the barred groups as pgt objects into a blocked_profiles
2723 $self->{blocked_profiles} = [];
2724 foreach (@{$self->{config}->{patrons}->{block_profile}}) {
2727 $pgt = $U->simplereq(
2729 'open-ils.pcrud.retrieve.pgt',
2730 $self->{session}->{authtoken},
2734 $pgt = $U->simplereq(
2736 'open-ils.pcrud.search.pgt',
2737 $self->{session}->{authtoken},
2741 push(@{$self->{blocked_profiles}}, $pgt) if ($pgt);
2744 # Load the bib source if we're not using precats.
2745 unless ($self->{config}->{items}->{use_precats}) {
2746 # Retrieve the default
2747 $self->{bib_source} = $U->simplereq(
2749 'open-ils.pcrud.retrieve.cbs',
2750 $self->{session}->{authtoken},
2751 BIB_SOURCE_DEFAULT);
2752 my $data = $self->{config}->{items}->{bib_source};
2754 $data = $data->[0] if (ref($data) eq 'ARRAY');
2757 $result = $U->simplereq(
2759 'open-ils.pcrud.retrieve.cbs',
2760 $self->{session}->{authtoken},
2764 $result = $U->simplereq(
2766 'open-ils.pcrud.search.cbs',
2767 $self->{session}->{authtoken},
2771 $self->{bib_source} = $result if ($result);
2775 # Load the required asset.stat_cat_entries:
2776 $self->{stat_cat_entries} = [];
2777 # First, make a regex for our ou and ancestors:
2778 my $ancestors = join("|", @{$U->get_org_ancestors($self->{session}->{work_ou}->id())});
2779 my $re = qr/(?:$ancestors)/;
2780 # Get the uniq stat_cat ids from the configuration:
2781 my @cats = uniq map {$_->{stat_cat}} @{$self->{config}->{items}->{stat_cat_entry}};
2782 # Retrieve all of the fleshed stat_cats and entries for the above.
2783 my $stat_cats = $U->simplereq(
2785 'open-ils.circ.stat_cat.asset.retrieve.batch',
2786 $self->{session}->{authtoken},
2789 foreach my $entry (@{$self->{config}->{items}->{stat_cat_entry}}) {
2790 # Must have the stat_cat attr and the name, so we must have a
2792 next unless(ref $entry);
2793 my ($stat) = grep {$_->id() == $entry->{stat_cat}} @$stat_cats;
2794 push(@{$self->{stat_cat_entries}}, grep {$_->owner() =~ $re && $_->value() eq $entry->{content}} @{$stat->entries()});
2798 # Search asset.call_number by a bre.id and location object. Return the
2799 # "closest" call_number if found, undef otherwise.
2800 sub _call_number_search {
2803 my $location = shift;
2805 # At some point, this should be smarter, and we should retrieve
2806 # ancestors and descendants and search with a JSON query or some
2807 # such with results ordered by proximity to the original location,
2808 # but I don't have time to implement that right now.
2809 my $acn = $U->simplereq(
2811 'open-ils.pcrud.search.acn',
2812 $self->{session}->{authtoken},
2813 {record => $bibid, owning_lib => $location->id()}
2819 # Do a multiclass.query to search for items by isbn or issn.
2822 my $idvalue = shift;
2826 my $result = $U->simplereq(
2828 'open-ils.search.biblio.multiclass',
2829 {searches => {lc($idtype) => $idvalue}}
2832 if ($result && $result->{count}) {
2833 if ($result->{count} > 1) {
2834 $item = NCIP::Problem->new(
2836 ProblemType => 'Non-Unique Item',
2837 ProblemDetail => 'More than one item matches the request.',
2838 ProblemElement => '',
2839 ProblemValue => $idvalue
2843 my $bibid = $result->{ids}->[0]->[0];
2844 $item = $U->simplereq(
2846 'open-ils.pcrud.retrieve.bre',
2847 $self->{session}->{authtoken},
2855 # Search for holds using the user and copy_details information:
2859 my $copy_details = shift;
2863 # Retrieve all of the user's active holds, and then search them in Perl.
2864 my $holds_list = $U->simplereq(
2866 'open-ils.circ.holds.retrieve',
2867 $self->{session}->{authtoken},
2872 if ($holds_list && @$holds_list) {
2874 # Look for title holds (the most common), first:
2875 my $targetid = $copy_details->{mvr}->doc_id();
2876 @holds = grep {$_->hold_type eq 'T' && $_->target == $targetid} @{$holds_list};
2878 # Look for volume holds, the next most common:
2879 $targetid = $copy_details->{volume}->id();
2880 @holds = grep {$_->hold_type eq 'V' && $_->target == $targetid} @{$holds_list};
2883 # Look for copy and force holds, the least likely.
2884 $targetid = $copy_details->{copy}->id();
2885 @holds = grep {($_->hold_type eq 'C' || $_->hold_type eq 'F') && $_->target == $targetid} @{$holds_list};
2887 # There should only be 1, at this point, if there are any.
2896 # Standalone, "helper" functions. These do not take an object or
2899 # Check if a user is past their expiration date.
2904 # Users might not expire. If so, they have no expire_date.
2905 if ($user->expire_date()) {
2906 my $expires = DateTime::Format::ISO8601->parse_datetime(
2907 cleanse_ISO8601($user->expire_date())
2909 my $now = DateTime->now()->epoch();
2910 $expired = $now > $expires;
2916 # Creates a NCIP Problem from an event. Takes a string for the problem
2917 # type, the event hashref (or a string to use for the detail), and
2918 # optional arguments for the ProblemElement and ProblemValue fields.
2919 sub _problem_from_event {
2920 my ($type, $evt, $element, $value) = @_;
2926 my ($textcode, $desc);
2928 # Get the textcode, if available. Otherwise, use the ilsevent
2929 # "id," if available.
2930 if ($evt->{textcode}) {
2931 $textcode = $evt->{textcode};
2932 } elsif ($evt->{ilsevent}) {
2933 $textcode = $evt->{ilsevent};
2936 # Get the description. We favor translated descriptions over
2937 # the English in ils_events.xml.
2939 $desc = $evt->{desc};
2942 # Check if $type was set. As an "undocumented" feature, you
2943 # can pass undef, and we'll use the textcode from the event.
2950 # Set the detail from some combination of the above.
2953 } elsif ($textcode eq 'PERM_FAILURE') {
2954 if ($evt->{ilsperm}) {
2955 $detail = "Permission denied: " . $evt->{ilsperm};
2956 $detail =~ s/\.override$//;
2958 } elsif ($textcode) {
2959 $detail = "ILS returned $textcode error.";
2961 $detail = 'Detail not available.';
2968 return NCIP::Problem->new(
2970 ProblemType => ($type) ? $type : 'Temporary Processing Failure',
2971 ProblemDetail => ($detail) ? $detail : 'Detail not available.',
2972 ProblemElement => ($element) ? $element : 'NULL',
2973 ProblemValue => ($value) ? $value : 'NULL'
2978 # "Fix" dates for output so they validate against the schema
2981 my $out = DateTime::Format::ISO8601->parse_datetime(cleanse_ISO8601($date));
2982 $out->set_time_zone('UTC');
2983 return $out->iso8601();