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
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 my $due = DateTime::Format::ISO8601->parse_datetime(cleanse_ISO8601($circ->due_date()));
678 $due->set_time_zone('UTC');
679 $data->{DateDue} = $due->iso8601();
681 # Look for UserElements requested and add it to the response:
682 my $elements = $request->{$message}->{UserElementType};
684 $elements = [$elements] unless (ref $elements eq 'ARRAY');
685 my $optionalfields = $self->handle_user_elements($user, $elements);
686 $data->{UserOptionalFields} = $optionalfields;
688 $elements = $request->{$message}->{ItemElementType};
690 $elements = [$elements] unless (ref $elements eq 'ARRAY');
691 my $optionalfields = $self->handle_item_elements($details->{copy}, $elements);
692 $data->{ItemOptionalFields} = $optionalfields;
695 $response->data($data);
698 # At some point in the future, we should probably check if
699 # they requested optional user or item elements and return
700 # those. For the time being, we ignore those at the risk of
701 # being considered non-compliant.
708 $response = $ils->checkoutitem($request);
710 Handle the Checkoutitem message.
718 # Check our session and login if necessary:
719 $self->login() unless ($self->checkauth());
722 my $message = $self->parse_request_type($request);
723 my $response = NCIP::Response->new({type => $message . 'Response'});
724 $response->header($self->make_header($request));
726 # We need the copy barcode from the message.
727 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
728 if (ref($item_barcode) eq 'NCIP::Problem') {
729 $response->problem($item_barcode);
733 # Retrieve the copy details.
734 my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
736 # Return an Unknown Item problem unless we find the copy.
740 ProblemType => 'Unknown Item',
741 ProblemDetail => "Item with barcode $item_barcode is not known.",
742 ProblemElement => $item_idfield,
743 ProblemValue => $item_barcode
750 # User is required for CheckOutItem.
751 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
752 if (ref($user_barcode) eq 'NCIP::Problem') {
753 $response->problem($user_barcode);
756 my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
757 if (ref($user) eq 'NCIP::Problem') {
758 $response->problem($user);
763 my $copy = $details->{copy};
765 # Check if the copy can circulate.
766 unless ($self->copy_can_circulate($copy)) {
770 ProblemType => 'Item Does Not Circulate',
771 ProblemDetail => "Item with barcode $item_barcode does not circulate.",
772 ProblemElement => $item_idfield,
773 ProblemValue => $item_barcode
780 # Look for a circulation and examine its information:
781 my $circ = $details->{circ};
783 # Check if the item is already checked out.
784 if ($circ && !$circ->checkin_time()) {
788 ProblemType => 'Item Already Checked Out',
789 ProblemDetail => "Item with barcode $item_barcode is already checked out.",
790 ProblemElement => $item_idfield,
791 ProblemValue => $item_barcode
798 # Check if user is blocked from circulation:
799 my $problem = $self->check_user_for_problems($user, 'CIRC');
801 # Replace the ProblemElement and ProblemValue fields.
802 $problem->ProblemElement($user_idfield);
803 $problem->ProblemValue($user_barcode);
804 $response->problem($problem);
808 # Now, we attempt the check out. If it fails, we simply say that
809 # the user is not allowed to check out this item, without getting
813 patron_id => $user->id(),
815 my $r = $U->simplereq(
817 'open-ils.circ.checkout.full.override',
818 $self->{session}->{authtoken},
822 # We only look at the first one, since more than one usually means
824 if (ref($r) eq 'ARRAY') {
827 if ($r->{textcode} ne 'SUCCESS') {
828 $problem = _problem_from_event('Check Out Failed', $r);
829 $response->problem($problem);
832 ItemId => NCIP::Item::Id->new(
834 AgencyId => $request->{$message}->{ItemId}->{AgencyId},
835 ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
836 ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
839 UserId => NCIP::User::Id->new(
841 UserIdentifierType => 'Barcode Id',
842 UserIdentifierValue => $user->card->barcode()
846 # We need to retrieve the copy details again to refresh our
847 # circ information to get the due date.
848 $details = $self->retrieve_copy_details_by_barcode($item_barcode);
849 $circ = $details->{circ};
850 my $due = DateTime::Format::ISO8601->parse_datetime(cleanse_ISO8601($circ->due_date()));
851 $due->set_time_zone('UTC');
852 $data->{DateDue} = $due->iso8601();
854 # Look for UserElements requested and add it to the response:
855 my $elements = $request->{$message}->{UserElementType};
857 $elements = [$elements] unless (ref $elements eq 'ARRAY');
858 my $optionalfields = $self->handle_user_elements($user, $elements);
859 $data->{UserOptionalFields} = $optionalfields;
861 $elements = $request->{$message}->{ItemElementType};
863 $elements = [$elements] unless (ref $elements eq 'ARRAY');
864 my $optionalfields = $self->handle_item_elements($details->{copy}, $elements);
865 $data->{ItemOptionalFields} = $optionalfields;
868 $response->data($data);
871 # At some point in the future, we should probably check if
872 # they requested optional user or item elements and return
873 # those. For the time being, we ignore those at the risk of
874 # being considered non-compliant.
881 $response = $ils->requestitem($request);
883 Handle the NCIP RequestItem message.
890 # Check our session and login if necessary:
891 $self->login() unless ($self->checkauth());
894 my $message = $self->parse_request_type($request);
895 my $response = NCIP::Response->new({type => $message . 'Response'});
896 $response->header($self->make_header($request));
898 # Because we need to have a user to place a hold, because the user
899 # is likely to have problems, and because getting the item
900 # information for the hold is trickier than getting the user
901 # information, we'll do the user first and short circuit out of
902 # the function if there is a problem with the user.
903 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
904 if (ref($user_barcode) eq 'NCIP::Problem') {
905 $response->problem($user_barcode);
908 my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
909 if (ref($user) eq 'NCIP::Problem') {
910 $response->problem($user);
913 my $problem = $self->check_user_for_problems($user, 'HOLD');
915 $response->problem($problem);
919 # RequestItem is a blast. We need to check if we have a copy
920 # barcode and/or if we have BibliographicIds. If we have both or
921 # either, we then need to figure out what we're placing the hold
922 # on, a copy, a volume or a bib. We don't currently do part holds,
923 # but maybe we should some day. We can also be sent more than 1
924 # BibliographicId, so we look for certain identifiers first, and
925 # then others in decreasing preference: SYSNUMBER, ISBN, and ISSN.
927 # Not to mention that there are two kinds of BibliographicId field
928 # with different field names, and both can be intermixed in an
929 # incoming message! (I just /love/ this nonsense.)
931 # This here is the thing we're going to put on hold:
934 # We need copy details if we find in a couple of places below.
937 # We need the copy barcode from the message.
938 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
939 if (ref($item_barcode) ne 'NCIP::Problem') {
940 # Retrieve the copy details.
941 $copy_details = $self->retrieve_copy_details_by_barcode($item_barcode);
942 unless ($copy_details) {
943 # Return an Unknown Item problem unless we find the copy.
947 ProblemType => 'Unknown Item',
948 ProblemDetail => "Item with barcode $item_barcode is not known.",
949 ProblemElement => $item_idfield,
950 ProblemValue => $item_barcode
956 $item = $copy_details->{volume}; # We place a volume hold.
959 # We weren't given copy information to target, or we can't find
960 # it, so we need to look for a target via BibliographicId.
962 my @biblio_ids = $self->find_bibliographic_ids($request);
964 $item = $self->find_target_via_bibliographic_id(@biblio_ids);
968 # If we don't have an item, then blow up with a problem that may
969 # have been set when we went looking for the ItemId.
971 if (ref($item_barcode) eq 'NCIP::Problem') {
972 $response->problem($item_barcode);
977 ProblemType => 'Request Item Not Found',
978 ProblemDetail => 'Unable to determine the item to request from input message.',
979 ProblemElement => 'NULL',
980 ProblemValue => 'NULL'
986 } elsif (ref($item) eq 'NCIP::Problem') {
987 $response->problem($item);
991 # See if we were given a PickupLocation.
993 if ($request->{$message}->{PickupLocation}) {
994 my $loc = $request->{$message}->{PickupLocation};
995 $loc =~ s/^.*://; # strip everything up to the last
996 # semi-colon, if any.
997 $location = $self->retrieve_org_unit_by_shortname($loc);
1000 # Look for a NeedBeforeDate to use as expiration...
1001 my $hold_expiration = $request->{$message}->{NeedBeforeDate};
1004 my $hold = $self->place_hold($item, $user, $location, $hold_expiration);
1005 if (ref($hold) eq 'NCIP::Problem') {
1006 $response->problem($hold);
1009 RequestId => NCIP::RequestId->new(
1011 RequestIdentifierType => 'SYSNUMBER',
1012 RequestIdentifierValue => $hold->id()
1015 UserId => NCIP::User::Id->new(
1017 UserIdentifierType => 'Barcode Id',
1018 UserIdentifierValue => $user->card->barcode()
1021 RequestType => $request->{$message}->{RequestType},
1022 RequestScopeType => ($hold->hold_type() eq 'V') ? "item" : "bibliographic item"
1024 # Look for UserElements requested and add it to the response:
1025 my $elements = $request->{$message}->{UserElementType};
1027 $elements = [$elements] unless (ref $elements eq 'ARRAY');
1028 my $optionalfields = $self->handle_user_elements($user, $elements);
1029 $data->{UserOptionalFields} = $optionalfields;
1031 $elements = $request->{$message}->{ItemElementType};
1033 $copy_details = $self->find_copy_details_by_item($item) unless ($copy_details);
1034 $elements = [$elements] unless (ref($elements) eq 'ARRAY');
1035 my $optionalfields = $self->handle_item_elements($copy_details->{copy}, $elements);
1036 $data->{ItemOptionalFields} = $optionalfields;
1039 $response->data($data);
1045 =head2 cancelrequestitem
1047 $response = $ils->cancelrequestitem($request);
1049 Handle the NCIP CancelRequestItem message.
1053 sub cancelrequestitem {
1055 my $request = shift;
1056 # Check our session and login if necessary:
1057 $self->login() unless ($self->checkauth());
1060 my $message = $self->parse_request_type($request);
1061 my $response = NCIP::Response->new({type => $message . 'Response'});
1062 $response->header($self->make_header($request));
1064 # UserId is required by the standard, but we might not really need it.
1065 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
1066 if (ref($user_barcode) eq 'NCIP::Problem') {
1067 $response->problem($user_barcode);
1070 my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
1071 if (ref($user) eq 'NCIP::Problem') {
1072 $response->problem($user);
1076 # See if we got a ItemId and a barcode:
1078 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
1079 if (ref($item_barcode) ne 'NCIP::Problem') {
1080 # Retrieve the copy details.
1081 $copy_details = $self->retrieve_copy_details_by_barcode($item_barcode);
1082 unless ($copy_details) {
1083 # Return an Unknown Item problem unless we find the copy.
1087 ProblemType => 'Unknown Item',
1088 ProblemDetail => "Item with barcode $item_barcode is not known.",
1089 ProblemElement => $item_idfield,
1090 ProblemValue => $item_barcode
1098 # See if we got a RequestId:
1100 if ($request->{$message}->{RequestId}) {
1101 $requestid = NCIP::RequestId->new(
1103 AgencyId => $request->{$message}->{RequestId}->{AgencyId},
1104 RequestIdentifierType => $request->{$message}->{RequestId}->{RequestIdentifierType},
1105 RequestIdentifierValue => $request->{$message}->{RequestId}->{RequestIdentifierValue}
1110 # Just a note: In the below, we cannot rely on the hold or transit
1111 # fields of the copy_details, even if we have retrieved it. This
1112 # is because that hold and transit may not be the ones that we're
1113 # looking for, i.e. they could be for another patron, etc.
1115 # See if we can find the hold:
1118 $hold = $U->simplereq(
1120 'open-ils.pcrud.retrieve.ahr',
1121 $self->{session}->{authtoken},
1122 $requestid->{RequestIdentifierValue},
1123 {flesh => 1, flesh_fields => {ahr => ['transit']}}
1126 # Report a problem that we couldn't find a hold by that id.
1130 ProblemType => 'Unknown Request',
1131 ProblemDetail => 'No request with this identifier found',
1132 ProblemElement => 'RequestIdentifierValue',
1133 ProblemValue => $requestid->{RequestIdentifierValue}
1137 } elsif ($hold->cancel_time()) {
1141 ProblemType => 'Request Already Canceled',
1142 ProblemDetail => 'Request has already been canceled',
1143 ProblemElement => 'RequestIdentifierValue',
1144 ProblemValue => $requestid->{RequestIdentifierValue}
1148 } elsif ($hold->transit()) {
1152 ProblemType => 'Request Already Processed',
1153 ProblemDetail => 'Request has already been processed',
1154 ProblemElement => 'RequestIdentifierValue',
1155 ProblemValue => $requestid->{RequestIdentifierValue}
1159 } elsif ($hold->usr() == $user->id()) {
1160 # Check the target matches the copy information, if any,
1161 # that we were given.
1163 if ($copy_details) {
1164 if ($hold->hold_type() eq 'V') {
1165 $obj_id = $copy_details->{volume}->id();
1166 } elsif ($hold->hold_type() eq 'T') {
1167 $obj_id = $copy_details->{mvr}->doc_id();
1168 } elsif ($hold->hold_type() eq 'C' || $hold->hold_type() eq 'F') {
1169 $obj_id = $copy_details->{copy}->id();
1172 if ($obj_id && $hold->target() != $obj_id) {
1176 ProblemType => 'Request Not For This Item',
1177 ProblemDetail => "Request is not for this item",
1178 ProblemElement => $item_idfield,
1179 ProblemElement => $item_barcode
1184 $self->cancel_hold($hold);
1186 RequestId => $requestid,
1187 UserId => NCIP::User::Id->new(
1189 UserIdentifierType => 'Barcode Id',
1190 UserIdentifierValue => $user->card->barcode()
1194 # Look for UserElements requested and add it to the response:
1195 my $elements = $request->{$message}->{UserElementType};
1197 $elements = [$elements] unless (ref $elements eq 'ARRAY');
1198 my $optionalfields = $self->handle_user_elements($user, $elements);
1199 $data->{UserOptionalFields} = $optionalfields;
1201 $elements = $request->{$message}->{ItemElementType};
1202 if ($elements && $copy_details) {
1203 $elements = [$elements] unless (ref $elements eq 'ARRAY');
1204 my $optionalfields = $self->handle_item_elements($copy_details->{copy}, $elements);
1205 $data->{ItemOptionalFields} = $optionalfields;
1207 $response->data($data);
1210 # Report a problem that the hold is not for this user.
1214 ProblemType => 'Request Not For This User',
1215 ProblemDetail => 'Request is not for this user.',
1216 ProblemElement => $user_idfield,
1217 ProblemValue => $user_barcode
1223 # At this point, we *must have* an ItemId and therefore
1224 # $copy_details, so return the problem from looking up the
1225 # barcode if we don't have $copy_details.
1226 if (!$copy_details) {
1227 $response->problem($item_barcode);
1229 # We have to search for the hold based on the copy details and
1230 # the user. We'll need to search for copy (or force) holds, a
1231 # volume hold, or a title hold.
1232 $hold = $self->_hold_search($user, $copy_details);
1233 if ($hold && $hold->transit()) {
1237 ProblemType => 'Request Already Processed',
1238 ProblemDetail => 'Request has already been processed',
1239 ProblemElement => 'RequestIdentifierValue',
1240 ProblemValue => $requestid->{RequestIdentifierValue}
1245 $self->cancel_hold($hold);
1247 RequestId => NCIP::RequestId->new(
1249 RequestIdentifierType => 'SYSNUMBER',
1250 RequestIdentifierValue => $hold->id()
1253 UserId => NCIP::User::Id->new(
1255 UserIdentifierType => 'Barcode Id',
1256 UserIdentifierValue => $user->card->barcode()
1260 # Look for UserElements requested and add it to the response:
1261 my $elements = $request->{$message}->{UserElementType};
1263 $elements = [$elements] unless (ref $elements eq 'ARRAY');
1264 my $optionalfields = $self->handle_user_elements($user, $elements);
1265 $data->{UserOptionalFields} = $optionalfields;
1267 $elements = $request->{$message}->{ItemElementType};
1268 if ($elements && $copy_details) {
1269 $elements = [$elements] unless (ref $elements eq 'ARRAY');
1270 my $optionalfields = $self->handle_item_elements($copy_details->{copy}, $elements);
1271 $data->{ItemOptionalFields} = $optionalfields;
1273 $response->data($data);
1278 ProblemType => 'Unknown Request',
1279 ProblemDetail => 'No request found for the item and user',
1280 ProblemElement => 'NULL',
1281 ProblemValue => 'NULL'
1292 =head1 METHODS USEFUL to SUBCLASSES
1294 =head2 handle_user_elements
1295 $useroptionalfield = $ils->handle_user_elements($user, $elements);
1297 Returns NCIP::User::OptionalFields for the given user and arrayref of
1302 sub handle_user_elements {
1305 my $elements = shift;
1306 my $optionalfields = NCIP::User::OptionalFields->new();
1308 # First, we'll look for name information.
1309 if (grep {$_ eq 'Name Information'} @$elements) {
1310 my $name = NCIP::StructuredPersonalUserName->new();
1311 $name->Surname($user->family_name());
1312 $name->GivenName($user->first_given_name());
1313 $name->Prefix($user->prefix());
1314 $name->Suffix($user->suffix());
1315 $optionalfields->NameInformation($name);
1318 # Next, check for user address information.
1319 if (grep {$_ eq 'User Address Information'} @$elements) {
1322 # See if the user has any valid, physcial addresses.
1323 foreach my $addr (@{$user->addresses()}) {
1324 next if ($U->is_true($addr->pending()));
1325 my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>$addr->address_type()});
1326 my $physical = NCIP::StructuredAddress->new();
1327 $physical->Line1($addr->street1());
1328 $physical->Line2($addr->street2());
1329 $physical->Locality($addr->city());
1330 $physical->Region($addr->state());
1331 $physical->PostalCode($addr->post_code());
1332 $physical->Country($addr->country());
1333 $address->PhysicalAddress($physical);
1334 push @$addresses, $address;
1337 # Right now, we're only sharing email address if the user
1338 # has it. We don't share phone numbers.
1339 if ($user->email()) {
1340 my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>'Email Address'});
1341 $address->ElectronicAddress(
1342 NCIP::ElectronicAddress->new({
1343 Type=>'Email Address',
1344 Data=>$user->email()
1347 push @$addresses, $address;
1350 $optionalfields->UserAddressInformation($addresses);
1353 # Check for User Privilege.
1354 if (grep {$_ eq 'User Privilege'} @$elements) {
1355 # Get the user's group:
1356 my $pgt = $U->simplereq(
1358 'open-ils.pcrud.retrieve.pgt',
1359 $self->{session}->{authtoken},
1363 my $privilege = NCIP::User::Privilege->new();
1364 $privilege->AgencyId($user->home_ou->shortname());
1365 $privilege->AgencyUserPrivilegeType($pgt->name());
1366 $privilege->ValidToDate($user->expire_date());
1367 $privilege->ValidFromDate($user->create_date());
1369 my $status = 'Active';
1370 if (_expired($user)) {
1371 $status = 'Expired';
1372 } elsif ($U->is_true($user->barred())) {
1374 } elsif (!$U->is_true($user->active())) {
1375 $status = 'Inactive';
1378 $privilege->UserPrivilegeStatus(
1379 NCIP::User::PrivilegeStatus->new({
1380 UserPrivilegeStatusType => $status
1385 $optionalfields->UserPrivilege([$privilege]);
1389 # Check for Block Or Trap.
1390 if (grep {$_ eq 'Block Or Trap'} @$elements) {
1393 # First, let's check if the profile is blocked from ILL.
1394 if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
1395 my $block = NCIP::User::BlockOrTrap->new();
1396 $block->AgencyId($user->home_ou->shortname());
1397 $block->BlockOrTrapType('Block Interlibrary Loan');
1398 push @$blocks, $block;
1401 # Next, we loop through the user's standing penalties
1402 # looking for blocks on CIRC, HOLD, and RENEW.
1403 my ($have_circ, $have_renew, $have_hold) = (0,0,0);
1404 foreach my $penalty (@{$user->standing_penalties()}) {
1405 next unless($penalty->standing_penalty->block_list());
1406 my @block_list = split(/\|/, $penalty->standing_penalty->block_list());
1407 my $ou = $U->simplereq(
1409 'open-ils.pcrud.retrieve.aou',
1410 $self->{session}->{authtoken},
1411 $penalty->org_unit()
1415 if (!$have_circ && grep {$_ eq 'CIRC'} @block_list) {
1416 my $bot = NCIP::User::BlockOrTrap->new();
1417 $bot->AgencyId($ou->shortname());
1418 $bot->BlockOrTrapType('Block Checkout');
1419 push @$blocks, $bot;
1424 if (!$have_hold && grep {$_ eq 'HOLD' || $_ eq 'FULFILL'} @block_list) {
1425 my $bot = NCIP::User::BlockOrTrap->new();
1426 $bot->AgencyId($ou->shortname());
1427 $bot->BlockOrTrapType('Block Holds');
1428 push @$blocks, $bot;
1433 if (!$have_renew && grep {$_ eq 'RENEW'} @block_list) {
1434 my $bot = NCIP::User::BlockOrTrap->new();
1435 $bot->AgencyId($ou->shortname());
1436 $bot->BlockOrTrapType('Block Renewals');
1437 push @$blocks, $bot;
1441 # Stop after we report one of each, even if more
1443 last if ($have_circ && $have_renew && $have_hold);
1446 $optionalfields->BlockOrTrap($blocks);
1449 return $optionalfields;
1452 =head2 handle_item_elements
1456 sub handle_item_elements {
1459 my $elements = shift;
1460 my $optionalfields = NCIP::Item::OptionalFields->new();
1462 my $details; # In case we need for more than one.
1464 if (grep {$_ eq 'Bibliographic Description'} @$elements) {
1466 # Check for a precat copy, 'cause it is simple.
1467 if ($copy->dummy_title()) {
1468 $description = NCIP::Item::BibliographicDescription->new();
1469 $description->Title($copy->dummy_title());
1470 $description->Author($copy->dummy_author());
1471 if ($copy->dummy_isbn()) {
1472 $description->BibliographicItemId(
1473 NCIP::Item::BibliographicItemId->new(
1475 BibliographicItemIdentifier => $copy->dummy_isbn(),
1476 BibliographicItemIdentifierCode => 'ISBN'
1482 $details = $self->retrieve_copy_details_by_barcode($copy->barcode()) unless($details);
1483 $description = NCIP::Item::BibliographicDescription->new();
1484 $description->Title($details->{mvr}->title());
1485 $description->Authort($details->{mvr}->author());
1486 $description->BibliographicRecordId(
1487 NCIP::Item::BibliographicRecordId->new(
1489 BibliographicRecordIdentifier => $details->{mvr}->doc_id(),
1490 BibliographicRecordIdentifierCode => 'SYSNUMBER'
1494 if ($details->{mvr}->publisher()) {
1495 $description->Publisher($details->{mvr}->publisher());
1497 if ($details->{mvr}->pubdate()) {
1498 $description->PublicationDate($details->{mvr}->pubdate());
1500 if ($details->{mvr}->edition()) {
1501 $description->Edition($details->{mvr}->edition());
1504 $optionalfields->BibliographicDescription($description) if ($description);
1507 if (grep {$_ eq 'Item Description'} @$elements) {
1508 $details = $self->retrieve_copy_details_by_barcode($copy->barcode()) unless($details);
1509 # Call Number is the only field we currently return. We also
1510 # do not attempt to retun a prefix and suffix. Someone else
1511 # can deal with that if they want it.
1512 if ($details->{volume}) {
1513 $optionalfields->ItemDescription(
1514 NCIP::Item::Description->new(
1515 {CallNumber => $details->{volume}->label()}
1521 if (grep {$_ eq 'Circulation Status'} @$elements) {
1522 my $status = $copy->status();
1523 $status = $self->retrieve_copy_status($status) unless (ref($status));
1524 $optionalfields->CirculationStatus($status->name()) if ($status);
1527 if (grep {$_ eq 'Date Due'} @$elements) {
1528 $details = $self->retrieve_copy_details_by_barcode($copy->barcode()) unless($details);
1529 if ($details->{circ}) {
1530 if (!$details->{circ}->checkin_time()) {
1531 my $due = DateTime::Format::ISO8601->parse_datetime(cleanse_ISO8601($details->{circ}->due_date()));
1532 $due->set_time_zone('UTC');
1533 $optionalfields->DateDue($due->iso8601());
1538 if (grep {$_ eq 'Item Use Restriction Type'} @$elements) {
1539 $optionalfields->ItemUseRestrictionType('None');
1542 if (grep {$_ eq 'Physical Condition'} @$elements) {
1543 $optionalfields->PhysicalCondition(
1544 NCIP::Item::PhysicalCondition->new(
1545 {PhysicalConditionType => 'Unknown'}
1550 return $optionalfields;
1557 Login to Evergreen via OpenSRF. It uses internal state from the
1558 configuration file to login.
1562 # Login via OpenSRF to Evergreen.
1566 # Get the authentication seed.
1567 my $seed = $U->simplereq(
1569 'open-ils.auth.authenticate.init',
1570 $self->{config}->{credentials}->{username}
1575 my $response = $U->simplereq(
1577 'open-ils.auth.authenticate.complete',
1579 username => $self->{config}->{credentials}->{username},
1580 password => md5_hex(
1581 $seed . md5_hex($self->{config}->{credentials}->{password})
1584 workstation => $self->{config}->{credentials}->{workstation}
1588 $self->{session}->{authtoken} = $response->{payload}->{authtoken};
1589 $self->{session}->{authtime} = $response->{payload}->{authtime};
1591 # Set/reset the work_ou and user data in case something changed.
1593 # Retrieve the work_ou as an object.
1594 $self->{session}->{work_ou} = $U->simplereq(
1596 'open-ils.pcrud.search.aou',
1597 $self->{session}->{authtoken},
1598 {shortname => $self->{config}->{credentials}->{work_ou}}
1601 # We need the user information in order to do some things.
1602 $self->{session}->{user} = $U->check_user_session($self->{session}->{authtoken});
1610 $valid = $ils->checkauth();
1612 Returns 1 if the object a 'valid' authtoken, 0 if not.
1619 # We use AppUtils to do the heavy lifting.
1620 if (defined($self->{session})) {
1621 if ($U->check_user_session($self->{session}->{authtoken})) {
1628 # If we reach here, we don't have a session, so we are definitely
1633 =head2 retrieve_user_by_barcode
1635 $user = $ils->retrieve_user_by_barcode($user_barcode, $user_idfield);
1637 Do a fleshed retrieve of a patron by barcode. Return the patron if
1638 found and valid. Return a NCIP::Problem of 'Unknown User' otherwise.
1640 The id field argument is used for the ProblemElement field in the
1641 NCIP::Problem object.
1643 An invalid patron is one where the barcode is not found in the
1644 database, the patron is deleted, or the barcode used to retrieve the
1645 patron is not active. The problem element is also returned if an error
1646 occurs during the retrieval.
1650 sub retrieve_user_by_barcode {
1651 my ($self, $barcode, $idfield) = @_;
1652 my $result = $U->simplereq(
1654 'open-ils.actor.user.fleshed.retrieve_by_barcode',
1655 $self->{session}->{authtoken},
1660 # Check for a failure, or a deleted, inactive, or expired user,
1661 # and if so, return empty userdata.
1662 if (!$result || $U->event_code($result) || $U->is_true($result->deleted())
1663 || !grep {$_->barcode() eq $barcode && $U->is_true($_->active())} @{$result->cards()}) {
1665 my $problem = NCIP::Problem->new();
1666 $problem->ProblemType('Unknown User');
1667 $problem->ProblemDetail("User with barcode $barcode unknown");
1668 $problem->ProblemElement($idfield);
1669 $problem->ProblemValue($barcode);
1676 =head2 retrieve_user_by_id
1678 $user = $ils->retrieve_user_by_id($id);
1680 Similar to C<retrieve_user_by_barcode> but takes the user's database
1681 id rather than barcode. This is useful when you have a circulation or
1682 hold and need to get information about the user's involved in the hold
1685 It returns a fleshed user on success or undef on failure.
1689 sub retrieve_user_by_id {
1690 my ($self, $id) = @_;
1692 # Do a fleshed retrieve of the patron, and flesh the fields that
1693 # we would normally use.
1694 my $result = $U->simplereq(
1696 'open-ils.actor.user.fleshed.retrieve',
1697 $self->{session}->{authtoken},
1699 [ 'card', 'cards', 'standing_penalties', 'addresses', 'home_ou' ]
1701 # Check for an error.
1702 undef($result) if ($result && $U->event_code($result));
1707 =head2 check_user_for_problems
1709 $problem = $ils>check_user_for_problems($user, 'HOLD, 'CIRC', 'RENEW');
1711 This function checks if a user has a blocked profile or any from a
1712 list of provided blocks. If it does, then a NCIP::Problem object is
1713 returned, otherwise an undefined value is returned.
1715 The list of blocks appears as additional arguments after the user. You
1716 can provide any value(s) that might appear in a standing penalty block
1717 lit in Evergreen. The example above checks for HOLD, CIRC, and
1718 RENEW. Any number of such values can be provided. If none are
1719 provided, the function only checks if the patron's profiles appears in
1720 the object's blocked profiles list.
1722 It stops on the first matching block, if any.
1726 sub check_user_for_problems {
1731 # Fill this in if we have a problem, otherwise just return it.
1734 # First, check the user's profile.
1735 if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
1736 $problem = NCIP::Problem->new(
1738 ProblemType => 'User Blocked',
1739 ProblemDetail => 'User blocked from inter-library loan',
1740 ProblemElement => 'NULL',
1741 ProblemValue => 'NULL'
1746 # Next, check if the patron has one of the indicated blocks.
1748 foreach my $penalty (@{$user->standing_penalties()}) {
1749 if ($penalty->standing_penalty->block_list()) {
1750 my @pblocks = split(/\|/, $penalty->standing_penalty->block_list());
1751 foreach my $block (@blocks) {
1752 if (grep {$_ =~ /$block/} @pblocks) {
1753 $problem = NCIP::Problem->new(
1755 ProblemType => 'User Blocked',
1756 ProblemDetail => 'User blocked from ' .
1757 ($block eq 'HOLD') ? 'holds' : (($block eq 'RENEW') ? 'renewals' :
1758 (($block eq 'CIRC') ? 'checkout' : lc($block))),
1759 ProblemElement => 'NULL',
1760 ProblemValue => 'NULL'
1774 =head2 check_circ_details
1776 $problem = $ils->check_circ_details($circ, $copy, $user);
1778 Checks if we can checkin or renew a circulation. That is, the
1779 circulation is still open (i.e. the copy is still checked out), if we
1780 either own the copy or are the circulation location, and if the
1781 circulation is for the optional $user argument. $circ and $copy are
1782 required. $user is optional.
1784 Returns a problem if any of the above conditions fail. Returns undef
1785 if they pass and we can proceed with the checkin or renewal.
1787 If the failure occurred on the copy-related checks, then the
1788 ProblemElement field will be undefined and needs to be filled in with
1789 the item id field name. If the check for the copy being checked out to
1790 the provided user fails, then both ProblemElement and ProblemValue
1791 fields will be empty and need to be filled in by the caller.
1795 sub check_circ_details {
1796 my ($self, $circ, $copy, $user) = @_;
1798 # Shortcut for the next check.
1799 my $ou_id = $self->{session}->{work_ou}->id();
1801 if (!$circ || $circ->checkin_time() || ($circ->circ_lib() != $ou_id && $copy->circ_lib() != $ou_id)) {
1802 # Item isn't checked out.
1803 return NCIP::Problem->new(
1805 ProblemType => 'Item Not Checked Out',
1806 ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out.',
1807 ProblemValue => $copy->barcode()
1811 # Get data on the patron who has it checked out.
1812 my $circ_user = $self->retrieve_user_by_id($circ->usr());
1813 if ($user && $circ_user && $user->id() != $circ_user->id()) {
1814 # The ProblemElement and ProblemValue field need to be
1815 # filled in by the caller.
1816 return NCIP::Problem->new(
1818 ProblemType => 'Item Not Checked Out To This User',
1819 ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out to this user.',
1824 # If we get here, we're good to go.
1828 =head2 retrieve_copy_details_by_barcode
1830 $copy = $ils->retrieve_copy_details_by_barcode($copy_barcode);
1832 Look up and retrieve some copy details by the copy barcode. This
1833 method returns either a hashref with the copy details or undefined if
1834 no copy exists with that barcode or if some error occurs.
1836 The hashref has the fields copy, hold, transit, circ, volume, and mvr.
1838 This method differs from C<retrieve_user_by_barcode> in that a copy
1839 cannot be invalid if it exists and it is not always an error if no
1840 copy exists. In some cases, when handling AcceptItem, we might prefer
1841 there to be no copy.
1845 sub retrieve_copy_details_by_barcode {
1847 my $barcode = shift;
1849 my $copy = $U->simplereq(
1851 'open-ils.circ.copy_details.retrieve.barcode',
1852 $self->{session}->{authtoken},
1856 # If $copy is an event, return undefined.
1857 if ($copy && $U->event_code($copy)) {
1864 =head2 find_copy_details_by_item
1866 $copy_details = $ils->find_copy_details_by_item($item);
1868 This routine returns a copy_details hashref (See:
1869 retrieve_copy_details_by_barcode) for a given item. It attempts to
1870 find the "first" copy for the given item. If item is a call number it
1871 looks for the first, not deleted copy. If item is a bib, it looks for
1872 the first not deleted copy on the first not deleted call number. If
1873 item is a copy, it simply returns the details for the copy.
1877 sub find_copy_details_by_item {
1883 if (ref($item) eq 'Fieldmapper::biblio::record_entry') {
1884 my $acns = $U->simplereq(
1886 'open-ils.pcrud.search.acn.atomic',
1887 $self->{session}->{authtoken},
1889 record => $item->id(),
1893 ($item) = sort {$a->id() <=> $b->id()} @{$acns};
1896 if (ref($item) eq 'Fieldmapper::asset::call_number') {
1897 my $copies = $U->simplereq(
1899 'open-ils.pcrud.search.acp.atomic',
1900 $self->{session}->{authtoken},
1902 call_number => $item->id(),
1906 ($item) = sort {$a->id() <=> $b->id()} @{$copies};
1909 if (ref(item) eq 'Fieldmapper::asset::copy') {
1910 $details = $self->retrieve_copy_details_by_barcode($item->barcode());
1916 =head2 retrieve_copy_status
1918 $status = $ils->retrieve_copy_status($id);
1920 Retrive a copy status object by database ID.
1924 sub retrieve_copy_status {
1928 my $status = $U->simplereq(
1930 'open-ils.pcrud.retrieve.ccs',
1931 $self->{session}->{authtoken},
1938 =head2 retrieve_org_unit_by_shortname
1940 $org_unit = $ils->retrieve_org_unit_by_shortname($shortname);
1942 Retrieves an org. unit from the database by shortname. Returns the
1943 org. unit as a Fieldmapper object or undefined.
1947 sub retrieve_org_unit_by_shortname {
1949 my $shortname = shift;
1951 my $aou = $U->simplereq(
1953 'open-ils.actor.org_unit.retrieve_by_shortname',
1960 =head2 retrieve_copy_location
1962 $location = $ils->retrieve_copy_location($location_id);
1964 Retrieve a copy location based on id.
1968 sub retrieve_copy_location {
1972 my $location = $U->simplereq(
1974 'open-ils.pcrud.retrieve.acpl',
1975 $self->{session}->{authtoken},
1982 =head2 retrieve_biblio_record_entry
1984 $bre = $ils->retrieve_biblio_record_entry($bre_id);
1986 Given a biblio.record_entry.id, this method retrieves a bre object.
1990 sub retrieve_biblio_record_entry {
1994 my $bre = $U->simplereq(
1996 'open-ils.pcrud.retrieve.bre',
1997 $self->{session}->{authtoken},
2004 =head2 create_precat_copy
2007 barcode => '312340123456789',
2008 author => 'Public, John Q.',
2009 title => 'Magnum Opus',
2010 call_number => '005.82',
2011 publisher => 'Brick House',
2012 publication_date => '2014'
2015 $item = $ils->create_precat_copy($item_info);
2018 Create a "precat" copy to use for the incoming item using a hashref of
2019 item information. At a minimum, the barcode, author and title fields
2020 need to be filled in. The other fields are ignored if provided.
2022 This method is called by the AcceptItem handler if the C<use_precats>
2023 configuration option is turned on.
2027 sub create_precat_copy {
2029 my $item_info = shift;
2031 my $item = Fieldmapper::asset::copy->new();
2032 $item->barcode($item_info->{barcode});
2033 $item->call_number(OILS_PRECAT_CALL_NUMBER);
2034 $item->dummy_title($item_info->{title});
2035 $item->dummy_author($item_info->{author});
2036 $item->circ_lib($self->{session}->{work_ou}->id());
2037 $item->circulate('t');
2038 $item->holdable('t');
2039 $item->opac_visible('f');
2040 $item->deleted('f');
2041 $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
2042 $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
2045 $item->editor($self->{session}->{user}->id());
2046 $item->creator($self->{session}->{user}->id());
2049 # Actually create it:
2051 my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
2054 $xact = $ses->request(
2055 'open-ils.pcrud.transaction.begin',
2056 $self->{session}->{authtoken}
2058 $item = $ses->request(
2059 'open-ils.pcrud.create.acp',
2060 $self->{session}->{authtoken},
2063 $xact = $ses->request(
2064 'open-ils.pcrud.transaction.commit',
2065 $self->{session}->{authtoken}
2073 'open-ils.pcrud.transaction.rollback',
2074 $self->{session}->{authtoken}
2084 =head2 create_fuller_copy
2087 barcode => '31234003456789',
2088 author => 'Public, John Q.',
2089 title => 'Magnum Opus',
2090 call_number => '005.82',
2091 publisher => 'Brick House',
2092 publication_date => '2014'
2095 $item = $ils->create_fuller_copy($item_info);
2097 Creates a skeletal bibliographic record, call number, and copy for the
2098 incoming item using a hashref with item information in it. At a
2099 minimum, the barcode, author, title, and call_number fields must be
2102 This method is used by the AcceptItem handler if the C<use_precats>
2103 configuration option is NOT set.
2107 sub create_fuller_copy {
2109 my $item_info = shift;
2113 # We do everything in one transaction, because it should be atomic.
2114 my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
2118 $xact = $ses->request(
2119 'open-ils.pcrud.transaction.begin',
2120 $self->{session}->{authtoken}
2127 # The rest depends on there being a transaction.
2130 # Create the MARC record.
2131 my $record = MARC::Record->new();
2132 $record->encoding('UTF-8');
2133 $record->leader('00881nam a2200193 4500');
2134 my $datespec = strftime("%Y%m%d%H%M%S.0", localtime);
2136 push(@fields, MARC::Field->new('005', $datespec));
2137 push(@fields, MARC::Field->new('082', '0', '4', 'a' => $item_info->{call_number}));
2138 push(@fields, MARC::Field->new('245', '0', '0', 'a' => $item_info->{title}));
2139 # Publisher is a little trickier:
2140 if ($item_info->{publisher}) {
2141 my $pub = MARC::Field->new('260', ' ', ' ', 'a' => '[S.l.]', 'b' => $item_info->{publisher});
2142 $pub->add_subfields('c' => $item_info->{publication_date}) if ($item_info->{publication_date});
2143 push(@fields, $pub);
2145 # We have no idea if the author is personal corporate or something else, so we use a 720.
2146 push(@fields, MARC::Field->new('720', ' ', ' ', 'a' => $item_info->{author}, '4' => 'aut'));
2147 $record->append_fields(@fields);
2148 my $marc = clean_marc($record);
2150 # Create the bib object.
2151 my $bib = Fieldmapper::biblio::record_entry->new();
2152 $bib->creator($self->{session}->{user}->id());
2153 $bib->editor($self->{session}->{user}->id());
2154 $bib->source($self->{bib_source}->id());
2161 $bib = $ses->request(
2162 'open-ils.pcrud.create.bre',
2163 $self->{session}->{authtoken},
2171 'open-ils.pcrud.transaction.rollback',
2172 $self->{session}->{authtoken}
2177 # Create the call number
2180 $acn = Fieldmapper::asset::call_number->new();
2181 $acn->creator($self->{session}->{user}->id());
2182 $acn->editor($self->{session}->{user}->id());
2183 $acn->label($item_info->{call_number});
2184 $acn->record($bib->id());
2185 $acn->owning_lib($self->{session}->{work_ou}->id());
2190 $acn = $ses->request(
2191 'open-ils.pcrud.create.acn',
2192 $self->{session}->{authtoken},
2200 'open-ils.pcrud.transaction.rollback',
2201 $self->{session}->{authtoken}
2209 $item = Fieldmapper::asset::copy->new();
2210 $item->barcode($item_info->{barcode});
2211 $item->call_number($acn->id());
2212 $item->circ_lib($self->{session}->{work_ou}->id);
2213 $item->circulate('t');
2214 if ($self->{config}->{items}->{use_force_holds}) {
2215 $item->holdable('f');
2217 $item->holdable('t');
2219 $item->opac_visible('f');
2220 $item->deleted('f');
2221 $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
2222 $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
2225 $item->editor($self->{session}->{user}->id);
2226 $item->creator($self->{session}->{user}->id);
2230 $item = $ses->request(
2231 'open-ils.pcrud.create.acp',
2232 $self->{session}->{authtoken},
2236 # Cross our fingers and commit the work.
2237 $xact = $ses->request(
2238 'open-ils.pcrud.transaction.commit',
2239 $self->{session}->{authtoken}
2246 'open-ils.pcrud.transaction.rollback',
2247 $self->{session}->{authtoken}
2248 )->gather(1) if ($xact);
2254 # We need to disconnect our session.
2257 # Now, we handle our asset stat_cat entries.
2259 # It would be nice to do these in the above transaction, but
2260 # pcrud does not support the ascecm object, yet.
2261 foreach my $entry (@{$self->{stat_cat_entries}}) {
2262 my $map = Fieldmapper::asset::stat_cat_entry_copy_map->new();
2264 $map->stat_cat($entry->stat_cat());
2265 $map->stat_cat_entry($entry->id());
2266 $map->owning_copy($item->id());
2267 # We don't really worry if it succeeds or not.
2270 'open-ils.circ.stat_cat.asset.copy_map.create',
2271 $self->{session}->{authtoken},
2282 $hold = $ils->place_hold($item, $user, $location, $expiration);
2284 This function places a hold on $item for $user for pickup at
2285 $location. If location is not provided or undefined, the user's home
2286 library is used as a fallback.
2288 The $expiration argument is optional and must be a properly formatted
2289 ISO date time. It will be used as the hold expire time, if
2290 provided. Otherwise the system default time will be used.
2292 $item can be a copy (asset::copy), volume (asset::call_number), or bib
2293 (biblio::record_entry). The appropriate hold type will be placed
2294 depending on the object.
2296 On success, the method returns the object representing the hold. On
2297 failure, a NCIP::Problem object, describing the failure, is returned.
2305 my $location = shift;
2306 my $expiration = shift;
2308 # If $location is undefined, use the user's home_ou, which should
2309 # have been fleshed when the user was retrieved.
2310 $location = $user->home_ou() unless ($location);
2312 # $hold is the hold. $params is for the is_possible check.
2313 my ($hold, $params);
2315 # Prep the hold with fields common to all hold types:
2316 $hold = Fieldmapper::action::hold_request->new();
2317 $hold->isnew(1); # Just to make sure.
2318 $hold->target($item->id());
2319 $hold->usr($user->id());
2320 $hold->pickup_lib($location->id());
2321 $hold->expire_time(cleanse_ISO8601($expiration)) if ($expiration);
2322 if (!$user->email()) {
2323 $hold->email_notify('f');
2324 $hold->phone_notify($user->day_phone()) if ($user->day_phone());
2326 $hold->email_notify('t');
2330 $params = { pickup_lib => $location->id(), patronid => $user->id() };
2332 if (ref($item) eq 'Fieldmapper::asset::copy') {
2333 my $type = ($self->{config}->{items}->{use_force_holds}) ? 'F' : 'C';
2334 $hold->hold_type($type);
2335 $hold->current_copy($item->id());
2336 $params->{hold_type} = $type;
2337 $params->{copy_id} = $item->id();
2338 } elsif (ref($item) eq 'Fieldmapper::asset::call_number') {
2339 $hold->hold_type('V');
2340 $params->{hold_type} = 'V';
2341 $params->{volume_id} = $item->id();
2342 } elsif (ref($item) eq 'Fieldmapper::biblio::record_entry') {
2343 $hold->hold_type('T');
2344 $params->{hold_type} = 'T';
2345 $params->{titleid} = $item->id();
2348 # Check for a duplicate hold:
2349 my $duplicate = $U->simplereq(
2351 'open-ils.pcrud.search.ahr',
2352 $self->{session}->{authtoken},
2354 hold_type => $hold->hold_type(),
2355 target => $hold->target(),
2356 usr => $hold->usr(),
2357 expire_time => {'>' => 'now'},
2358 cancel_time => undef,
2359 fulfillment_time => undef
2363 return NCIP::Problem->new(
2365 ProblemType => 'Duplicate Request',
2366 ProblemDetail => 'A request for this item already exists for this patron.',
2367 ProblemElement => 'NULL',
2368 ProblemValue => 'NULL'
2373 # Check if the hold is possible:
2374 my $r = $U->simplereq(
2376 'open-ils.circ.title_hold.is_possible',
2377 $self->{session}->{authtoken},
2381 if ($r->{success}) {
2382 $hold = $U->simplereq(
2384 'open-ils.circ.holds.create.override',
2385 $self->{session}->{authtoken},
2389 $hold = $hold->[0] if (ref($hold) eq 'ARRAY');
2390 $hold = _problem_from_event('Request Not Possible', $hold);
2392 # open-ils.circ.holds.create.override returns the id on
2393 # success, so we retrieve the full hold object from the
2394 # database to return it.
2395 $hold = $U->simplereq(
2397 'open-ils.pcrud.retrieve.ahr',
2398 $self->{session}->{authtoken},
2402 } elsif ($r->{last_event}) {
2403 $hold = _problem_from_event('Request Not Possible', $r->{last_event});
2404 } elsif ($r->{textcode}) {
2405 $hold = _problem_from_event('Request Not Possible', $r);
2407 $hold = _problem_from_event('Request Not Possible');
2415 $ils->cancel_hold($hold);
2417 This method cancels the hold argument. It makes no checks on the hold,
2418 so if there are certain conditions that need to be fulfilled before
2419 the hold is canceled, then you must check them before calling this
2422 It returns undef on success or failure. If it fails, you've usually
2423 got bigger problems.
2431 my $r = $U->simplereq(
2433 'open-ils.circ.hold.cancel',
2434 $self->{session}->{authtoken},
2437 'Canceled via NCIPServer'
2445 $ils->delete_copy($copy);
2447 Deletes the copy, and if it is owned by our work_ou and not a precat,
2448 we also delete the volume and bib on which the copy depends.
2456 # Shortcut for ownership checks below.
2457 my $ou_id = $self->{session}->{work_ou}->id();
2459 # First, make sure the copy is not already deleted and we own it.
2460 return undef if ($U->is_true($copy->deleted()) || $copy->circ_lib() != $ou_id);
2462 # Indicate we want to delete the copy.
2463 $copy->isdeleted(1);
2465 # Delete the copy using a backend call that will delete the copy,
2466 # the call number, and bib when appropriate.
2467 my $result = $U->simplereq(
2469 'open-ils.cat.asset.copy.fleshed.batch.update.override',
2470 $self->{session}->{authtoken},
2474 # We are currently not checking for succes or failure of the
2475 # above. At some point, someone may want to.
2480 =head2 copy_can_circulate
2482 $can_circulate = $ils->copy_can_circulate($copy);
2484 Check if the copy's location and the copy itself allow
2485 circulation. Return true if they do, and false if they do not.
2489 sub copy_can_circulate {
2493 my $location = $copy->location();
2494 unless (ref($location)) {
2495 $location = $self->retrieve_copy_location($location);
2498 return ($U->is_true($copy->circulate()) && $U->is_true($location->circulate()));
2501 =head2 copy_can_fulfill
2503 $can_fulfill = $ils->copy_can_fulfill($copy);
2505 Check if the copy's location and the copy itself allow
2506 holds. Return true if they do, and false if they do not.
2510 sub copy_can_fulfill {
2514 my $location = $copy->location();
2515 unless (ref($location)) {
2516 $location = $self->retrieve_copy_location($location);
2519 return ($U->is_true($copy->holdable()) && $U->is_true($location->holdable()));
2522 =head1 OVERRIDDEN PARENT METHODS
2524 =head2 find_user_barcode
2526 We dangerously override our parent's C<find_user_barcode> to return
2527 either the $barcode or a Problem object. In list context the barcode
2528 or problem will be the first argument and the id field, if any, will
2529 be the second. We also add a second, optional, argument to indicate a
2530 default value for the id field in the event of a failure to find
2531 anything at all. (Perl lets us get away with this.)
2535 sub find_user_barcode {
2537 my $request = shift;
2538 my $default = shift;
2541 my $message = $self->parse_request_type($request);
2542 if ($message eq 'LookupUser') {
2543 $default = 'AuthenticationInputData';
2545 $default = 'UserIdentifierValue';
2549 my ($value, $idfield) = $self->SUPER::find_user_barcode($request);
2552 $idfield = $default unless ($idfield);
2553 $value = NCIP::Problem->new();
2554 $value->ProblemType('Needed Data Missing');
2555 $value->ProblemDetail('Cannot find user barcode in message.');
2556 $value->ProblemElement($idfield);
2557 $value->ProblemValue('NULL');
2560 return (wantarray) ? ($value, $idfield) : $value;
2563 =head2 find_item_barcode
2565 We do pretty much the same thing as with C<find_user_barcode> for
2566 C<find_item_barcode>.
2570 sub find_item_barcode {
2572 my $request = shift;
2573 my $default = shift || 'ItemIdentifierValue';
2575 my ($value, $idfield) = $self->SUPER::find_item_barcode($request);
2578 $idfield = $default unless ($idfield);
2579 $value = NCIP::Problem->new();
2580 $value->ProblemType('Needed Data Missing');
2581 $value->ProblemDetail('Cannot find item barcode in message.');
2582 $value->ProblemElement($idfield);
2583 $value->ProblemValue('NULL');
2586 return (wantarray) ? ($value, $idfield) : $value;
2589 =head2 find_target_via_bibliographic_id
2591 $item = $ils->find_target_via_bibliographic_id(@biblio_ids);
2593 Searches for a bibliographic record to put on hold and returns an
2594 appropriate hold target item depending upon what it finds. If an
2595 appropriate, single target cannot be found, it returns an
2596 NCIP::Problem with the problem message.
2598 Currently, we only look for SYSNUMBER, ISBN, and ISSN record
2599 identifiers. If nothing is found, this method can return undef. (Gotta
2600 love Perl and untyped/weakly typed languages in general!)
2602 TODO: Figure out how to search OCLC numbers. We probably need to use
2603 "MARC Expert Search" if we don't want to do a JSON query on
2608 sub find_target_via_bibliographic_id {
2610 my @biblio_ids = @_;
2612 # The item that we find:
2615 # Id for our bib in Evergreen:
2618 # First, let's look for a SYSNUMBER:
2620 { ($_->{BibliographicRecordIdentifierCode} && $_->{BibliographicRecordIdentifierCode} eq 'SYSNUMBER')
2621 || ($_->{BibliographicItemIdentifierCode} && $_->{BibliographicItemIdentifierCode} eq 'SYSNUMBER')
2626 # BibliographicRecordId can have an AgencyId field if the
2627 # BibliographicRecordIdentifierCode is absent.
2628 if ($idobj->{AgencyId}) {
2629 $bibid = $idobj->{BibliographicRecordIdentifier};
2630 my $locname = $idobj->{AgencyId};
2632 $locname =~ s/.*://;
2633 $loc = $self->retrieve_org_unit_by_shortname($locname);
2635 } elsif ($idobj->{BibliographicRecordIdentifierCode}) {
2636 $bibid = $idobj->{BibliographicRecordIdentifierCode}
2638 $bibid = $idobj->{BibliographicItemIdentifierCode}
2640 if ($bibid && $loc) {
2641 $item = $self->_call_number_search($bibid, $loc);
2643 $item = $U->simplereq(
2645 'open-ils.pcrud.retrieve.bre',
2646 $self->{session}->{authtoken},
2650 # Check if item is deleted so we'll look for more
2652 undef($item) if ($item && $U->is_true($item->deleted()));
2655 # Build an array of id objects based on the other identifier fields.
2658 ($_->{BibliographicRecordIdentifierCode} && $_->{BibliographicRecordIdentifierCode} eq 'ISBN')
2659 || ($_->{BibliographicItemIdentifierCode} && $_->{BibliographicItemIdentifierCode} eq 'ISBN')
2660 || ($_->{BibliographicRecordIdentifierCode} && $_->{BibliographicRecordIdentifierCode} eq 'ISSN')
2661 || ($_->{BibliographicItemIdentifierCode} && $_->{BibliographicItemIdentifierCode} eq 'ISSN')
2665 my $stashed_problem;
2666 # Reuse $idobj from above.
2667 foreach $idobj (@idobjs) {
2668 my ($idvalue, $idtype, $idfield);
2669 if ($_->{BibliographicItemIdentifier}) {
2670 $idvalue = $_->{BibliographicItemIdentifier};
2671 $idtype = $_->{BibliographicItemIdentifierCode};
2672 $idfield = 'BibliographicItemIdentifier';
2674 $idvalue = $_->{BibliographicRecordIdentifier};
2675 $idtype = $_->{BibliographicRecordIdentifierCode};
2676 $idfield = 'BibliographicRecordIdentifier';
2678 $item = $self->_bib_search($idvalue, $idtype);
2679 if (ref($item) eq 'NCIP::Problem') {
2680 $stashed_problem = $item unless($stashed_problem);
2681 $stashed_problem->ProblemElement($idfield);
2686 $item = $stashed_problem if (!$item && $stashed_problem);
2692 # private subroutines not meant to be used directly by subclasses.
2693 # Most have to do with setup and/or state checking of implementation
2696 # Find, load, and parse our configuration file:
2700 # Find the configuration file via variables:
2701 my $file = OILS_NCIP_CONFIG_DEFAULT;
2702 $file = $ENV{OILS_NCIP_CONFIG} if ($ENV{OILS_NCIP_CONFIG});
2704 $self->{config} = XMLin($file, NormaliseSpace => 2,
2705 ForceArray => ['block_profile', 'stat_cat_entry']);
2708 # Bootstrap OpenSRF::System and load the IDL.
2712 my $bootstrap_config = $self->{config}->{bootstrap};
2713 OpenSRF::System->bootstrap_client(config_file => $bootstrap_config);
2715 my $idl = OpenSRF::Utils::SettingsClient->new->config_value("IDL");
2716 Fieldmapper->import(IDL => $idl);
2719 # Login and then initialize some object data based on the
2724 # Login to Evergreen.
2727 # Load the barred groups as pgt objects into a blocked_profiles
2729 $self->{blocked_profiles} = [];
2730 foreach (@{$self->{config}->{patrons}->{block_profile}}) {
2733 $pgt = $U->simplereq(
2735 'open-ils.pcrud.retrieve.pgt',
2736 $self->{session}->{authtoken},
2740 $pgt = $U->simplereq(
2742 'open-ils.pcrud.search.pgt',
2743 $self->{session}->{authtoken},
2747 push(@{$self->{blocked_profiles}}, $pgt) if ($pgt);
2750 # Load the bib source if we're not using precats.
2751 unless ($self->{config}->{items}->{use_precats}) {
2752 # Retrieve the default
2753 $self->{bib_source} = $U->simplereq(
2755 'open-ils.pcrud.retrieve.cbs',
2756 $self->{session}->{authtoken},
2757 BIB_SOURCE_DEFAULT);
2758 my $data = $self->{config}->{items}->{bib_source};
2760 $data = $data->[0] if (ref($data) eq 'ARRAY');
2763 $result = $U->simplereq(
2765 'open-ils.pcrud.retrieve.cbs',
2766 $self->{session}->{authtoken},
2770 $result = $U->simplereq(
2772 'open-ils.pcrud.search.cbs',
2773 $self->{session}->{authtoken},
2777 $self->{bib_source} = $result if ($result);
2781 # Load the required asset.stat_cat_entries:
2782 $self->{stat_cat_entries} = [];
2783 # First, make a regex for our ou and ancestors:
2784 my $ancestors = join("|", @{$U->get_org_ancestors($self->{session}->{work_ou}->id())});
2785 my $re = qr/(?:$ancestors)/;
2786 # Get the uniq stat_cat ids from the configuration:
2787 my @cats = uniq map {$_->{stat_cat}} @{$self->{config}->{items}->{stat_cat_entry}};
2788 # Retrieve all of the fleshed stat_cats and entries for the above.
2789 my $stat_cats = $U->simplereq(
2791 'open-ils.circ.stat_cat.asset.retrieve.batch',
2792 $self->{session}->{authtoken},
2795 foreach my $entry (@{$self->{config}->{items}->{stat_cat_entry}}) {
2796 # Must have the stat_cat attr and the name, so we must have a
2798 next unless(ref $entry);
2799 my ($stat) = grep {$_->id() == $entry->{stat_cat}} @$stat_cats;
2800 push(@{$self->{stat_cat_entries}}, grep {$_->owner() =~ $re && $_->value() eq $entry->{content}} @{$stat->entries()});
2804 # Search asset.call_number by a bre.id and location object. Return the
2805 # "closest" call_number if found, undef otherwise.
2806 sub _call_number_search {
2809 my $location = shift;
2811 # At some point, this should be smarter, and we should retrieve
2812 # ancestors and descendants and search with a JSON query or some
2813 # such with results ordered by proximity to the original location,
2814 # but I don't have time to implement that right now.
2815 my $acn = $U->simplereq(
2817 'open-ils.pcrud.search.acn',
2818 $self->{session}->{authtoken},
2819 {record => $bibid, owning_lib => $location->id()}
2825 # Do a multiclass.query to search for items by isbn or issn.
2828 my $idvalue = shift;
2832 my $result = $U->simplereq(
2834 'open-ils.search.biblio.multiclass',
2835 {searches => {lc($idtype) => $idvalue}}
2838 if ($result && $result->{count}) {
2839 if ($result->{count} > 1) {
2840 $item = NCIP::Problem->new(
2842 ProblemType => 'Non-Unique Item',
2843 ProblemDetail => 'More than one item matches the request.',
2844 ProblemElement => '',
2845 ProblemValue => $idvalue
2849 my $bibid = $result->{ids}->[0]->[0];
2850 $item = $U->simplereq(
2852 'open-ils.pcrud.retrieve.bre',
2853 $self->{session}->{authtoken},
2861 # Search for holds using the user and copy_details information:
2865 my $copy_details = shift;
2869 # Retrieve all of the user's active holds, and then search them in Perl.
2870 my $holds_list = $U->simplereq(
2872 'open-ils.circ.holds.retrieve',
2873 $self->{session}->{authtoken},
2878 if ($holds_list && @$holds_list) {
2880 # Look for title holds (the most common), first:
2881 my $targetid = $copy_details->{mvr}->doc_id();
2882 @holds = grep {$_->hold_type eq 'T' && $_->target == $targetid} @{$holds_list};
2884 # Look for volume holds, the next most common:
2885 $targetid = $copy_details->{volume}->id();
2886 @holds = grep {$_->hold_type eq 'V' && $_->target == $targetid} @{$holds_list};
2889 # Look for copy and force holds, the least likely.
2890 $targetid = $copy_details->{copy}->id();
2891 @holds = grep {($_->hold_type eq 'C' || $_->hold_type eq 'F') && $_->target == $targetid} @{$holds_list};
2893 # There should only be 1, at this point, if there are any.
2902 # Standalone, "helper" functions. These do not take an object or
2905 # Check if a user is past their expiration date.
2910 # Users might not expire. If so, they have no expire_date.
2911 if ($user->expire_date()) {
2912 my $expires = DateTime::Format::ISO8601->parse_datetime(
2913 cleanse_ISO8601($user->expire_date())
2915 my $now = DateTime->now()->epoch();
2916 $expired = $now > $expires;
2922 # Creates a NCIP Problem from an event. Takes a string for the problem
2923 # type, the event hashref (or a string to use for the detail), and
2924 # optional arguments for the ProblemElement and ProblemValue fields.
2925 sub _problem_from_event {
2926 my ($type, $evt, $element, $value) = @_;
2932 my ($textcode, $desc);
2934 # Get the textcode, if available. Otherwise, use the ilsevent
2935 # "id," if available.
2936 if ($evt->{textcode}) {
2937 $textcode = $evt->{textcode};
2938 } elsif ($evt->{ilsevent}) {
2939 $textcode = $evt->{ilsevent};
2942 # Get the description. We favor translated descriptions over
2943 # the English in ils_events.xml.
2945 $desc = $evt->{desc};
2948 # Check if $type was set. As an "undocumented" feature, you
2949 # can pass undef, and we'll use the textcode from the event.
2956 # Set the detail from some combination of the above.
2959 } elsif ($textcode eq 'PERM_FAILURE') {
2960 if ($evt->{ilsperm}) {
2961 $detail = "Permission denied: " . $evt->{ilsperm};
2962 $detail =~ s/\.override$//;
2964 } elsif ($textcode) {
2965 $detail = "ILS returned $textcode error.";
2967 $detail = 'Detail not available.';
2974 return NCIP::Problem->new(
2976 ProblemType => ($type) ? $type : 'Temporary Processing Failure',
2977 ProblemDetail => ($detail) ? $detail : 'Detail not available.',
2978 ProblemElement => ($element) ? $element : 'NULL',
2979 ProblemValue => ($value) ? $value : 'NULL'