1 # ---------------------------------------------------------------
2 # Copyright © 2014 Jason J.A. Stephenson <jason@sigio.com>
4 # This file is part of NCIPServer.
6 # NCIPServer is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # NCIPServer is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with NCIPServer. If not, see <http://www.gnu.org/licenses/>.
18 # ---------------------------------------------------------------
19 package NCIP::ILS::Evergreen;
22 use XML::LibXML::Simple qw(XMLin);
24 use DateTime::Format::ISO8601;
25 use Digest::MD5 qw/md5_hex/;
27 use OpenSRF::AppSession;
28 use OpenSRF::Utils qw/:datetime/;
29 use OpenSRF::Utils::SettingsClient;
30 use OpenILS::Utils::Fieldmapper;
31 use OpenILS::Utils::Normalize qw(clean_marc);
32 use OpenILS::Application::AppUtils;
33 use OpenILS::Const qw/:const/;
37 use List::MoreUtils qw/uniq/;
38 use POSIX qw/strftime/;
40 # We need a bunch of NCIP::* objects.
44 use NCIP::User::OptionalFields;
45 use NCIP::User::AddressInformation;
47 use NCIP::User::BlockOrTrap;
48 use NCIP::User::Privilege;
49 use NCIP::User::PrivilegeStatus;
50 use NCIP::StructuredPersonalUserName;
51 use NCIP::StructuredAddress;
52 use NCIP::ElectronicAddress;
56 # Inherit from NCIP::ILS.
57 use parent qw(NCIP::ILS);
61 Evergreen - Evergreen driver for NCIPServer
65 my $ils = NCIP::ILS::Evergreen->new(name => $config->{NCIP.ils.value});
69 NCIP::ILS::Evergreen is the default driver for Evergreen and
70 NCIPServer. It was initially developed to work with Auto-Graphics'
71 SHAREit software using a subset of an unspecified ILL/DCB profile.
75 # Default values we define for things that might be missing in our
76 # runtime environment or configuration file that absolutely must have
79 # OILS_NCIP_CONFIG_DEFAULT is the default location to find our
80 # driver's configuration file. This location can be overridden by
81 # setting the path in the OILS_NCIP_CONFIG environment variable.
83 # BIB_SOURCE_DEFAULT is the config.bib_source.id to use when creating
84 # "short" bibs. It is used only if no entry is supplied in the
85 # configuration file. The provided default is 2, the id of the
86 # "System Local" source that comes with a default Evergreen
89 OILS_NCIP_CONFIG_DEFAULT => '/openils/conf/oils_ncip.xml',
90 BIB_SOURCE_DEFAULT => 2
93 # A common Evergreen code shortcut to use AppUtils:
94 my $U = 'OpenILS::Application::AppUtils';
96 # The usual constructor:
99 $class = ref($class) if (ref $class);
101 # Instantiate our parent with the rest of the arguments. It
102 # creates a blessed hashref.
103 my $self = $class->SUPER::new(@_);
105 # Look for our configuration file, load, and parse it:
108 # Bootstrap OpenSRF and prepare some OpenILS components.
111 # Initialize the rest of our internal state.
117 =head1 HANDLER METHODS
121 $ils->lookupuser($request);
123 Processes a LookupUser request.
131 # Check our session and login if necessary.
132 $self->login() unless ($self->checkauth());
134 my $message_type = $self->parse_request_type($request);
136 # Let's go ahead and create our response object. We need this even
137 # if there is a problem.
138 my $response = NCIP::Response->new({type => $message_type . "Response"});
139 $response->header($self->make_header($request));
141 # Need to parse the request object to get the user barcode.
142 my ($barcode, $idfield) = $self->find_user_barcode($request);
144 # If we did not find a barcode, then report the problem.
145 if (ref($barcode) eq 'NCIP::Problem') {
146 $response->problem($barcode);
150 # Look up our patron by barcode:
151 my $user = $self->retrieve_user_by_barcode($barcode, $idfield);
152 if (ref($user) eq 'NCIP::Problem') {
153 $response->problem($user);
157 # We got the information, so lets fill in our userdata.
158 my $userdata = NCIP::User->new();
160 # Make an array of the user's active barcodes.
162 foreach my $card (@{$user->cards()}) {
163 if ($U->is_true($card->active())) {
164 my $id = NCIP::User::Id->new({
165 UserIdentifierType => 'Barcode',
166 UserIdentifierValue => $card->barcode()
171 $userdata->UserId($ids);
173 # Check if they requested any optional fields and return those.
174 my $elements = $request->{$message_type}->{UserElementType};
176 $elements = [$elements] unless (ref $elements eq 'ARRAY');
177 my $optionalfields = NCIP::User::OptionalFields->new();
179 # First, we'll look for name information.
180 if (grep {$_ eq 'Name Information'} @$elements) {
181 my $name = NCIP::StructuredPersonalUserName->new();
182 $name->Surname($user->family_name());
183 $name->GivenName($user->first_given_name());
184 $name->Prefix($user->prefix());
185 $name->Suffix($user->suffix());
186 $optionalfields->NameInformation($name);
189 # Next, check for user address information.
190 if (grep {$_ eq 'User Address Information'} @$elements) {
193 # See if the user has any valid, physcial addresses.
194 foreach my $addr (@{$user->addresses()}) {
195 next if ($U->is_true($addr->pending()));
196 my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>$addr->address_type()});
197 my $physical = NCIP::StructuredAddress->new();
198 $physical->Line1($addr->street1());
199 $physical->Line2($addr->street2());
200 $physical->Locality($addr->city());
201 $physical->Region($addr->state());
202 $physical->PostalCode($addr->post_code());
203 $physical->Country($addr->country());
204 $address->PhysicalAddress($physical);
205 push @$addresses, $address;
208 # Right now, we're only sharing email address if the user
209 # has it. We don't share phone numbers.
210 if ($user->email()) {
211 my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>'Email Address'});
212 $address->ElectronicAddress(
213 NCIP::ElectronicAddress->new({
214 Type=>'Email Address',
218 push @$addresses, $address;
221 $optionalfields->UserAddressInformation($addresses);
224 # Check for User Privilege.
225 if (grep {$_ eq 'User Privilege'} @$elements) {
226 # Get the user's group:
227 my $pgt = $U->simplereq(
229 'open-ils.pcrud.retrieve.pgt',
230 $self->{session}->{authtoken},
234 my $privilege = NCIP::User::Privilege->new();
235 $privilege->AgencyId($user->home_ou->shortname());
236 $privilege->AgencyUserPrivilegeType($pgt->name());
237 $privilege->ValidToDate($user->expire_date());
238 $privilege->ValidFromDate($user->create_date());
240 my $status = 'Active';
241 if (_expired($user)) {
243 } elsif ($U->is_true($user->barred())) {
245 } elsif (!$U->is_true($user->active())) {
246 $status = 'Inactive';
249 $privilege->UserPrivilegeStatus(
250 NCIP::User::PrivilegeStatus->new({
251 UserPrivilegeStatusType => $status
256 $optionalfields->UserPrivilege([$privilege]);
260 # Check for Block Or Trap.
261 if (grep {$_ eq 'Block Or Trap'} @$elements) {
264 # First, let's check if the profile is blocked from ILL.
265 if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
266 my $block = NCIP::User::BlockOrTrap->new();
267 $block->AgencyId($user->home_ou->shortname());
268 $block->BlockOrTrapType('Block Interlibrary Loan');
269 push @$blocks, $block;
272 # Next, we loop through the user's standing penalties
273 # looking for blocks on CIRC, HOLD, and RENEW.
274 my ($have_circ, $have_renew, $have_hold) = (0,0,0);
275 foreach my $penalty (@{$user->standing_penalties()}) {
276 next unless($penalty->standing_penalty->block_list());
277 my @block_list = split(/\|/, $penalty->standing_penalty->block_list());
278 my $ou = $U->simplereq(
280 'open-ils.pcrud.retrieve.aou',
281 $self->{session}->{authtoken},
286 if (!$have_circ && grep {$_ eq 'CIRC'} @block_list) {
287 my $bot = NCIP::User::BlockOrTrap->new();
288 $bot->AgencyId($ou->shortname());
289 $bot->BlockOrTrapType('Block Checkout');
295 if (!$have_hold && grep {$_ eq 'HOLD' || $_ eq 'FULFILL'} @block_list) {
296 my $bot = NCIP::User::BlockOrTrap->new();
297 $bot->AgencyId($ou->shortname());
298 $bot->BlockOrTrapType('Block Holds');
304 if (!$have_renew && grep {$_ eq 'RENEW'} @block_list) {
305 my $bot = NCIP::User::BlockOrTrap->new();
306 $bot->AgencyId($ou->shortname());
307 $bot->BlockOrTrapType('Block Renewals');
312 # Stop after we report one of each, even if more
314 last if ($have_circ && $have_renew && $have_hold);
317 $optionalfields->BlockOrTrap($blocks);
320 $userdata->UserOptionalFields($optionalfields);
323 $response->data($userdata);
330 $ils->acceptitem($request);
332 Processes an AcceptItem request.
340 # Check our session and login if necessary.
341 $self->login() unless ($self->checkauth());
343 # Common preparation.
344 my $message = $self->parse_request_type($request);
345 my $response = NCIP::Response->new({type => $message . 'Response'});
346 $response->header($self->make_header($request));
348 # We only accept holds for the time being.
349 if ($request->{$message}->{RequestedActionType} !~ /^hold\w/i) {
350 # We need the item id or we can't do anything at all.
351 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
352 if (ref($item_barcode) eq 'NCIP::Problem') {
353 $response->problem($item_barcode);
357 # We need to find a patron barcode or we can't look anyone up
359 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request, 'UserIdentifierValue');
360 if (ref($user_barcode) eq 'NCIP::Problem') {
361 $response->problem($user_barcode);
364 # Look up our patron by barcode:
365 my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
366 if (ref($user) eq 'NCIP::Problem') {
367 $response->problem($user);
370 # We're doing patron checks before looking for bibliographic
371 # information and creating the item because problems with the
372 # patron are more likely to occur.
373 my $problem = $self->check_user_for_problems($user, 'HOLD');
375 $response->problem($problem);
379 # Check if the item barcode already exists:
380 my $item = $self->retrieve_copy_details_by_barcode($item_barcode);
382 # What to do here was not defined in the
383 # specification. Since the copies that we create this way
384 # should get deleted when checked in, it would be an error
385 # if we try to create another one. It means that something
386 # has gone wrong somewhere.
390 ProblemType => 'Duplicate Item',
391 ProblemDetail => "Item with barcode $item_barcode already exists.",
392 ProblemElement => $item_idfield,
393 ProblemValue => $item_barcode
400 # Now, we have to create our new copy and/or bib and call number.
402 # First, we have to gather the necessary information from the
403 # request. Store in a hashref for convenience. We may write a
404 # method to get this information in the future if we find we
405 # need it in other handlers. Such a function would be a
406 # candidate to go into our parent, NCIP::ILS.
408 barcode => $item_barcode,
409 call_number => $request->{$message}->{ItemOptionalFields}->{ItemDescription}->{CallNumber},
410 title => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{Author},
411 author => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{Title},
412 publisher => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{Publisher},
413 publication_date => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{PublicationDate},
414 medium => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{MediumType},
415 electronic => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{ElectronicResource}
418 if ($self->{config}->{items}->{use_precats}) {
419 # We only need to create a precat copy.
420 $item = $self->create_precat_copy($item_info);
422 # We have to create a "partial" bib record, a call number and a copy.
423 $item = $self->create_fuller_copy($item_info);
426 # If we failed to create the copy, report a problem.
430 ProblemType => 'Temporary Processing Failure',
431 ProblemDetail => 'Failed to create the item in the system',
432 ProblemElement => $item_idfield,
433 ProblemValue => $item_barcode
439 # We try to find the pickup location in our database. It's OK
440 # if it does not exist, the user's home library will be used
442 my $location = $request->{$message}->{PickupLocation};
444 $location = $self->retrieve_org_unit_by_shortname($location);
447 # Now, we place the hold on the newly created copy on behalf
448 # of the patron retrieved above.
449 my $hold = $self->place_hold($item, $user, $location);
450 if (ref($hold) eq 'NCIP::Problem') {
451 $response->problem($hold);
455 # We return the RequestId and optionally, the ItemID. We'll
456 # just return what was sent to us, since we ignored all of it
459 $data->{RequestId} = NCIP::RequestId->new(
461 AgencyId => $request->{$message}->{RequestId}->{AgencyId},
462 RequestIdentifierType => $request->{$message}->{RequestId}->{RequestIdentifierType},
463 RequestIdentifierValue => $request->{$message}->{RequestId}->{RequestIdentifierValue}
466 $data->{ItemId} = NCIP::Item::Id->new(
468 AgencyId => $request->{$message}->{ItemId}->{AgencyId},
469 ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
470 ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
473 $response->data($data);
476 my $problem = NCIP::Problem->new();
477 $problem->ProblemType('Unauthorized Combination Of Element Values For System');
478 $problem->ProblemDetail('We only support Hold For Pickup');
479 $problem->ProblemElement('RequestedActionType');
480 $problem->ProblemValue($request->{$message}->{RequestedActionType});
481 $response->problem($problem);
489 $response = $ils->checkinitem($request);
491 Checks the item in if we can find the barcode in the message. It
492 returns problems if it cannot find the item in the system or if the
493 item is not checked out.
495 It could definitely use some more brains at some point as it does not
496 fully support everything that the standard allows. It also does not
497 really check if the checkin succeeded or not.
505 # Check our session and login if necessary:
506 $self->login() unless ($self->checkauth());
509 my $message = $self->parse_request_type($request);
510 my $response = NCIP::Response->new({type => $message . 'Response'});
511 $response->header($self->make_header($request));
513 # We need the copy barcode from the message.
514 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
515 if (ref($item_barcode) eq 'NCIP::Problem') {
516 $response->problem($item_barcode);
520 # Retrieve the copy details.
521 my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
523 # Return an Unknown Item problem unless we find the copy.
527 ProblemType => 'Unknown Item',
528 ProblemDetail => "Item with barcode $item_barcode is not known.",
529 ProblemElement => $item_idfield,
530 ProblemValue => $item_barcode
537 # Check if a UserId was provided. If so, this is the patron to
538 # whom the copy should be checked out.
540 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
541 # We ignore the problem, because the UserId is optional.
542 if (ref($user_barcode) ne 'NCIP::Problem') {
543 $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
544 # We don't ignore a problem here, however.
545 if (ref($user) eq 'NCIP::Problem') {
546 $response->problem($user);
552 my $copy = $details->{copy};
554 # Look for a circulation and examine its information:
555 my $circ = $details->{circ};
557 # Check the circ details to see if the copy is checked out and, if
558 # the patron was provided, that it is checked out to the patron in
559 # question. We also verify the copy ownership and circulation
561 my $problem = $self->check_circ_details($circ, $copy, $user);
563 # We need to fill in some information, however.
564 if (!$problem->ProblemValue() && !$problem->ProblemElement()) {
565 $problem->ProblemValue($user_barcode);
566 $problem->ProblemElement($user_idfield);
567 } elsif (!$problem->ProblemElement()) {
568 $problem->ProblemElement($item_idfield);
570 $response->problem($problem);
574 # Checkin parameters. We want to skip hold targeting or making
575 # transits, to force the checkin despite the copy status, as
576 # well as void overdues.
578 copy_barcode => $copy->barcode(),
583 my $result = $U->simplereq(
585 'open-ils.circ.checkin.override',
586 $self->{session}->{authtoken},
589 if (ref($result) eq 'ARRAY') {
590 $result = $result->[0];
592 if ($result->{textcode} eq 'SUCCESS') {
593 # Delete the copy. Since delete_copy checks ownership
594 # before attempting to delete the copy, we don't bother
595 # checking who owns it.
596 $self->delete_copy($copy);
597 # We need the circulation user for the information below, so we retrieve it.
598 my $circ_user = $self->retrieve_user_by_id($circ->usr());
600 ItemId => NCIP::Item::Id->new(
602 AgencyId => $request->{$message}->{ItemId}->{AgencyId},
603 ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
604 ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
607 UserId => NCIP::User::Id->new(
609 UserIdentifierType => 'Barcode Id',
610 UserIdentifierValue => $circ_user->card->barcode()
615 $response->data($data);
617 # At some point in the future, we should probably check if
618 # they requested optional user or item elements and return
619 # those. For the time being, we ignore those at the risk of
620 # being considered non-compliant.
622 $response->problem(_problem_from_event('Checkin Failed', $result));
630 $response = $ils->renewitem($request);
632 Handle the RenewItem message.
640 # Check our session and login if necessary:
641 $self->login() unless ($self->checkauth());
644 my $message = $self->parse_request_type($request);
645 my $response = NCIP::Response->new({type => $message . 'Response'});
646 $response->header($self->make_header($request));
648 # We need the copy barcode from the message.
649 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
650 if (ref($item_barcode) eq 'NCIP::Problem') {
651 $response->problem($item_barcode);
655 # Retrieve the copy details.
656 my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
658 # Return an Unknown Item problem unless we find the copy.
662 ProblemType => 'Unknown Item',
663 ProblemDetail => "Item with barcode $item_barcode is not known.",
664 ProblemElement => $item_idfield,
665 ProblemValue => $item_barcode
672 # User is required for RenewItem.
673 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
674 if (ref($user_barcode) eq 'NCIP::Problem') {
675 $response->problem($user_barcode);
678 my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
679 if (ref($user) eq 'NCIP::Problem') {
680 $response->problem($user);
685 my $copy = $details->{copy};
687 # Look for a circulation and examine its information:
688 my $circ = $details->{circ};
690 # Check the circ details to see if the copy is checked out and, if
691 # the patron was provided, that it is checked out to the patron in
692 # question. We also verify the copy ownership and circulation
694 my $problem = $self->check_circ_details($circ, $copy, $user);
696 # We need to fill in some information, however.
697 if (!$problem->ProblemValue() && !$problem->ProblemElement()) {
698 $problem->ProblemValue($user_barcode);
699 $problem->ProblemElement($user_idfield);
700 } elsif (!$problem->ProblemElement()) {
701 $problem->ProblemElement($item_idfield);
703 $response->problem($problem);
707 # Check if user is blocked from renewals:
708 $problem = $self->check_user_for_problems($user, 'RENEW');
710 # Replace the ProblemElement and ProblemValue fields.
711 $problem->ProblemElement($user_idfield);
712 $problem->ProblemValue($user_barcode);
713 $response->problem($problem);
717 # Check if the duration rule allows renewals. It should have been
718 # fleshed during the copy details retrieve.
719 my $rule = $circ->duration_rule();
720 unless (ref($rule)) {
721 $rule = $U->simplereq(
723 'open-ils.pcrud.retrieve.crcd',
724 $self->{session}->{authtoken},
728 if ($rule->max_renewals() < 1) {
732 ProblemType => 'Item Not Renewable',
733 ProblemDetail => 'Item may not be renewed.',
734 ProblemElement => $item_idfield,
735 ProblemValue => $item_barcode
742 # Check if there are renewals remaining on the latest circ:
743 if ($circ->renewal_remaining() < 1) {
747 ProblemType => 'Maximum Renewals Exceeded',
748 ProblemDetail => 'Renewal cannot proceed because the User has already renewed the Item the maximum number of times permitted.',
749 ProblemElement => $item_idfield,
750 ProblemValue => $item_barcode
757 # Now, we attempt the renewal. If it fails, we simply say that the
758 # user is not allowed to renew this item, without getting into
762 patron_id => $user->id(),
765 my $r = $U->simplereq(
767 'open-ils.circ.renew.override',
768 $self->{session}->{authtoken},
772 # We only look at the first one, since more than one usually means
774 if (ref($r) eq 'ARRAY') {
777 if ($r->{textcode} ne 'SUCCESS') {
778 $problem = _problem_from_event('Renewal Failed', $r);
779 $response->problem($problem);
782 ItemId => NCIP::Item::Id->new(
784 AgencyId => $request->{$message}->{ItemId}->{AgencyId},
785 ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
786 ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
789 UserId => NCIP::User::Id->new(
791 UserIdentifierType => 'Barcode Id',
792 UserIdentifierValue => $user->card->barcode()
796 # We need to retrieve the copy details again to refresh our
797 # circ information to get the new due date.
798 $details = $self->retrieve_copy_details_by_barcode($item_barcode);
799 $circ = $details->{circ};
800 my $due = DateTime::Format::ISO8601->parse_datetime(cleanse_ISO8601($circ->due_date()));
801 $due->set_time_zone('UTC');
802 $data->{DateDue} = $due->iso8601();
804 $response->data($data);
807 # At some point in the future, we should probably check if
808 # they requested optional user or item elements and return
809 # those. For the time being, we ignore those at the risk of
810 # being considered non-compliant.
817 $response = $ils->checkoutitem($request);
819 Handle the Checkoutitem message.
827 # Check our session and login if necessary:
828 $self->login() unless ($self->checkauth());
831 my $message = $self->parse_request_type($request);
832 my $response = NCIP::Response->new({type => $message . 'Response'});
833 $response->header($self->make_header($request));
835 # We need the copy barcode from the message.
836 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
837 if (ref($item_barcode) eq 'NCIP::Problem') {
838 $response->problem($item_barcode);
842 # Retrieve the copy details.
843 my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
845 # Return an Unknown Item problem unless we find the copy.
849 ProblemType => 'Unknown Item',
850 ProblemDetail => "Item with barcode $item_barcode is not known.",
851 ProblemElement => $item_idfield,
852 ProblemValue => $item_barcode
859 # User is required for CheckOutItem.
860 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
861 if (ref($user_barcode) eq 'NCIP::Problem') {
862 $response->problem($user_barcode);
865 my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
866 if (ref($user) eq 'NCIP::Problem') {
867 $response->problem($user);
872 my $copy = $details->{copy};
874 # Check if the copy can circulate.
875 unless ($self->copy_can_circulate($copy)) {
879 ProblemType => 'Item Does Not Circulate',
880 ProblemDetail => "Item with barcode $item_barcode does not circulate.",
881 ProblemElement => $item_idfield,
882 ProblemValue => $item_barcode
889 # Look for a circulation and examine its information:
890 my $circ = $details->{circ};
892 # Check if the item is already checked out.
893 if ($circ && !$circ->checkin_time()) {
897 ProblemType => 'Item Already Checked Out',
898 ProblemDetail => "Item with barcode $item_barcode is already checked out.",
899 ProblemElement => $item_idfield,
900 ProblemValue => $item_barcode
907 # Check if user is blocked from circulation:
908 my $problem = $self->check_user_for_problems($user, 'CIRC');
910 # Replace the ProblemElement and ProblemValue fields.
911 $problem->ProblemElement($user_idfield);
912 $problem->ProblemValue($user_barcode);
913 $response->problem($problem);
917 # Now, we attempt the check out. If it fails, we simply say that
918 # the user is not allowed to check out this item, without getting
922 patron_id => $user->id(),
924 my $r = $U->simplereq(
926 'open-ils.circ.checkout.full.override',
927 $self->{session}->{authtoken},
931 # We only look at the first one, since more than one usually means
933 if (ref($r) eq 'ARRAY') {
936 if ($r->{textcode} ne 'SUCCESS') {
937 $problem = _problem_from_event('Check Out Failed', $r);
938 $response->problem($problem);
941 ItemId => NCIP::Item::Id->new(
943 AgencyId => $request->{$message}->{ItemId}->{AgencyId},
944 ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
945 ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
948 UserId => NCIP::User::Id->new(
950 UserIdentifierType => 'Barcode Id',
951 UserIdentifierValue => $user->card->barcode()
955 # We need to retrieve the copy details again to refresh our
956 # circ information to get the due date.
957 $details = $self->retrieve_copy_details_by_barcode($item_barcode);
958 $circ = $details->{circ};
959 my $due = DateTime::Format::ISO8601->parse_datetime(cleanse_ISO8601($circ->due_date()));
960 $due->set_time_zone('UTC');
961 $data->{DateDue} = $due->iso8601();
963 $response->data($data);
966 # At some point in the future, we should probably check if
967 # they requested optional user or item elements and return
968 # those. For the time being, we ignore those at the risk of
969 # being considered non-compliant.
976 $response = $ils->requestitem($request);
978 Handle the NCIP RequestItem message.
985 # Check our session and login if necessary:
986 $self->login() unless ($self->checkauth());
989 my $message = $self->parse_request_type($request);
990 my $response = NCIP::Response->new({type => $message . 'Response'});
991 $response->header($self->make_header($request));
993 # Because we need to have a user to place a hold, because the user
994 # is likely to have problems, and because getting the item
995 # information for the hold is trickier than getting the user
996 # information, we'll do the user first and short circuit out of
997 # the function if there is a problem with the user.
998 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
999 if (ref($user_barcode) eq 'NCIP::Problem') {
1000 $response->problem($user_barcode);
1003 my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
1004 if (ref($user) eq 'NCIP::Problem') {
1005 $response->problem($user);
1008 my $problem = $self->check_user_for_problems($user, 'HOLD');
1010 $response->problem($problem);
1014 # RequestItem is a blast. We need to check if we have a copy
1015 # barcode and/or if we have BibliographicIds. If we have both or
1016 # either, we then need to figure out what we're placing the hold
1017 # on, a copy, a volume or a bib. We don't currently do part holds,
1018 # but maybe we should some day. We can also be sent more than 1
1019 # BibliographicId, so we look for certain identifiers first, and
1020 # then others in decreasing preference: SYSNUMBER, ISBN, and ISSN.
1022 # Not to mention that there are two kinds of BibliographicId field
1023 # with different field names, and both can be intermixed in an
1024 # incoming message! (I just /love/ this nonsense.)
1026 # This here is the thing we're going to put on hold:
1029 # We need the copy barcode from the message.
1030 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
1031 if (ref($item_barcode) ne 'NCIP::Problem') {
1032 # Retrieve the copy details.
1033 my $copy_details = $self->retrieve_copy_details_by_barcode($item_barcode);
1034 unless ($copy_details) {
1035 # Return an Unknown Item problem unless we find the copy.
1039 ProblemType => 'Unknown Item',
1040 ProblemDetail => "Item with barcode $item_barcode is not known.",
1041 ProblemElement => $item_idfield,
1042 ProblemValue => $item_barcode
1048 $item = $copy_details->{volume}; # We place a volume hold.
1051 # We weren't given copy information to target, or we can't find
1052 # it, so we need to look for a target via BibliographicId.
1054 my @biblio_ids = $self->find_bibliographic_ids($request);
1056 $item = $self->find_target_via_bibliographic_id(@biblio_ids);
1060 # If we don't have an item, then blow up with a problem that may
1061 # have been set when we went looking for the ItemId.
1063 if (ref($item_barcode) eq 'NCIP::Problem') {
1064 $response->problem($item_barcode);
1069 ProblemType => 'Request Item Not Found',
1070 ProblemDetail => 'Unable to determine the item to request from input message.',
1071 ProblemElement => 'NULL',
1072 ProblemValue => 'NULL'
1078 } elsif (ref($item) eq 'NCIP::Problem') {
1079 $response->problem($item);
1083 # See if we were given a PickupLocation.
1085 if ($request->{$message}->{PickupLocation}) {
1086 my $loc = $request->{$message}->{PickupLocation};
1087 $loc =~ s/^.*://; # strip everything up to the last
1088 # semi-colon, if any.
1089 $location = $self->retrieve_org_unit_by_shortname($loc);
1092 # Look for a NeedBeforeDate to use as expiration...
1093 my $hold_expiration = $request->{$message}->{NeedBeforeDate};
1096 my $hold = $self->place_hold($item, $user, $location, $hold_expiration);
1097 if (ref($hold) eq 'NCIP::Problem') {
1098 $response->problem($hold);
1101 RequestId => NCIP::RequestId->new(
1102 RequestIdentifierType => 'SYSNUMBER',
1103 RequestIdentifierValue => $hold->id()
1105 UserId => NCIP::User::Id->new(
1107 UserIdentifierType => 'Barcode Id',
1108 UserIdentifierValue => $user->card->barcode()
1111 RequestType => $request->{$message}->{RequestType},
1112 RequestScopeType => ($hold->hold_type() eq 'V') ? "item" : "bibliographic item"
1114 $response->data($data);
1120 =head2 cancelrequestitem
1122 $response = $ils->cancelrequestitem($request);
1124 Handle the NCIP CancelRequestItem message.
1128 sub cancelrequestitem {
1130 my $request = shift;
1131 # Check our session and login if necessary:
1132 $self->login() unless ($self->checkauth());
1135 my $message = $self->parse_request_type($request);
1136 my $response = NCIP::Response->new({type => $message . 'Response'});
1137 $response->header($self->make_header($request));
1139 # UserId is required by the standard, but we might not really need it.
1140 my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
1141 if (ref($user_barcode) eq 'NCIP::Problem') {
1142 $response->problem($user_barcode);
1145 my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
1146 if (ref($user) eq 'NCIP::Problem') {
1147 $response->problem($user);
1151 # See if we got a ItemId and a barcode:
1153 my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
1154 if (ref($item_barcode) ne 'NCIP::Problem') {
1155 # Retrieve the copy details.
1156 $copy_details = $self->retrieve_copy_details_by_barcode($item_barcode);
1157 unless ($copy_details) {
1158 # Return an Unknown Item problem unless we find the copy.
1162 ProblemType => 'Unknown Item',
1163 ProblemDetail => "Item with barcode $item_barcode is not known.",
1164 ProblemElement => $item_idfield,
1165 ProblemValue => $item_barcode
1173 # See if we got a RequestId:
1175 if ($request->{$message}->{RequestId}) {
1176 $requestid = NCIP::RequestId->new(
1178 AgencyId => $request->{$message}->{RequestId}->{AgencyId},
1179 RequestIdentifierType => $request->{$message}->{RequestId}->{RequestIdentifierType},
1180 RequestIdentifierValue => $request->{$message}->{RequestId}->{RequestIdentifierValue}
1185 # Just a note: In the below, we cannot rely on the hold or transit
1186 # fields of the copy_details, even if we have retrieved it. This
1187 # is because that hold and transit may not be the ones that we're
1188 # looking for, i.e. they could be for another patron, etc.
1190 # See if we can find the hold:
1193 $hold = $U->simplereq(
1195 'open-ils.pcrud.retrieve.ahr',
1196 $self->{session}->{authtoken},
1197 $requestid->{RequestIdentifierValue},
1198 {flesh => 1, flesh_fields => {ahr => ['transit']}}
1201 # Report a problem that we couldn't find a hold by that id.
1205 ProblemType => 'Unknown Request',
1206 ProblemDetail => 'No request with this identifier found',
1207 ProblemElement => 'RequestIdentifierValue',
1208 ProblemValue => $requestid->{RequestIdentifierValue}
1212 } elsif ($hold->cancel_time()) {
1216 ProblemType => 'Request Already Canceled',
1217 ProblemDetail => 'Request has already been canceled',
1218 ProblemElement => 'RequestIdentifierValue',
1219 ProblemValue => $requestid->{RequestIdentifierValue}
1223 } elsif ($hold->transit()) {
1227 ProblemType => 'Request Already Processed',
1228 ProblemDetail => 'Request has already been processed',
1229 ProblemElement => 'RequestIdentifierValue',
1230 ProblemValue => $requestid->{RequestIdentifierValue}
1234 } elsif ($hold->usr() == $user->id()) {
1235 # Check the target matches the copy information, if any,
1236 # that we were given.
1238 if ($copy_details) {
1239 if ($hold->hold_type() eq 'V') {
1240 $obj_id = $copy_details->{volume}->id();
1241 } elsif ($hold->hold_type() eq 'T') {
1242 $obj_id = $copy_details->{mvr}->doc_id();
1243 } elsif ($hold->hold_type() eq 'C' || $hold->hold_type() eq 'F') {
1244 $obj_id = $copy_details->{copy}->id();
1247 if ($obj_id && $hold->target() != $obj_id) {
1251 ProblemType => 'Request Not For This Item',
1252 ProblemDetail => "Request is not for this item",
1253 ProblemElement => $item_idfield,
1254 ProblemElement => $item_barcode
1259 $self->cancel_hold($hold);
1262 RequestId => $requestid,
1263 UserId => NCIP::User::Id->new(
1265 UserIdentifierType => 'Barcode Id',
1266 UserIdentifierValue => $user->card->barcode()
1273 # Report a problem that the hold is not for this user.
1277 ProblemType => 'Request Not For This User',
1278 ProblemDetail => 'Request is not for this user.',
1279 ProblemElement => $user_idfield,
1280 ProblemValue => $user_barcode
1286 # At this point, we *must have* an ItemId and therefore
1287 # $copy_details, so return the problem from looking up the
1288 # barcode if we don't have $copy_details.
1289 if (!$copy_details) {
1290 $response->problem($item_barcode);
1292 # We have to search for the hold based on the copy details and
1293 # the user. We'll need to search for copy (or force) holds, a
1294 # volume hold, or a title hold.
1295 $hold = $self->_hold_search($user, $copy_details);
1296 if ($hold && $hold->transit()) {
1300 ProblemType => 'Request Already Processed',
1301 ProblemDetail => 'Request has already been processed',
1302 ProblemElement => 'RequestIdentifierValue',
1303 ProblemValue => $requestid->{RequestIdentifierValue}
1308 $self->cancel_hold($hold);
1311 RequestId => NCIP::RequestId->new(
1313 RequestIdentifierType => 'SYSNUMBER',
1314 RequestIdentifierValue => $hold->id()
1317 UserId => NCIP::User::Id->new(
1319 UserIdentifierType => 'Barcode Id',
1320 UserIdentifierValue => $user->card->barcode()
1329 ProblemType => 'Unknown Request',
1330 ProblemDetail => 'No request found for the item and user',
1331 ProblemElement => 'NULL',
1332 ProblemValue => 'NULL'
1343 =head1 METHODS USEFUL to SUBCLASSES
1349 Login to Evergreen via OpenSRF. It uses internal state from the
1350 configuration file to login.
1354 # Login via OpenSRF to Evergreen.
1358 # Get the authentication seed.
1359 my $seed = $U->simplereq(
1361 'open-ils.auth.authenticate.init',
1362 $self->{config}->{credentials}->{username}
1367 my $response = $U->simplereq(
1369 'open-ils.auth.authenticate.complete',
1371 username => $self->{config}->{credentials}->{username},
1372 password => md5_hex(
1373 $seed . md5_hex($self->{config}->{credentials}->{password})
1376 workstation => $self->{config}->{credentials}->{workstation}
1380 $self->{session}->{authtoken} = $response->{payload}->{authtoken};
1381 $self->{session}->{authtime} = $response->{payload}->{authtime};
1383 # Set/reset the work_ou and user data in case something changed.
1385 # Retrieve the work_ou as an object.
1386 $self->{session}->{work_ou} = $U->simplereq(
1388 'open-ils.pcrud.search.aou',
1389 $self->{session}->{authtoken},
1390 {shortname => $self->{config}->{credentials}->{work_ou}}
1393 # We need the user information in order to do some things.
1394 $self->{session}->{user} = $U->check_user_session($self->{session}->{authtoken});
1402 $valid = $ils->checkauth();
1404 Returns 1 if the object a 'valid' authtoken, 0 if not.
1411 # We use AppUtils to do the heavy lifting.
1412 if (defined($self->{session})) {
1413 if ($U->check_user_session($self->{session}->{authtoken})) {
1420 # If we reach here, we don't have a session, so we are definitely
1425 =head2 retrieve_user_by_barcode
1427 $user = $ils->retrieve_user_by_barcode($user_barcode, $user_idfield);
1429 Do a fleshed retrieve of a patron by barcode. Return the patron if
1430 found and valid. Return a NCIP::Problem of 'Unknown User' otherwise.
1432 The id field argument is used for the ProblemElement field in the
1433 NCIP::Problem object.
1435 An invalid patron is one where the barcode is not found in the
1436 database, the patron is deleted, or the barcode used to retrieve the
1437 patron is not active. The problem element is also returned if an error
1438 occurs during the retrieval.
1442 sub retrieve_user_by_barcode {
1443 my ($self, $barcode, $idfield) = @_;
1444 my $result = $U->simplereq(
1446 'open-ils.actor.user.fleshed.retrieve_by_barcode',
1447 $self->{session}->{authtoken},
1452 # Check for a failure, or a deleted, inactive, or expired user,
1453 # and if so, return empty userdata.
1454 if (!$result || $U->event_code($result) || $U->is_true($result->deleted())
1455 || !grep {$_->barcode() eq $barcode && $U->is_true($_->active())} @{$result->cards()}) {
1457 my $problem = NCIP::Problem->new();
1458 $problem->ProblemType('Unknown User');
1459 $problem->ProblemDetail("User with barcode $barcode unknown");
1460 $problem->ProblemElement($idfield);
1461 $problem->ProblemValue($barcode);
1468 =head2 retrieve_user_by_id
1470 $user = $ils->retrieve_user_by_id($id);
1472 Similar to C<retrieve_user_by_barcode> but takes the user's database
1473 id rather than barcode. This is useful when you have a circulation or
1474 hold and need to get information about the user's involved in the hold
1477 It returns a fleshed user on success or undef on failure.
1481 sub retrieve_user_by_id {
1482 my ($self, $id) = @_;
1484 # Do a fleshed retrieve of the patron, and flesh the fields that
1485 # we would normally use.
1486 my $result = $U->simplereq(
1488 'open-ils.actor.user.fleshed.retrieve',
1489 $self->{session}->{authtoken},
1491 [ 'card', 'cards', 'standing_penalties', 'addresses', 'home_ou' ]
1493 # Check for an error.
1494 undef($result) if ($result && $U->event_code($result));
1499 =head2 check_user_for_problems
1501 $problem = $ils>check_user_for_problems($user, 'HOLD, 'CIRC', 'RENEW');
1503 This function checks if a user has a blocked profile or any from a
1504 list of provided blocks. If it does, then a NCIP::Problem object is
1505 returned, otherwise an undefined value is returned.
1507 The list of blocks appears as additional arguments after the user. You
1508 can provide any value(s) that might appear in a standing penalty block
1509 lit in Evergreen. The example above checks for HOLD, CIRC, and
1510 RENEW. Any number of such values can be provided. If none are
1511 provided, the function only checks if the patron's profiles appears in
1512 the object's blocked profiles list.
1514 It stops on the first matching block, if any.
1518 sub check_user_for_problems {
1523 # Fill this in if we have a problem, otherwise just return it.
1526 # First, check the user's profile.
1527 if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
1528 $problem = NCIP::Problem->new(
1530 ProblemType => 'User Blocked',
1531 ProblemDetail => 'User blocked from inter-library loan',
1532 ProblemElement => 'NULL',
1533 ProblemValue => 'NULL'
1538 # Next, check if the patron has one of the indicated blocks.
1540 foreach my $block (@blocks) {
1541 if (grep {$_->standing_penalty->block_list() =~ /$block/} @{$user->standing_penalties()}) {
1542 $problem = NCIP::Problem->new(
1544 ProblemType => 'User Blocked',
1545 ProblemDetail => 'User blocked from ' .
1546 ($block eq 'HOLD') ? 'holds' : (($block eq 'RENEW') ? 'renewals' :
1547 (($block eq 'CIRC') ? 'checkout' : lc($block))),
1548 ProblemElement => 'NULL',
1549 ProblemValue => 'NULL'
1560 =head2 check_circ_details
1562 $problem = $ils->check_circ_details($circ, $copy, $user);
1564 Checks if we can checkin or renew a circulation. That is, the
1565 circulation is still open (i.e. the copy is still checked out), if we
1566 either own the copy or are the circulation location, and if the
1567 circulation is for the optional $user argument. $circ and $copy are
1568 required. $user is optional.
1570 Returns a problem if any of the above conditions fail. Returns undef
1571 if they pass and we can proceed with the checkin or renewal.
1573 If the failure occurred on the copy-related checks, then the
1574 ProblemElement field will be undefined and needs to be filled in with
1575 the item id field name. If the check for the copy being checked out to
1576 the provided user fails, then both ProblemElement and ProblemValue
1577 fields will be empty and need to be filled in by the caller.
1581 sub check_circ_details {
1582 my ($self, $circ, $copy, $user) = @_;
1584 # Shortcut for the next check.
1585 my $ou_id = $self->{session}->{work_ou}->id();
1587 if (!$circ || $circ->checkin_time() || ($circ->circ_lib() != $ou_id && $copy->circ_lib() != $ou_id)) {
1588 # Item isn't checked out.
1589 return NCIP::Problem->new(
1591 ProblemType => 'Item Not Checked Out',
1592 ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out.',
1593 ProblemValue => $copy->barcode()
1597 # Get data on the patron who has it checked out.
1598 my $circ_user = $self->retrieve_user_by_id($circ->usr());
1599 if ($user && $circ_user && $user->id() != $circ_user->id()) {
1600 # The ProblemElement and ProblemValue field need to be
1601 # filled in by the caller.
1602 return NCIP::Problem->new(
1604 ProblemType => 'Item Not Checked Out To This User',
1605 ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out to this user.',
1610 # If we get here, we're good to go.
1614 =head2 retrieve_copy_details_by_barcode
1616 $copy = $ils->retrieve_copy_details_by_barcode($copy_barcode);
1618 Look up and retrieve some copy details by the copy barcode. This
1619 method returns either a hashref with the copy details or undefined if
1620 no copy exists with that barcode or if some error occurs.
1622 The hashref has the fields copy, hold, transit, circ, volume, and mvr.
1624 This method differs from C<retrieve_user_by_barcode> in that a copy
1625 cannot be invalid if it exists and it is not always an error if no
1626 copy exists. In some cases, when handling AcceptItem, we might prefer
1627 there to be no copy.
1631 sub retrieve_copy_details_by_barcode {
1633 my $barcode = shift;
1635 my $copy = $U->simplereq(
1637 'open-ils.circ.copy_details.retrieve.barcode',
1638 $self->{session}->{authtoken},
1642 # If $copy is an event, return undefined.
1643 if ($copy && $U->event_code($copy)) {
1650 =head2 retrieve_org_unit_by_shortname
1652 $org_unit = $ils->retrieve_org_unit_by_shortname($shortname);
1654 Retrieves an org. unit from the database by shortname. Returns the
1655 org. unit as a Fieldmapper object or undefined.
1659 sub retrieve_org_unit_by_shortname {
1661 my $shortname = shift;
1663 my $aou = $U->simplereq(
1665 'open-ils.actor.org_unit.retrieve_by_shortname',
1672 =head2 retrieve_copy_location
1674 $location = $ils->retrieve_copy_location($location_id);
1676 Retrieve a copy location based on id.
1680 sub retrieve_copy_location {
1684 my $location = $U->simplereq(
1686 'open-ils.pcrud.retrieve.acpl',
1687 $self->{session}->{authtoken},
1694 =head2 retrieve_biblio_record_entry
1696 $bre = $ils->retrieve_biblio_record_entry($bre_id);
1698 Given a biblio.record_entry.id, this method retrieves a bre object.
1702 sub retrieve_biblio_record_entry {
1706 my $bre = $U->simplereq(
1708 'open-ils.pcrud.retrieve.bre',
1709 $self->{session}->{authtoken},
1716 =head2 create_precat_copy
1719 barcode => '312340123456789',
1720 author => 'Public, John Q.',
1721 title => 'Magnum Opus',
1722 call_number => '005.82',
1723 publisher => 'Brick House',
1724 publication_date => '2014'
1727 $item = $ils->create_precat_copy($item_info);
1730 Create a "precat" copy to use for the incoming item using a hashref of
1731 item information. At a minimum, the barcode, author and title fields
1732 need to be filled in. The other fields are ignored if provided.
1734 This method is called by the AcceptItem handler if the C<use_precats>
1735 configuration option is turned on.
1739 sub create_precat_copy {
1741 my $item_info = shift;
1743 my $item = Fieldmapper::asset::copy->new();
1744 $item->barcode($item_info->{barcode});
1745 $item->call_number(OILS_PRECAT_CALL_NUMBER);
1746 $item->dummy_title($item_info->{title});
1747 $item->dummy_author($item_info->{author});
1748 $item->circ_lib($self->{session}->{work_ou}->id());
1749 $item->circulate('t');
1750 $item->holdable('t');
1751 $item->opac_visible('f');
1752 $item->deleted('f');
1753 $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
1754 $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
1757 $item->editor($self->{session}->{user}->id());
1758 $item->creator($self->{session}->{user}->id());
1761 # Actually create it:
1763 my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
1766 $xact = $ses->request(
1767 'open-ils.pcrud.transaction.begin',
1768 $self->{session}->{authtoken}
1770 $item = $ses->request(
1771 'open-ils.pcrud.create.acp',
1772 $self->{session}->{authtoken},
1775 $xact = $ses->request(
1776 'open-ils.pcrud.transaction.commit',
1777 $self->{session}->{authtoken}
1785 'open-ils.pcrud.transaction.rollback',
1786 $self->{session}->{authtoken}
1796 =head2 create_fuller_copy
1799 barcode => '31234003456789',
1800 author => 'Public, John Q.',
1801 title => 'Magnum Opus',
1802 call_number => '005.82',
1803 publisher => 'Brick House',
1804 publication_date => '2014'
1807 $item = $ils->create_fuller_copy($item_info);
1809 Creates a skeletal bibliographic record, call number, and copy for the
1810 incoming item using a hashref with item information in it. At a
1811 minimum, the barcode, author, title, and call_number fields must be
1814 This method is used by the AcceptItem handler if the C<use_precats>
1815 configuration option is NOT set.
1819 sub create_fuller_copy {
1821 my $item_info = shift;
1825 # We do everything in one transaction, because it should be atomic.
1826 my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
1830 $xact = $ses->request(
1831 'open-ils.pcrud.transaction.begin',
1832 $self->{session}->{authtoken}
1839 # The rest depends on there being a transaction.
1842 # Create the MARC record.
1843 my $record = MARC::Record->new();
1844 $record->encoding('UTF-8');
1845 $record->leader('00881nam a2200193 4500');
1846 my $datespec = strftime("%Y%m%d%H%M%S.0", localtime);
1848 push(@fields, MARC::Field->new('005', $datespec));
1849 push(@fields, MARC::Field->new('082', '0', '4', 'a' => $item_info->{call_number}));
1850 push(@fields, MARC::Field->new('245', '0', '0', 'a' => $item_info->{title}));
1851 # Publisher is a little trickier:
1852 if ($item_info->{publisher}) {
1853 my $pub = MARC::Field->new('260', ' ', ' ', 'a' => '[S.l.]', 'b' => $item_info->{publisher});
1854 $pub->add_subfields('c' => $item_info->{publication_date}) if ($item_info->{publication_date});
1855 push(@fields, $pub);
1857 # We have no idea if the author is personal corporate or something else, so we use a 720.
1858 push(@fields, MARC::Field->new('720', ' ', ' ', 'a' => $item_info->{author}, '4' => 'aut'));
1859 $record->append_fields(@fields);
1860 my $marc = clean_marc($record);
1862 # Create the bib object.
1863 my $bib = Fieldmapper::biblio::record_entry->new();
1864 $bib->creator($self->{session}->{user}->id());
1865 $bib->editor($self->{session}->{user}->id());
1866 $bib->source($self->{bib_source}->id());
1873 $bib = $ses->request(
1874 'open-ils.pcrud.create.bre',
1875 $self->{session}->{authtoken},
1883 'open-ils.pcrud.transaction.rollback',
1884 $self->{session}->{authtoken}
1889 # Create the call number
1892 $acn = Fieldmapper::asset::call_number->new();
1893 $acn->creator($self->{session}->{user}->id());
1894 $acn->editor($self->{session}->{user}->id());
1895 $acn->label($item_info->{call_number});
1896 $acn->record($bib->id());
1897 $acn->owning_lib($self->{session}->{work_ou}->id());
1902 $acn = $ses->request(
1903 'open-ils.pcrud.create.acn',
1904 $self->{session}->{authtoken},
1912 'open-ils.pcrud.transaction.rollback',
1913 $self->{session}->{authtoken}
1921 $item = Fieldmapper::asset::copy->new();
1922 $item->barcode($item_info->{barcode});
1923 $item->call_number($acn->id());
1924 $item->circ_lib($self->{session}->{work_ou}->id);
1925 $item->circulate('t');
1926 if ($self->{config}->{items}->{use_force_holds}) {
1927 $item->holdable('f');
1929 $item->holdable('t');
1931 $item->opac_visible('f');
1932 $item->deleted('f');
1933 $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
1934 $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
1937 $item->editor($self->{session}->{user}->id);
1938 $item->creator($self->{session}->{user}->id);
1942 $item = $ses->request(
1943 'open-ils.pcrud.create.acp',
1944 $self->{session}->{authtoken},
1948 # Cross our fingers and commit the work.
1949 $xact = $ses->request(
1950 'open-ils.pcrud.transaction.commit',
1951 $self->{session}->{authtoken}
1958 'open-ils.pcrud.transaction.rollback',
1959 $self->{session}->{authtoken}
1960 )->gather(1) if ($xact);
1966 # We need to disconnect our session.
1969 # Now, we handle our asset stat_cat entries.
1971 # It would be nice to do these in the above transaction, but
1972 # pcrud does not support the ascecm object, yet.
1973 foreach my $entry (@{$self->{stat_cat_entries}}) {
1974 my $map = Fieldmapper::asset::stat_cat_entry_copy_map->new();
1976 $map->stat_cat($entry->stat_cat());
1977 $map->stat_cat_entry($entry->id());
1978 $map->owning_copy($item->id());
1979 # We don't really worry if it succeeds or not.
1982 'open-ils.circ.stat_cat.asset.copy_map.create',
1983 $self->{session}->{authtoken},
1994 $hold = $ils->place_hold($item, $user, $location, $expiration);
1996 This function places a hold on $item for $user for pickup at
1997 $location. If location is not provided or undefined, the user's home
1998 library is used as a fallback.
2000 The $expiration argument is optional and must be a properly formatted
2001 ISO date time. It will be used as the hold expire time, if
2002 provided. Otherwise the system default time will be used.
2004 $item can be a copy (asset::copy), volume (asset::call_number), or bib
2005 (biblio::record_entry). The appropriate hold type will be placed
2006 depending on the object.
2008 On success, the method returns the object representing the hold. On
2009 failure, a NCIP::Problem object, describing the failure, is returned.
2017 my $location = shift;
2018 my $expiration = shift;
2020 # If $location is undefined, use the user's home_ou, which should
2021 # have been fleshed when the user was retrieved.
2022 $location = $user->home_ou() unless ($location);
2024 # $hold is the hold. $params is for the is_possible check.
2025 my ($hold, $params);
2027 # Prep the hold with fields common to all hold types:
2028 $hold = Fieldmapper::action::hold_request->new();
2029 $hold->isnew(1); # Just to make sure.
2030 $hold->target($item->id());
2031 $hold->usr($user->id());
2032 $hold->pickup_lib($location->id());
2033 $hold->expire_time(cleanse_ISO8601($expiration)) if ($expiration);
2034 if (!$user->email()) {
2035 $hold->email_notify('f');
2036 $hold->phone_notify($user->day_phone()) if ($user->day_phone());
2038 $hold->email_notify('t');
2042 $params = { pickup_lib => $location->id(), patronid => $user->id() };
2044 if (ref($item) eq 'Fieldmapper::asset::copy') {
2045 my $type = ($self->{config}->{items}->{use_force_holds}) ? 'F' : 'C';
2046 $hold->hold_type($type);
2047 $hold->current_copy($item->id());
2048 $params->{hold_type} = $type;
2049 $params->{copy_id} = $item->id();
2050 } elsif (ref($item) eq 'Fieldmapper::asset::call_number') {
2051 $hold->hold_type('V');
2052 $params->{hold_type} = 'V';
2053 $params->{volume_id} = $item->id();
2054 } elsif (ref($item) eq 'Fieldmapper::biblio::record_entry') {
2055 $hold->hold_type('T');
2056 $params->{hold_type} = 'T';
2057 $params->{titleid} = $item->id();
2060 # Check for a duplicate hold:
2061 my $duplicate = $U->simplereq(
2063 'open-ils.pcrud.search.ahr',
2064 $self->{session}->{authtoken},
2066 hold_type => $hold->hold_type(),
2067 target => $hold->target(),
2068 usr => $hold->usr(),
2069 expire_time => {'>' => 'now'},
2070 cancel_time => undef,
2071 fulfillment_time => undef
2075 return NCIP::Problem->new(
2077 ProblemType => 'Duplicate Request',
2078 ProblemDetail => 'A request for this item already exists for this patron.',
2079 ProblemElement => 'NULL',
2080 ProblemValue => 'NULL'
2085 # Check if the hold is possible:
2086 my $r = $U->simplereq(
2088 'open-ils.circ.title_hold.is_possible',
2089 $self->{session}->{authtoken},
2093 if ($r->{success}) {
2094 $hold = $U->simplereq(
2096 'open-ils.circ.holds.create.override',
2097 $self->{session}->{authtoken},
2100 if (ref($hold) eq 'HASH') {
2101 $hold = _problem_from_event('Request Not Possible', $hold);
2103 } elsif ($r->{last_event}) {
2104 $hold = _problem_from_event('Request Not Possible', $r->{last_event});
2105 } elsif ($r->{textcode}) {
2106 $hold = _problem_from_event('Request Not Possible', $r);
2108 $hold = _problem_from_event('Request Not Possible');
2116 $ils->cancel_hold($hold);
2118 This method cancels the hold argument. It makes no checks on the hold,
2119 so if there are certain conditions that need to be fulfilled before
2120 the hold is canceled, then you must check them before calling this
2123 It returns undef on success or failure. If it fails, you've usually
2124 got bigger problems.
2132 my $r = $U->simplereq(
2134 'open-ils.circ.hold.cancel',
2135 $self->{session}->{authtoken},
2138 'Canceled via NCIPServer'
2146 $ils->delete_copy($copy);
2148 Deletes the copy, and if it is owned by our work_ou and not a precat,
2149 we also delete the volume and bib on which the copy depends.
2157 # Shortcut for ownership checks below.
2158 my $ou_id = $self->{session}->{work_ou}->id();
2160 # First, make sure the copy is not already deleted and we own it.
2161 return undef if ($U->is_true($copy->deleted()) || $copy->circ_lib() != $ou_id);
2163 # Indicate we want to delete the copy.
2164 $copy->isdeleted(1);
2166 # Delete the copy using a backend call that will delete the copy,
2167 # the call number, and bib when appropriate.
2168 my $result = $U->simplereq(
2170 'open-ils.cat.asset.copy.fleshed.batch.update.override',
2171 $self->{session}->{authtoken},
2175 # We are currently not checking for succes or failure of the
2176 # above. At some point, someone may want to.
2181 =head2 copy_can_circulate
2183 $can_circulate = $ils->copy_can_circulate($copy);
2185 Check if the copy's location and the copy itself allow
2186 circulation. Return true if they do, and false if they do not.
2190 sub copy_can_circulate {
2194 my $location = $copy->location();
2195 unless (ref($location)) {
2196 $location = $self->retrieve_copy_location($location);
2199 return ($U->is_true($copy->circulate()) && $U->is_true($location->circulate()));
2202 =head2 copy_can_fulfill
2204 $can_fulfill = $ils->copy_can_fulfill($copy);
2206 Check if the copy's location and the copy itself allow
2207 holds. Return true if they do, and false if they do not.
2211 sub copy_can_fulfill {
2215 my $location = $copy->location();
2216 unless (ref($location)) {
2217 $location = $self->retrieve_copy_location($location);
2220 return ($U->is_true($copy->holdable()) && $U->is_true($location->holdable()));
2223 =head1 OVERRIDDEN PARENT METHODS
2225 =head2 find_user_barcode
2227 We dangerously override our parent's C<find_user_barcode> to return
2228 either the $barcode or a Problem object. In list context the barcode
2229 or problem will be the first argument and the id field, if any, will
2230 be the second. We also add a second, optional, argument to indicate a
2231 default value for the id field in the event of a failure to find
2232 anything at all. (Perl lets us get away with this.)
2236 sub find_user_barcode {
2238 my $request = shift;
2239 my $default = shift;
2242 my $message = $self->parse_request_type($request);
2243 if ($message eq 'LookupUser') {
2244 $default = 'AuthenticationInputData';
2246 $default = 'UserIdentifierValue';
2250 my ($value, $idfield) = $self->SUPER::find_user_barcode($request);
2253 $idfield = $default unless ($idfield);
2254 $value = NCIP::Problem->new();
2255 $value->ProblemType('Needed Data Missing');
2256 $value->ProblemDetail('Cannot find user barcode in message.');
2257 $value->ProblemElement($idfield);
2258 $value->ProblemValue('NULL');
2261 return (wantarray) ? ($value, $idfield) : $value;
2264 =head2 find_item_barcode
2266 We do pretty much the same thing as with C<find_user_barcode> for
2267 C<find_item_barcode>.
2271 sub find_item_barcode {
2273 my $request = shift;
2274 my $default = shift || 'ItemIdentifierValue';
2276 my ($value, $idfield) = $self->SUPER::find_item_barcode($request);
2279 $idfield = $default unless ($idfield);
2280 $value = NCIP::Problem->new();
2281 $value->ProblemType('Needed Data Missing');
2282 $value->ProblemDetail('Cannot find item barcode in message.');
2283 $value->ProblemElement($idfield);
2284 $value->ProblemValue('NULL');
2287 return (wantarray) ? ($value, $idfield) : $value;
2290 =head2 find_target_via_bibliographic_id
2292 $item = $ils->find_target_via_bibliographic_id(@biblio_ids);
2294 Searches for a bibliographic record to put on hold and returns an
2295 appropriate hold target item depending upon what it finds. If an
2296 appropriate, single target cannot be found, it returns an
2297 NCIP::Problem with the problem message.
2299 Currently, we only look for SYSNUMBER, ISBN, and ISSN record
2300 identifiers. If nothing is found, this method can return undef. (Gotta
2301 love Perl and untyped/weakly typed languages in general!)
2303 TODO: Figure out how to search OCLC numbers. We probably need to use
2304 "MARC Expert Search" if we don't want to do a JSON query on
2309 sub find_target_via_bibliographid_id {
2311 my @biblio_ids = @_;
2313 # The item that we find:
2316 # Id for our bib in Evergreen:
2319 # First, let's look for a SYSNUMBER:
2321 { $_->{BibligraphicRecordIdentifierCode} eq 'SYSNUMBER' || $_->{BibliographicItemIdentifierCode} eq 'SYSNUMBER'
2326 # BibliographicRecordId can have an AgencyId field if the
2327 # BibliographicRecordIdentifierCode is absent.
2328 if ($idobj->{AgencyId}) {
2329 $bibid = $idobj->{BibliographicRecordIdentifier};
2330 my $locname = $idobj->{AgencyId};
2332 $locname =~ s/.*://;
2333 $loc = $self->retrieve_org_unit_by_shortname($locname);
2335 } elsif ($idobj->{BibliographicRecordIdentifierCode}) {
2336 $bibid = $idobj->{BibliographicRecordIdentifierCode}
2338 $bibid = $idobj->{BibliographicItemIdentifierCode}
2340 if ($bibid && $loc) {
2341 $item = $self->_call_number_search($bibid, $loc);
2343 $item = $U->simplereq(
2345 'open-ils.pcrud.retrieve.bre',
2346 $self->{session}->{authtoken},
2350 # Check if item is deleted so we'll look for more
2352 undef($item) if ($item && $U->is_true($item->deleted()));
2355 # Build an array of id objects based on the other identifier fields.
2358 $_->{BibliographicRecordIdentifierCode} eq 'ISBN' || $_->{BibliographicItemIdentifierCode} eq 'ISBN'
2360 $_->{BibliographicRecordIdentifierCode} eq 'ISSN' || $_->{BibliographicItemIdentifierCode} eq 'ISSN'
2364 my $stashed_problem;
2365 # Reuse $idobj from above.
2366 foreach $idobj (@idobjs) {
2367 my ($idvalue, $idtype, $idfield);
2368 if ($_->{BibliographicItemIdentifier}) {
2369 $idvalue = $_->{BibliographicItemIdentifier};
2370 $idtype = $_->{BibliographicItemIdentifierCode};
2371 $idfield = 'BibliographicItemIdentifier';
2373 $idvalue = $_->{BibliographicRecordIdentifier};
2374 $idtype = $_->{BibliographicRecordIdentifierCode};
2375 $idfield = 'BibliographicRecordIdentifier';
2377 $item = $self->_bib_search($idvalue, $idtype);
2378 if (ref($item) eq 'NCIP::Problem') {
2379 $stashed_problem = $item unless($stashed_problem);
2380 $stashed_problem->ProblemElement($idfield);
2385 $item = $stashed_problem if (!$item && $stashed_problem);
2391 # private subroutines not meant to be used directly by subclasses.
2392 # Most have to do with setup and/or state checking of implementation
2395 # Find, load, and parse our configuration file:
2399 # Find the configuration file via variables:
2400 my $file = OILS_NCIP_CONFIG_DEFAULT;
2401 $file = $ENV{OILS_NCIP_CONFIG} if ($ENV{OILS_NCIP_CONFIG});
2403 $self->{config} = XMLin($file, NormaliseSpace => 2,
2404 ForceArray => ['block_profile', 'stat_cat_entry']);
2407 # Bootstrap OpenSRF::System and load the IDL.
2411 my $bootstrap_config = $self->{config}->{bootstrap};
2412 OpenSRF::System->bootstrap_client(config_file => $bootstrap_config);
2414 my $idl = OpenSRF::Utils::SettingsClient->new->config_value("IDL");
2415 Fieldmapper->import(IDL => $idl);
2418 # Login and then initialize some object data based on the
2423 # Login to Evergreen.
2426 # Load the barred groups as pgt objects into a blocked_profiles
2428 $self->{blocked_profiles} = [];
2429 foreach (@{$self->{config}->{patrons}->{block_profile}}) {
2432 $pgt = $U->simplereq(
2434 'open-ils.pcrud.retrieve.pgt',
2435 $self->{session}->{authtoken},
2439 $pgt = $U->simplereq(
2441 'open-ils.pcrud.search.pgt',
2442 $self->{session}->{authtoken},
2446 push(@{$self->{blocked_profiles}}, $pgt) if ($pgt);
2449 # Load the bib source if we're not using precats.
2450 unless ($self->{config}->{items}->{use_precats}) {
2451 # Retrieve the default
2452 $self->{bib_source} = $U->simplereq(
2454 'open-ils.pcrud.retrieve.cbs',
2455 $self->{session}->{authtoken},
2456 BIB_SOURCE_DEFAULT);
2457 my $data = $self->{config}->{items}->{bib_source};
2459 $data = $data->[0] if (ref($data) eq 'ARRAY');
2462 $result = $U->simplereq(
2464 'open-ils.pcrud.retrieve.cbs',
2465 $self->{session}->{authtoken},
2469 $result = $U->simplereq(
2471 'open-ils.pcrud.search.cbs',
2472 $self->{session}->{authtoken},
2476 $self->{bib_source} = $result if ($result);
2480 # Load the required asset.stat_cat_entries:
2481 $self->{stat_cat_entries} = [];
2482 # First, make a regex for our ou and ancestors:
2483 my $ancestors = join("|", @{$U->get_org_ancestors($self->{session}->{work_ou}->id())});
2484 my $re = qr/(?:$ancestors)/;
2485 # Get the uniq stat_cat ids from the configuration:
2486 my @cats = uniq map {$_->{stat_cat}} @{$self->{config}->{items}->{stat_cat_entry}};
2487 # Retrieve all of the fleshed stat_cats and entries for the above.
2488 my $stat_cats = $U->simplereq(
2490 'open-ils.circ.stat_cat.asset.retrieve.batch',
2491 $self->{session}->{authtoken},
2494 foreach my $entry (@{$self->{config}->{items}->{stat_cat_entry}}) {
2495 # Must have the stat_cat attr and the name, so we must have a
2497 next unless(ref $entry);
2498 my ($stat) = grep {$_->id() == $entry->{stat_cat}} @$stat_cats;
2499 push(@{$self->{stat_cat_entries}}, grep {$_->owner() =~ $re && $_->value() eq $entry->{content}} @{$stat->entries()});
2503 # Search asset.call_number by a bre.id and location object. Return the
2504 # "closest" call_number if found, undef otherwise.
2505 sub _call_number_search {
2508 my $location = shift;
2510 # At some point, this should be smarter, and we should retrieve
2511 # ancestors and descendants and search with a JSON query or some
2512 # such with results ordered by proximity to the original location,
2513 # but I don't have time to implement that right now.
2514 my $acn = $U->simplereq(
2516 'open-ils.pcrud.search.acn',
2517 $self->{session}->{authtoken},
2518 {record => $bibid, owning_lib => $location->id()}
2524 # Do a multiclass.query to search for items by isbn or issn.
2527 my $idvalue = shift;
2531 my $result = $U->simplereq(
2533 'open-ils.search.biblio.multiclass',
2534 {searches => {lc($idtype) => $idvalue}}
2537 if ($result && $result->{count}) {
2538 if ($result->{count} > 1) {
2539 $item = NCIP::Problem->new(
2541 ProblemType => 'Non-Unique Item',
2542 ProblemDetail => 'More than one item matches the request.',
2543 ProblemElement => '',
2544 ProblemValue => $idvalue
2548 my $bibid = $result->{ids}->[0]->[0];
2549 $item = $U->simplereq(
2551 'open-ils.pcrud.retrieve.bre',
2552 $self->{session}->{authtoken},
2560 # Search for holds using the user and copy_details information:
2564 my $copy_details = shift;
2568 # Retrieve all of the user's active holds, and then search them in Perl.
2569 my $holds_list = $U->simplereq(
2571 'open-ils.circ.holds.retrieve',
2572 $self->{session}->{authtoken},
2577 if ($holds_list && @$holds_list) {
2579 # Look for title holds (the most common), first:
2580 my $targetid = $copy_details->{mvr}->doc_id();
2581 @holds = grep {$_->hold_type eq 'T' && $_->target == $targetid} @{$holds_list};
2583 # Look for volume holds, the next most common:
2584 $targetid = $copy_details->{volume}->id();
2585 @holds = grep {$_->hold_type eq 'V' && $_->target == $targetid} @{$holds_list};
2588 # Look for copy and force holds, the least likely.
2589 $targetid = $copy_details->{copy}->id();
2590 @holds = grep {($_->hold_type eq 'C' || $_->hold_type eq 'F') && $_->target == $targetid} @{$holds_list};
2592 # There should only be 1, at this point, if there are any.
2601 # Standalone, "helper" functions. These do not take an object or
2604 # Check if a user is past their expiration date.
2609 # Users might not expire. If so, they have no expire_date.
2610 if ($user->expire_date()) {
2611 my $expires = DateTime::Format::ISO8601->parse_datetime(
2612 cleanse_ISO8601($user->expire_date())
2614 my $now = DateTime->now()->epoch();
2615 $expired = $now > $expires;
2621 # Creates a NCIP Problem from an event. Takes a string for the problem
2622 # type, the event hashref (or a string to use for the detail), and
2623 # optional arguments for the ProblemElement and ProblemValue fields.
2624 sub _problem_from_event {
2625 my ($type, $evt, $element, $value) = @_;
2631 my ($textcode, $desc);
2633 # Get the textcode, if available. Otherwise, use the ilsevent
2634 # "id," if available.
2635 if ($evt->{textcode}) {
2636 $textcode = $evt->{textcode};
2637 } elsif ($evt->{ilsevent}) {
2638 $textcode = $evt->{ilsevent};
2641 # Get the description. We favor translated descriptions over
2642 # the English in ils_events.xml.
2644 $desc = $evt->{desc};
2647 # Check if $type was set. As an "undocumented" feature, you
2648 # can pass undef, and we'll use the textcode from the event.
2655 # Set the detail from some combination of the above.
2658 } elsif ($textcode eq 'PERM_FAILURE') {
2659 if ($evt->{ilsperm}) {
2660 $detail = "Permission denied: " . $evt->{ilsperm};
2661 $detail =~ s/\.override$//;
2663 } elsif ($textcode) {
2664 $detail = "ILS returned $textcode error.";
2666 $detail = 'Detail not available.';
2673 return NCIP::Problem->new(
2675 ProblemType => ($type) ? $type : 'Temporary Processing Failure',
2676 ProblemDetail => ($detail) ? $detail : 'Detail not available.',
2677 ProblemElement => ($element) ? $element : 'NULL',
2678 ProblemValue => ($value) ? $value : 'NULL'