6bba61d45c55682fb93f7b64fdd6ea641b4aa4b0
[working/NCIPServer.git] / lib / NCIP / ILS / Evergreen.pm
1 # ---------------------------------------------------------------
2 # Copyright © 2014 Jason J.A. Stephenson <jason@sigio.com>
3 #
4 # This file is part of NCIPServer.
5 #
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.
10 #
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.
15 #
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;
20
21 use Modern::Perl;
22 use XML::LibXML::Simple qw(XMLin);
23 use DateTime;
24 use DateTime::Format::ISO8601;
25 use Digest::MD5 qw/md5_hex/;
26 use OpenSRF::System;
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/;
34 use MARC::Record;
35 use MARC::Field;
36 use MARC::File::XML;
37 use List::MoreUtils qw/uniq/;
38 use POSIX qw/strftime/;
39
40 # We need a bunch of NCIP::* objects.
41 use NCIP::Response;
42 use NCIP::Problem;
43 use NCIP::User;
44 use NCIP::User::OptionalFields;
45 use NCIP::User::AddressInformation;
46 use NCIP::User::Id;
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;
53 use NCIP::RequestId;
54 use NCIP::Item::Id;
55
56 # Inherit from NCIP::ILS.
57 use parent qw(NCIP::ILS);
58
59 =head1 NAME
60
61 Evergreen - Evergreen driver for NCIPServer
62
63 =head1 SYNOPSIS
64
65     my $ils = NCIP::ILS::Evergreen->new(name => $config->{NCIP.ils.value});
66
67 =head1 DESCRIPTION
68
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.
72
73 =cut
74
75 # Default values we define for things that might be missing in our
76 # runtime environment or configuration file that absolutely must have
77 # values.
78 #
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.
82 #
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
87 # installation.
88 use constant {
89     OILS_NCIP_CONFIG_DEFAULT => '/openils/conf/oils_ncip.xml',
90     BIB_SOURCE_DEFAULT => 2
91 };
92
93 # A common Evergreen code shortcut to use AppUtils:
94 my $U = 'OpenILS::Application::AppUtils';
95
96 # The usual constructor:
97 sub new {
98     my $class = shift;
99     $class = ref($class) if (ref $class);
100
101     # Instantiate our parent with the rest of the arguments.  It
102     # creates a blessed hashref.
103     my $self = $class->SUPER::new(@_);
104
105     # Look for our configuration file, load, and parse it:
106     $self->_configure();
107
108     # Bootstrap OpenSRF and prepare some OpenILS components.
109     $self->_bootstrap();
110
111     # Initialize the rest of our internal state.
112     $self->_init();
113
114     return $self;
115 }
116
117 =head1 HANDLER METHODS
118
119 =head2 lookupuser
120
121     $ils->lookupuser($request);
122
123 Processes a LookupUser request.
124
125 =cut
126
127 sub lookupuser {
128     my $self = shift;
129     my $request = shift;
130
131     # Check our session and login if necessary.
132     $self->login() unless ($self->checkauth());
133
134     my $message_type = $self->parse_request_type($request);
135
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));
140
141     # Need to parse the request object to get the user barcode.
142     my ($barcode, $idfield) = $self->find_user_barcode($request);
143
144     # If we did not find a barcode, then report the problem.
145     if (ref($barcode) eq 'NCIP::Problem') {
146         $response->problem($barcode);
147         return $response;
148     }
149
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);
154         return $response;
155     }
156
157     # We got the information, so lets fill in our userdata.
158     my $userdata = NCIP::User->new();
159
160     # Make an array of the user's active barcodes.
161     my $ids = [];
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()
167             });
168             push(@$ids, $id);
169         }
170     }
171     $userdata->UserId($ids);
172
173     # Check if they requested any optional fields and return those.
174     my $elements = $request->{$message_type}->{UserElementType};
175     if ($elements) {
176         $elements = [$elements] unless (ref $elements eq 'ARRAY');
177         my $optionalfields = NCIP::User::OptionalFields->new();
178
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);
187         }
188
189         # Next, check for user address information.
190         if (grep {$_ eq 'User Address Information'} @$elements) {
191             my $addresses = [];
192
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;
206             }
207
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',
215                         Data=>$user->email()
216                     })
217                 );
218                 push @$addresses, $address;
219             }
220
221             $optionalfields->UserAddressInformation($addresses);
222         }
223
224         # Check for User Privilege.
225         if (grep {$_ eq 'User Privilege'} @$elements) {
226             # Get the user's group:
227             my $pgt = $U->simplereq(
228                 'open-ils.pcrud',
229                 'open-ils.pcrud.retrieve.pgt',
230                 $self->{session}->{authtoken},
231                 $user->profile()
232             );
233             if ($pgt) {
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());
239
240                 my $status = 'Active';
241                 if (_expired($user)) {
242                     $status = 'Expired';
243                 } elsif ($U->is_true($user->barred())) {
244                     $status = 'Barred';
245                 } elsif (!$U->is_true($user->active())) {
246                     $status = 'Inactive';
247                 }
248                 if ($status) {
249                     $privilege->UserPrivilegeStatus(
250                         NCIP::User::PrivilegeStatus->new({
251                             UserPrivilegeStatusType => $status
252                         })
253                     );
254                 }
255
256                 $optionalfields->UserPrivilege([$privilege]);
257             }
258         }
259
260         # Check for Block Or Trap.
261         if (grep {$_ eq 'Block Or Trap'} @$elements) {
262             my $blocks = [];
263
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;
270             }
271
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(
279                     'open-ils.pcrud',
280                     'open-ils.pcrud.retrieve.aou',
281                     $self->{session}->{authtoken},
282                     $penalty->org_unit()
283                 );
284
285                 # Block checkout.
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');
290                     push @$blocks, $bot;
291                     $have_circ = 1;
292                 }
293
294                 # Block holds.
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');
299                     push @$blocks, $bot;
300                     $have_hold = 1;
301                 }
302
303                 # Block renewals.
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');
308                     push @$blocks, $bot;
309                     $have_renew = 1;
310                 }
311
312                 # Stop after we report one of each, even if more
313                 # blocks remain.
314                 last if ($have_circ && $have_renew && $have_hold);
315             }
316
317             $optionalfields->BlockOrTrap($blocks);
318         }
319
320         $userdata->UserOptionalFields($optionalfields);
321     }
322
323     $response->data($userdata);
324
325     return $response;
326 }
327
328 =head2 acceptitem
329
330     $ils->acceptitem($request);
331
332 Processes an AcceptItem request.
333
334 =cut
335
336 sub acceptitem {
337     my $self = shift;
338     my $request = shift;
339
340     # Check our session and login if necessary.
341     $self->login() unless ($self->checkauth());
342
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));
347
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);
354             return $response;
355         }
356
357         # We need to find a patron barcode or we can't look anyone up
358         # to place a hold.
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);
362             return $response;
363         }
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);
368             return $response;
369         }
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');
374         if ($problem) {
375             $response->problem($problem);
376             return $response;
377         }
378
379         # Check if the item barcode already exists:
380         my $item = $self->retrieve_copy_details_by_barcode($item_barcode);
381         if ($item) {
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.
387             $response->problem(
388                 NCIP::Problem->new(
389                     {
390                         ProblemType => 'Duplicate Item',
391                         ProblemDetail => "Item with barcode $item_barcode already exists.",
392                         ProblemElement => $item_idfield,
393                         ProblemValue => $item_barcode
394                     }
395                 )
396             );
397             return $response;
398         }
399
400         # Now, we have to create our new copy and/or bib and call number.
401
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.
407         my $item_info = {
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}
416         };
417
418         if ($self->{config}->{items}->{use_precats}) {
419             # We only need to create a precat copy.
420             $item = $self->create_precat_copy($item_info);
421         } else {
422             # We have to create a "partial" bib record, a call number and a copy.
423             $item = $self->create_fuller_copy($item_info);
424         }
425
426         # If we failed to create the copy, report a problem.
427         unless ($item) {
428             $response->problem(
429                 {
430                     ProblemType => 'Temporary Processing Failure',
431                     ProblemDetail => 'Failed to create the item in the system',
432                     ProblemElement => $item_idfield,
433                     ProblemValue => $item_barcode
434                 }
435             );
436             return $response;
437         }
438
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
441         # instead.
442         my $location = $request->{$message}->{PickupLocation};
443         if ($location) {
444             $location = $self->retrieve_org_unit_by_shortname($location);
445         }
446
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);
452             return $response;
453         }
454
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
457         # but the barcode.
458         my $data = {};
459         $data->{RequestId} = NCIP::RequestId->new(
460             {
461                 AgencyId => $request->{$message}->{RequestId}->{AgencyId},
462                 RequestIdentifierType => $request->{$message}->{RequestId}->{RequestIdentifierType},
463                 RequestIdentifierValue => $request->{$message}->{RequestId}->{RequestIdentifierValue}
464             }
465         );
466         $data->{ItemId} = NCIP::Item::Id->new(
467             {
468                 AgencyId => $request->{$message}->{ItemId}->{AgencyId},
469                 ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
470                 ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
471             }
472         );
473         $response->data($data);
474
475     } else {
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);
482     }
483
484     return $response;
485 }
486
487 =head2 checkinitem
488
489     $response = $ils->checkinitem($request);
490
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.
494
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.
498
499 =cut
500
501 sub checkinitem {
502     my $self = shift;
503     my $request = shift;
504
505     # Check our session and login if necessary:
506     $self->login() unless ($self->checkauth());
507
508     # Common stuff:
509     my $message = $self->parse_request_type($request);
510     my $response = NCIP::Response->new({type => $message . 'Response'});
511     $response->header($self->make_header($request));
512
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);
517         return $response;
518     }
519
520     # Retrieve the copy details.
521     my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
522     unless ($details) {
523         # Return an Unknown Item problem unless we find the copy.
524         $response->problem(
525             NCIP::Problem->new(
526                 {
527                     ProblemType => 'Unknown Item',
528                     ProblemDetail => "Item with barcode $item_barcode is not known.",
529                     ProblemElement => $item_idfield,
530                     ProblemValue => $item_barcode
531                 }
532             )
533         );
534         return $response;
535     }
536
537     # Check if a UserId was provided. If so, this is the patron to
538     # whom the copy should be checked out.
539     my $user;
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);
547             return $response;
548         }
549     }
550
551     # Isolate the copy.
552     my $copy = $details->{copy};
553
554     # Look for a circulation and examine its information:
555     my $circ = $details->{circ};
556
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
560     # location.
561     my $problem = $self->check_circ_details($circ, $copy, $user);
562     if ($problem) {
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);
569         }
570         $response->problem($problem);
571         return $response;
572     }
573
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.
577     my $params = {
578         copy_barcode => $copy->barcode(),
579         force => 1,
580         noop => 1,
581         void_overdues => 1
582     };
583     my $result = $U->simplereq(
584         'open-ils.circ',
585         'open-ils.circ.checkin.override',
586         $self->{session}->{authtoken},
587         $params
588     );
589     if (ref($result) eq 'ARRAY') {
590         $result = $result->[0];
591     }
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());
599         my $data = {
600             ItemId => NCIP::Item::Id->new(
601                 {
602                     AgencyId => $request->{$message}->{ItemId}->{AgencyId},
603                     ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
604                     ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
605                 }
606             ),
607             UserId => NCIP::User::Id->new(
608                 {
609                     UserIdentifierType => 'Barcode Id',
610                     UserIdentifierValue => $circ_user->card->barcode()
611                 }
612             )
613         };
614
615         $response->data($data);
616
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.
621     } else {
622         $response->problem(_problem_from_event('Checkin Failed', $result));
623     }
624
625     return $response
626 }
627
628 =head2 renewitem
629
630     $response = $ils->renewitem($request);
631
632 Handle the RenewItem message.
633
634 =cut
635
636 sub renewitem {
637     my $self = shift;
638     my $request = shift;
639
640     # Check our session and login if necessary:
641     $self->login() unless ($self->checkauth());
642
643     # Common stuff:
644     my $message = $self->parse_request_type($request);
645     my $response = NCIP::Response->new({type => $message . 'Response'});
646     $response->header($self->make_header($request));
647
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);
652         return $response;
653     }
654
655     # Retrieve the copy details.
656     my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
657     unless ($details) {
658         # Return an Unknown Item problem unless we find the copy.
659         $response->problem(
660             NCIP::Problem->new(
661                 {
662                     ProblemType => 'Unknown Item',
663                     ProblemDetail => "Item with barcode $item_barcode is not known.",
664                     ProblemElement => $item_idfield,
665                     ProblemValue => $item_barcode
666                 }
667             )
668         );
669         return $response;
670     }
671
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);
676         return $response;
677     }
678     my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
679     if (ref($user) eq 'NCIP::Problem') {
680         $response->problem($user);
681         return $response;
682     }
683
684     # Isolate the copy.
685     my $copy = $details->{copy};
686
687     # Look for a circulation and examine its information:
688     my $circ = $details->{circ};
689
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
693     # location.
694     my $problem = $self->check_circ_details($circ, $copy, $user);
695     if ($problem) {
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);
702         }
703         $response->problem($problem);
704         return $response;
705     }
706
707     # Check if user is blocked from renewals:
708     $problem = $self->check_user_for_problems($user, 'RENEW');
709     if ($problem) {
710         # Replace the ProblemElement and ProblemValue fields.
711         $problem->ProblemElement($user_idfield);
712         $problem->ProblemValue($user_barcode);
713         $response->problem($problem);
714         return $response;
715     }
716
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(
722             'open-ils.pcrud',
723             'open-ils.pcrud.retrieve.crcd',
724             $self->{session}->{authtoken},
725             $rule
726         )->gather(1);
727     }
728     if ($rule->max_renewals() < 1) {
729         $response->problem(
730             NCIP::Problem->new(
731                 {
732                     ProblemType => 'Item Not Renewable',
733                     ProblemDetail => 'Item may not be renewed.',
734                     ProblemElement => $item_idfield,
735                     ProblemValue => $item_barcode
736                 }
737             )
738         );
739         return $response;
740     }
741
742     # Check if there are renewals remaining on the latest circ:
743     if ($circ->renewal_remaining() < 1) {
744         $response->problem(
745             NCIP::Problem->new(
746                 {
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
751                 }
752             )
753         );
754         return $response;
755     }
756
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
759     # details.
760     my $params = {
761         copy => $copy,
762         patron_id => $user->id(),
763         sip_renewal => 1
764     };
765     my $r = $U->simplereq(
766         'open-ils.circ',
767         'open-ils.circ.renew.override',
768         $self->{session}->{authtoken},
769         $params
770     )->gather(1);
771
772     # We only look at the first one, since more than one usually means
773     # failure.
774     if (ref($r) eq 'ARRAY') {
775         $r = $r->[0];
776     }
777     if ($r->{textcode} ne 'SUCCESS') {
778         $problem = _problem_from_event('Renewal Failed', $r);
779         $response->problem($problem);
780     } else {
781         my $data = {
782             ItemId => NCIP::Item::Id->new(
783                 {
784                     AgencyId => $request->{$message}->{ItemId}->{AgencyId},
785                     ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
786                     ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
787                 }
788             ),
789             UserId => NCIP::User::Id->new(
790                 {
791                     UserIdentifierType => 'Barcode Id',
792                     UserIdentifierValue => $user->card->barcode()
793                 }
794             )
795         };
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();
803
804         $response->data($data);
805     }
806
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.
811
812     return $response;
813 }
814
815 =head2 checkoutitem
816
817     $response = $ils->checkoutitem($request);
818
819 Handle the Checkoutitem message.
820
821 =cut
822
823 sub checkoutitem {
824     my $self = shift;
825     my $request = shift;
826
827     # Check our session and login if necessary:
828     $self->login() unless ($self->checkauth());
829
830     # Common stuff:
831     my $message = $self->parse_request_type($request);
832     my $response = NCIP::Response->new({type => $message . 'Response'});
833     $response->header($self->make_header($request));
834
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);
839         return $response;
840     }
841
842     # Retrieve the copy details.
843     my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
844     unless ($details) {
845         # Return an Unknown Item problem unless we find the copy.
846         $response->problem(
847             NCIP::Problem->new(
848                 {
849                     ProblemType => 'Unknown Item',
850                     ProblemDetail => "Item with barcode $item_barcode is not known.",
851                     ProblemElement => $item_idfield,
852                     ProblemValue => $item_barcode
853                 }
854             )
855         );
856         return $response;
857     }
858
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);
863         return $response;
864     }
865     my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
866     if (ref($user) eq 'NCIP::Problem') {
867         $response->problem($user);
868         return $response;
869     }
870
871     # Isolate the copy.
872     my $copy = $details->{copy};
873
874     # Check if the copy can circulate.
875     unless ($self->copy_can_circulate($copy)) {
876         $response->problem(
877             NCIP::Problem->new(
878                 {
879                     ProblemType => 'Item Does Not Circulate',
880                     ProblemDetail => "Item with barcode $item_barcode does not circulate.",
881                     ProblemElement => $item_idfield,
882                     ProblemValue => $item_barcode
883                 }
884             )
885         );
886         return $response;
887     }
888
889     # Look for a circulation and examine its information:
890     my $circ = $details->{circ};
891
892     # Check if the item is already checked out.
893     if ($circ && !$circ->checkin_time()) {
894         $response->problem(
895             NCIP::Problem->new(
896                 {
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
901                 }
902             )
903         );
904         return $response;
905     }
906
907     # Check if user is blocked from circulation:
908     my $problem = $self->check_user_for_problems($user, 'CIRC');
909     if ($problem) {
910         # Replace the ProblemElement and ProblemValue fields.
911         $problem->ProblemElement($user_idfield);
912         $problem->ProblemValue($user_barcode);
913         $response->problem($problem);
914         return $response;
915     }
916
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
919     # into details.
920     my $params = {
921         copy => $copy,
922         patron_id => $user->id(),
923     };
924     my $r = $U->simplereq(
925         'open-ils.circ',
926         'open-ils.circ.checkout.full.override',
927         $self->{session}->{authtoken},
928         $params
929     );
930
931     # We only look at the first one, since more than one usually means
932     # failure.
933     if (ref($r) eq 'ARRAY') {
934         $r = $r->[0];
935     }
936     if ($r->{textcode} ne 'SUCCESS') {
937         $problem = _problem_from_event('Check Out Failed', $r);
938         $response->problem($problem);
939     } else {
940         my $data = {
941             ItemId => NCIP::Item::Id->new(
942                 {
943                     AgencyId => $request->{$message}->{ItemId}->{AgencyId},
944                     ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
945                     ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
946                 }
947             ),
948             UserId => NCIP::User::Id->new(
949                 {
950                     UserIdentifierType => 'Barcode Id',
951                     UserIdentifierValue => $user->card->barcode()
952                 }
953             )
954         };
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();
962
963         $response->data($data);
964     }
965
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.
970
971     return $response;
972 }
973
974 =head2 requestitem
975
976     $response = $ils->requestitem($request);
977
978 Handle the NCIP RequestItem message.
979
980 =cut
981
982 sub requestitem {
983     my $self = shift;
984     my $request = shift;
985     # Check our session and login if necessary:
986     $self->login() unless ($self->checkauth());
987
988     # Common stuff:
989     my $message = $self->parse_request_type($request);
990     my $response = NCIP::Response->new({type => $message . 'Response'});
991     $response->header($self->make_header($request));
992
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);
1001         return $response;
1002     }
1003     my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
1004     if (ref($user) eq 'NCIP::Problem') {
1005         $response->problem($user);
1006         return $response;
1007     }
1008     my $problem = $self->check_user_for_problems($user, 'HOLD');
1009     if ($problem) {
1010         $response->problem($problem);
1011         return $response;
1012     }
1013
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.
1021
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.)
1025
1026     # This here is the thing we're going to put on hold:
1027     my $item;
1028
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.
1036             $response->problem(
1037                 NCIP::Problem->new(
1038                     {
1039                         ProblemType => 'Unknown Item',
1040                         ProblemDetail => "Item with barcode $item_barcode is not known.",
1041                         ProblemElement => $item_idfield,
1042                         ProblemValue => $item_barcode
1043                     }
1044                 )
1045             );
1046             return $response;
1047         }
1048         $item = $copy_details->{volume}; # We place a volume hold.
1049     }
1050
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.
1053     unless ($item) {
1054         my @biblio_ids = $self->find_bibliographic_ids($request);
1055         if (@biblio_ids) {
1056             $item = $self->find_target_via_bibliographic_id(@biblio_ids);
1057         }
1058     }
1059
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.
1062     unless ($item) {
1063         if (ref($item_barcode) eq 'NCIP::Problem') {
1064             $response->problem($item_barcode);
1065         } else {
1066             $response->problem(
1067                 NCIP::Problem->new(
1068                     {
1069                         ProblemType => 'Request Item Not Found',
1070                         ProblemDetail => 'Unable to determine the item to request from input message.',
1071                         ProblemElement => 'NULL',
1072                         ProblemValue => 'NULL'
1073                     }
1074                 )
1075             );
1076         }
1077         return $response;
1078     } elsif (ref($item) eq 'NCIP::Problem') {
1079         $response->problem($item);
1080         return $response;
1081     }
1082
1083     # See if we were given a PickupLocation.
1084     my $location;
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);
1090     }
1091
1092     # Place the hold.
1093     my $hold = $self->place_hold($item, $user, $location);
1094     if (ref($hold) eq 'NCIP::Problem') {
1095         $response->problem($hold);
1096     } else {
1097         my $data = {
1098             RequestId => NCIP::RequestId->new(
1099                 RequestIdentifierType => 'SYSNUMBER',
1100                 RequestIdentifierValue => $hold->id()
1101             ),
1102             UserId => NCIP::User::Id->new(
1103                 {
1104                     UserIdentifierType => 'Barcode Id',
1105                     UserIdentifierValue => $user->card->barcode()
1106                 }
1107             ),
1108             RequestType => $request->{$message}->{RequestType},
1109             RequestScopeType => ($hold->hold_type() eq 'V') ? "item" : "bibliographic item"
1110         };
1111         $response->data($data);
1112     }
1113
1114     return $response;
1115 }
1116
1117 =head2 cancelrequestitem
1118
1119     $response = $ils->cancelrequestitem($request);
1120
1121 Handle the NCIP CancelRequestItem message.
1122
1123 =cut
1124
1125 sub cancelrequestitem {
1126     my $self = shift;
1127     my $request = shift;
1128     # Check our session and login if necessary:
1129     $self->login() unless ($self->checkauth());
1130
1131     # Common stuff:
1132     my $message = $self->parse_request_type($request);
1133     my $response = NCIP::Response->new({type => $message . 'Response'});
1134     $response->header($self->make_header($request));
1135
1136     # UserId is required by the standard, but we might not really need it.
1137     my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
1138     if (ref($user_barcode) eq 'NCIP::Problem') {
1139         $response->problem($user_barcode);
1140         return $response;
1141     }
1142     my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
1143     if (ref($user) eq 'NCIP::Problem') {
1144         $response->problem($user);
1145         return $response;
1146     }
1147
1148     # See if we got a ItemId and a barcode:
1149     my $copy_details;
1150     my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
1151     if (ref($item_barcode) ne 'NCIP::Problem') {
1152         # Retrieve the copy details.
1153         $copy_details = $self->retrieve_copy_details_by_barcode($item_barcode);
1154         unless ($copy_details) {
1155             # Return an Unknown Item problem unless we find the copy.
1156             $response->problem(
1157                 NCIP::Problem->new(
1158                     {
1159                         ProblemType => 'Unknown Item',
1160                         ProblemDetail => "Item with barcode $item_barcode is not known.",
1161                         ProblemElement => $item_idfield,
1162                         ProblemValue => $item_barcode
1163                     }
1164                 )
1165             );
1166             return $response;
1167         }
1168     }
1169
1170     # See if we got a RequestId:
1171     my $requestid;
1172     if ($request->{$message}->{RequestId}) {
1173         $requestid = NCIP::RequestId->new(
1174             {
1175                 AgencyId => $request->{$message}->{RequestId}->{AgencyId},
1176                 RequestIdentifierType => $request->{$message}->{RequestId}->{RequestIdentifierType},
1177                 RequestIdentifierValue => $request->{$message}->{RequestId}->{RequestIdentifierValue}
1178             }
1179         )
1180     }
1181
1182     # Just a note: In the below, we cannot rely on the hold or transit
1183     # fields of the copy_details, even if we have retrieved it. This
1184     # is because that hold and transit may not be the ones that we're
1185     # looking for, i.e. they could be for another patron, etc.
1186
1187     # See if we can find the hold:
1188     my $hold;
1189     if ($requestid) {
1190         $hold = $U->simplereq(
1191             'open-ils.pcrud',
1192             'open-ils.pcrud.retrieve.ahr',
1193             $self->{session}->{authtoken},
1194             $requestid->{RequestIdentifierValue},
1195             {flesh => 1, flesh_fields => {ahr => ['transit']}}
1196         );
1197         unless ($hold) {
1198             # Report a problem that we couldn't find a hold by that id.
1199             $response->problem(
1200                 NCIP::Problem->new(
1201                     {
1202                         ProblemType => 'Unknown Request',
1203                         ProblemDetail => 'No request with this identifier found',
1204                         ProblemElement => 'RequestIdentifierValue',
1205                         ProblemValue => $requestid->{RequestIdentifierValue}
1206                     }
1207                 )
1208             )
1209         } elsif ($hold->cancel_time()) {
1210             $response->problem(
1211                 NCIP::Problem->new(
1212                     {
1213                         ProblemType => 'Request Already Canceled',
1214                         ProblemDetail => 'Request has already been canceled',
1215                         ProblemElement => 'RequestIdentifierValue',
1216                         ProblemValue => $requestid->{RequestIdentifierValue}
1217                     }
1218                 )
1219             )
1220         } elsif ($hold->transit()) {
1221             $response->problem(
1222                 NCIP::Problem->new(
1223                     {
1224                         ProblemType => 'Request Already Processed',
1225                         ProblemDetail => 'Request has already been processed',
1226                         ProblemElement => 'RequestIdentifierValue',
1227                         ProblemValue => $requestid->{RequestIdentifierValue}
1228                     }
1229                 )
1230             )
1231         } elsif ($hold->usr() == $user->id()) {
1232             # Check the target matches the copy information, if any,
1233             # that we were given.
1234             my $obj_id;
1235             if ($copy_details) {
1236                 if ($hold->hold_type() eq 'V') {
1237                     $obj_id = $copy_details->{volume}->id();
1238                 } elsif ($hold->hold_type() eq 'T') {
1239                     $obj_id = $copy_details->{mvr}->doc_id();
1240                 } elsif ($hold->hold_type() eq 'C' || $hold->hold_type() eq 'F') {
1241                     $obj_id = $copy_details->{copy}->id();
1242                 }
1243             }
1244             if ($obj_id && $hold->target() != $obj_id) {
1245                 $response->problem(
1246                     NCIP::Problem->new(
1247                         {
1248                             ProblemType => 'Request Not For This Item',
1249                             ProblemDetail => "Request is not for this item",
1250                             ProblemElement => $item_idfield,
1251                             ProblemElement => $item_barcode
1252                         }
1253                     )
1254                 )
1255             } else {
1256                 $self->cancel_hold($hold);
1257                 $response->data(
1258                     {
1259                         RequestId => $requestid,
1260                         UserId => NCIP::User::Id->new(
1261                             {
1262                                 UserIdentifierType => 'Barcode Id',
1263                                 UserIdentifierValue => $user->card->barcode()
1264                             }
1265                         )
1266                     }
1267                 )
1268             }
1269         } else {
1270             # Report a problem that the hold is not for this user.
1271             $response->problem(
1272                 NCIP::Problem->new(
1273                     {
1274                         ProblemType => 'Request Not For This User',
1275                         ProblemDetail => 'Request is not for this user.',
1276                         ProblemElement => $user_idfield,
1277                         ProblemValue => $user_barcode
1278                     }
1279                 )
1280             )
1281         }
1282     } else {
1283         # At this point, we *must have* an ItemId and therefore
1284         # $copy_details, so return the problem from looking up the
1285         # barcode if we don't have $copy_details.
1286         if (!$copy_details) {
1287             $response->problem($item_barcode);
1288         } else {
1289             # We have to search for the hold based on the copy details and
1290             # the user.  We'll need to search for copy (or force) holds, a
1291             # volume hold, or a title hold.
1292             $hold = $self->_hold_search($user, $copy_details);
1293             if ($hold && $hold->transit()) {
1294                 $response->problem(
1295                     NCIP::Problem->new(
1296                         {
1297                             ProblemType => 'Request Already Processed',
1298                             ProblemDetail => 'Request has already been processed',
1299                             ProblemElement => 'RequestIdentifierValue',
1300                             ProblemValue => $requestid->{RequestIdentifierValue}
1301                         }
1302                     )
1303                 )
1304             } elsif ($hold) {
1305                 $self->cancel_hold($hold);
1306                 $response->data(
1307                     {
1308                         RequestId => NCIP::RequestId->new(
1309                             {
1310                                 RequestIdentifierType => 'SYSNUMBER',
1311                                 RequestIdentifierValue => $hold->id()
1312                             }
1313                         ),
1314                         UserId => NCIP::User::Id->new(
1315                             {
1316                                 UserIdentifierType => 'Barcode Id',
1317                                 UserIdentifierValue => $user->card->barcode()
1318                             }
1319                         )
1320                     }
1321                 )
1322             } else {
1323                 $response->problem(
1324                     NCIP::Problem->new(
1325                         {
1326                             ProblemType => 'Unknown Request',
1327                             ProblemDetail => 'No request found for the item and user',
1328                             ProblemElement => 'NULL',
1329                             ProblemValue => 'NULL'
1330                         }
1331                     )
1332                 )
1333             }
1334         }
1335     }
1336
1337     return $response;
1338 }
1339
1340 =head1 METHODS USEFUL to SUBCLASSES
1341
1342 =head2 login
1343
1344     $ils->login();
1345
1346 Login to Evergreen via OpenSRF. It uses internal state from the
1347 configuration file to login.
1348
1349 =cut
1350
1351 # Login via OpenSRF to Evergreen.
1352 sub login {
1353     my $self = shift;
1354
1355     # Get the authentication seed.
1356     my $seed = $U->simplereq(
1357         'open-ils.auth',
1358         'open-ils.auth.authenticate.init',
1359         $self->{config}->{credentials}->{username}
1360     );
1361
1362     # Actually login.
1363     if ($seed) {
1364         my $response = $U->simplereq(
1365             'open-ils.auth',
1366             'open-ils.auth.authenticate.complete',
1367             {
1368                 username => $self->{config}->{credentials}->{username},
1369                 password => md5_hex(
1370                     $seed . md5_hex($self->{config}->{credentials}->{password})
1371                 ),
1372                 type => 'staff',
1373                 workstation => $self->{config}->{credentials}->{workstation}
1374             }
1375         );
1376         if ($response) {
1377             $self->{session}->{authtoken} = $response->{payload}->{authtoken};
1378             $self->{session}->{authtime} = $response->{payload}->{authtime};
1379
1380             # Set/reset the work_ou and user data in case something changed.
1381
1382             # Retrieve the work_ou as an object.
1383             $self->{session}->{work_ou} = $U->simplereq(
1384                 'open-ils.pcrud',
1385                 'open-ils.pcrud.search.aou',
1386                 $self->{session}->{authtoken},
1387                 {shortname => $self->{config}->{credentials}->{work_ou}}
1388             );
1389
1390             # We need the user information in order to do some things.
1391             $self->{session}->{user} = $U->check_user_session($self->{session}->{authtoken});
1392
1393         }
1394     }
1395 }
1396
1397 =head2 checkauth
1398
1399     $valid = $ils->checkauth();
1400
1401 Returns 1 if the object a 'valid' authtoken, 0 if not.
1402
1403 =cut
1404
1405 sub checkauth {
1406     my $self = shift;
1407
1408     # We use AppUtils to do the heavy lifting.
1409     if (defined($self->{session})) {
1410         if ($U->check_user_session($self->{session}->{authtoken})) {
1411             return 1;
1412         } else {
1413             return 0;
1414         }
1415     }
1416
1417     # If we reach here, we don't have a session, so we are definitely
1418     # not logged in.
1419     return 0;
1420 }
1421
1422 =head2 retrieve_user_by_barcode
1423
1424     $user = $ils->retrieve_user_by_barcode($user_barcode, $user_idfield);
1425
1426 Do a fleshed retrieve of a patron by barcode. Return the patron if
1427 found and valid. Return a NCIP::Problem of 'Unknown User' otherwise.
1428
1429 The id field argument is used for the ProblemElement field in the
1430 NCIP::Problem object.
1431
1432 An invalid patron is one where the barcode is not found in the
1433 database, the patron is deleted, or the barcode used to retrieve the
1434 patron is not active. The problem element is also returned if an error
1435 occurs during the retrieval.
1436
1437 =cut
1438
1439 sub retrieve_user_by_barcode {
1440     my ($self, $barcode, $idfield) = @_;
1441     my $result = $U->simplereq(
1442         'open-ils.actor',
1443         'open-ils.actor.user.fleshed.retrieve_by_barcode',
1444         $self->{session}->{authtoken},
1445         $barcode,
1446         1
1447     );
1448
1449     # Check for a failure, or a deleted, inactive, or expired user,
1450     # and if so, return empty userdata.
1451     if (!$result || $U->event_code($result) || $U->is_true($result->deleted())
1452             || !grep {$_->barcode() eq $barcode && $U->is_true($_->active())} @{$result->cards()}) {
1453
1454         my $problem = NCIP::Problem->new();
1455         $problem->ProblemType('Unknown User');
1456         $problem->ProblemDetail("User with barcode $barcode unknown");
1457         $problem->ProblemElement($idfield);
1458         $problem->ProblemValue($barcode);
1459         $result = $problem;
1460     }
1461
1462     return $result;
1463 }
1464
1465 =head2 retrieve_user_by_id
1466
1467     $user = $ils->retrieve_user_by_id($id);
1468
1469 Similar to C<retrieve_user_by_barcode> but takes the user's database
1470 id rather than barcode. This is useful when you have a circulation or
1471 hold and need to get information about the user's involved in the hold
1472 or circulaiton.
1473
1474 It returns a fleshed user on success or undef on failure.
1475
1476 =cut
1477
1478 sub retrieve_user_by_id {
1479     my ($self, $id) = @_;
1480
1481     # Do a fleshed retrieve of the patron, and flesh the fields that
1482     # we would normally use.
1483     my $result = $U->simplereq(
1484         'open-ils.actor',
1485         'open-ils.actor.user.fleshed.retrieve',
1486         $self->{session}->{authtoken},
1487         $id,
1488         [ 'card', 'cards', 'standing_penalties', 'addresses', 'home_ou' ]
1489     );
1490     # Check for an error.
1491     undef($result) if ($result && $U->event_code($result));
1492
1493     return $result;
1494 }
1495
1496 =head2 check_user_for_problems
1497
1498     $problem = $ils>check_user_for_problems($user, 'HOLD, 'CIRC', 'RENEW');
1499
1500 This function checks if a user has a blocked profile or any from a
1501 list of provided blocks. If it does, then a NCIP::Problem object is
1502 returned, otherwise an undefined value is returned.
1503
1504 The list of blocks appears as additional arguments after the user. You
1505 can provide any value(s) that might appear in a standing penalty block
1506 lit in Evergreen. The example above checks for HOLD, CIRC, and
1507 RENEW. Any number of such values can be provided. If none are
1508 provided, the function only checks if the patron's profiles appears in
1509 the object's blocked profiles list.
1510
1511 It stops on the first matching block, if any.
1512
1513 =cut
1514
1515 sub check_user_for_problems {
1516     my $self = shift;
1517     my $user = shift;
1518     my @blocks = @_;
1519
1520     # Fill this in if we have a problem, otherwise just return it.
1521     my $problem;
1522
1523     # First, check the user's profile.
1524     if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
1525         $problem = NCIP::Problem->new(
1526             {
1527                 ProblemType => 'User Blocked',
1528                 ProblemDetail => 'User blocked from inter-library loan',
1529                 ProblemElement => 'NULL',
1530                 ProblemValue => 'NULL'
1531             }
1532         );
1533     }
1534
1535     # Next, check if the patron has one of the indicated blocks.
1536     unless ($problem) {
1537         foreach my $block (@blocks) {
1538             if (grep {$_->standing_penalty->block_list() =~ /$block/} @{$user->standing_penalties()}) {
1539                 $problem = NCIP::Problem->new(
1540                     {
1541                         ProblemType => 'User Blocked',
1542                         ProblemDetail => 'User blocked from ' .
1543                             ($block eq 'HOLD') ? 'holds' : (($block eq 'RENEW') ? 'renewals' :
1544                                                                 (($block eq 'CIRC') ? 'checkout' : lc($block))),
1545                         ProblemElement => 'NULL',
1546                         ProblemValue => 'NULL'
1547                     }
1548                 );
1549                 last;
1550             }
1551         }
1552     }
1553
1554     return $problem;
1555 }
1556
1557 =head2 check_circ_details
1558
1559     $problem = $ils->check_circ_details($circ, $copy, $user);
1560
1561 Checks if we can checkin or renew a circulation. That is, the
1562 circulation is still open (i.e. the copy is still checked out), if we
1563 either own the copy or are the circulation location, and if the
1564 circulation is for the optional $user argument. $circ and $copy are
1565 required. $user is optional.
1566
1567 Returns a problem if any of the above conditions fail. Returns undef
1568 if they pass and we can proceed with the checkin or renewal.
1569
1570 If the failure occurred on the copy-related checks, then the
1571 ProblemElement field will be undefined and needs to be filled in with
1572 the item id field name. If the check for the copy being checked out to
1573 the provided user fails, then both ProblemElement and ProblemValue
1574 fields will be empty and need to be filled in by the caller.
1575
1576 =cut
1577
1578 sub check_circ_details {
1579     my ($self, $circ, $copy, $user) = @_;
1580
1581     # Shortcut for the next check.
1582     my $ou_id = $self->{session}->{work_ou}->id();
1583
1584     if (!$circ || $circ->checkin_time() || ($circ->circ_lib() != $ou_id && $copy->circ_lib() != $ou_id)) {
1585         # Item isn't checked out.
1586         return NCIP::Problem->new(
1587             {
1588                 ProblemType => 'Item Not Checked Out',
1589                 ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out.',
1590                 ProblemValue => $copy->barcode()
1591             }
1592         );
1593     } else {
1594         # Get data on the patron who has it checked out.
1595         my $circ_user = $self->retrieve_user_by_id($circ->usr());
1596         if ($user && $circ_user && $user->id() != $circ_user->id()) {
1597             # The ProblemElement and ProblemValue field need to be
1598             # filled in by the caller.
1599             return NCIP::Problem->new(
1600                 {
1601                     ProblemType => 'Item Not Checked Out To This User',
1602                     ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out to this user.',
1603                 }
1604             );
1605         }
1606     }
1607     # If we get here, we're good to go.
1608     return undef;
1609 }
1610
1611 =head2 retrieve_copy_details_by_barcode
1612
1613     $copy = $ils->retrieve_copy_details_by_barcode($copy_barcode);
1614
1615 Look up and retrieve some copy details by the copy barcode. This
1616 method returns either a hashref with the copy details or undefined if
1617 no copy exists with that barcode or if some error occurs.
1618
1619 The hashref has the fields copy, hold, transit, circ, volume, and mvr.
1620
1621 This method differs from C<retrieve_user_by_barcode> in that a copy
1622 cannot be invalid if it exists and it is not always an error if no
1623 copy exists. In some cases, when handling AcceptItem, we might prefer
1624 there to be no copy.
1625
1626 =cut
1627
1628 sub retrieve_copy_details_by_barcode {
1629     my $self = shift;
1630     my $barcode = shift;
1631
1632     my $copy = $U->simplereq(
1633         'open-ils.circ',
1634         'open-ils.circ.copy_details.retrieve.barcode',
1635         $self->{session}->{authtoken},
1636         $barcode
1637     );
1638
1639     # If $copy is an event, return undefined.
1640     if ($copy && $U->event_code($copy)) {
1641         undef($copy);
1642     }
1643
1644     return $copy;
1645 }
1646
1647 =head2 retrieve_org_unit_by_shortname
1648
1649     $org_unit = $ils->retrieve_org_unit_by_shortname($shortname);
1650
1651 Retrieves an org. unit from the database by shortname. Returns the
1652 org. unit as a Fieldmapper object or undefined.
1653
1654 =cut
1655
1656 sub retrieve_org_unit_by_shortname {
1657     my $self = shift;
1658     my $shortname = shift;
1659
1660     my $aou = $U->simplereq(
1661         'open-ils.actor',
1662         'open-ils.actor.org_unit.retrieve_by_shortname',
1663         $shortname
1664     );
1665
1666     return $aou;
1667 }
1668
1669 =head2 retrieve_copy_location
1670
1671     $location = $ils->retrieve_copy_location($location_id);
1672
1673 Retrieve a copy location based on id.
1674
1675 =cut
1676
1677 sub retrieve_copy_location {
1678     my $self = shift;
1679     my $id = shift;
1680
1681     my $location = $U->simplereq(
1682         'open-ils.pcrud',
1683         'open-ils.pcrud.retrieve.acpl',
1684         $self->{session}->{authtoken},
1685         $id
1686     );
1687
1688     return $location;
1689 }
1690
1691 =head2 retrieve_biblio_record_entry
1692
1693     $bre = $ils->retrieve_biblio_record_entry($bre_id);
1694
1695 Given a biblio.record_entry.id, this method retrieves a bre object.
1696
1697 =cut
1698
1699 sub retrieve_biblio_record_entry {
1700     my $self = shift;
1701     my $id = shift;
1702
1703     my $bre = $U->simplereq(
1704         'open-ils.pcrud',
1705         'open-ils.pcrud.retrieve.bre',
1706         $self->{session}->{authtoken},
1707         $id
1708     );
1709
1710     return $bre;
1711 }
1712
1713 =head2 create_precat_copy
1714
1715     $item_info->{
1716         barcode => '312340123456789',
1717         author => 'Public, John Q.',
1718         title => 'Magnum Opus',
1719         call_number => '005.82',
1720         publisher => 'Brick House',
1721         publication_date => '2014'
1722     };
1723
1724     $item = $ils->create_precat_copy($item_info);
1725
1726
1727 Create a "precat" copy to use for the incoming item using a hashref of
1728 item information. At a minimum, the barcode, author and title fields
1729 need to be filled in. The other fields are ignored if provided.
1730
1731 This method is called by the AcceptItem handler if the C<use_precats>
1732 configuration option is turned on.
1733
1734 =cut
1735
1736 sub create_precat_copy {
1737     my $self = shift;
1738     my $item_info = shift;
1739
1740     my $item = Fieldmapper::asset::copy->new();
1741     $item->barcode($item_info->{barcode});
1742     $item->call_number(OILS_PRECAT_CALL_NUMBER);
1743     $item->dummy_title($item_info->{title});
1744     $item->dummy_author($item_info->{author});
1745     $item->circ_lib($self->{session}->{work_ou}->id());
1746     $item->circulate('t');
1747     $item->holdable('t');
1748     $item->opac_visible('f');
1749     $item->deleted('f');
1750     $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
1751     $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
1752     $item->location(1);
1753     $item->status(0);
1754     $item->editor($self->{session}->{user}->id());
1755     $item->creator($self->{session}->{user}->id());
1756     $item->isnew(1);
1757
1758     # Actually create it:
1759     my $xact;
1760     my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
1761     $ses->connect();
1762     eval {
1763         $xact = $ses->request(
1764             'open-ils.pcrud.transaction.begin',
1765             $self->{session}->{authtoken}
1766         )->gather(1);
1767         $item = $ses->request(
1768             'open-ils.pcrud.create.acp',
1769             $self->{session}->{authtoken},
1770             $item
1771         )->gather(1);
1772         $xact = $ses->request(
1773             'open-ils.pcrud.transaction.commit',
1774             $self->{session}->{authtoken}
1775         )->gather(1);
1776     };
1777     if ($@) {
1778         undef($item);
1779         if ($xact) {
1780             eval {
1781                 $ses->request(
1782                     'open-ils.pcrud.transaction.rollback',
1783                     $self->{session}->{authtoken}
1784                 )->gather(1);
1785             };
1786         }
1787     }
1788     $ses->disconnect();
1789
1790     return $item;
1791 }
1792
1793 =head2 create_fuller_copy
1794
1795     $item_info->{
1796         barcode => '31234003456789',
1797         author => 'Public, John Q.',
1798         title => 'Magnum Opus',
1799         call_number => '005.82',
1800         publisher => 'Brick House',
1801         publication_date => '2014'
1802     };
1803
1804     $item = $ils->create_fuller_copy($item_info);
1805
1806 Creates a skeletal bibliographic record, call number, and copy for the
1807 incoming item using a hashref with item information in it. At a
1808 minimum, the barcode, author, title, and call_number fields must be
1809 filled in.
1810
1811 This method is used by the AcceptItem handler if the C<use_precats>
1812 configuration option is NOT set.
1813
1814 =cut
1815
1816 sub create_fuller_copy {
1817     my $self = shift;
1818     my $item_info = shift;
1819
1820     my $item;
1821
1822     # We do everything in one transaction, because it should be atomic.
1823     my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
1824     $ses->connect();
1825     my $xact;
1826     eval {
1827         $xact = $ses->request(
1828             'open-ils.pcrud.transaction.begin',
1829             $self->{session}->{authtoken}
1830         )->gather(1);
1831     };
1832     if ($@) {
1833         undef($xact);
1834     }
1835
1836     # The rest depends on there being a transaction.
1837     if ($xact) {
1838
1839         # Create the MARC record.
1840         my $record = MARC::Record->new();
1841         $record->encoding('UTF-8');
1842         $record->leader('00881nam a2200193   4500');
1843         my $datespec = strftime("%Y%m%d%H%M%S.0", localtime);
1844         my @fields = ();
1845         push(@fields, MARC::Field->new('005', $datespec));
1846         push(@fields, MARC::Field->new('082', '0', '4', 'a' => $item_info->{call_number}));
1847         push(@fields, MARC::Field->new('245', '0', '0', 'a' => $item_info->{title}));
1848         # Publisher is a little trickier:
1849         if ($item_info->{publisher}) {
1850             my $pub = MARC::Field->new('260', ' ', ' ', 'a' => '[S.l.]', 'b' => $item_info->{publisher});
1851             $pub->add_subfields('c' => $item_info->{publication_date}) if ($item_info->{publication_date});
1852             push(@fields, $pub);
1853         }
1854         # We have no idea if the author is personal corporate or something else, so we use a 720.
1855         push(@fields, MARC::Field->new('720', ' ', ' ', 'a' => $item_info->{author}, '4' => 'aut'));
1856         $record->append_fields(@fields);
1857         my $marc = clean_marc($record);
1858
1859         # Create the bib object.
1860         my $bib = Fieldmapper::biblio::record_entry->new();
1861         $bib->creator($self->{session}->{user}->id());
1862         $bib->editor($self->{session}->{user}->id());
1863         $bib->source($self->{bib_source}->id());
1864         $bib->active('t');
1865         $bib->deleted('f');
1866         $bib->marc($marc);
1867         $bib->isnew(1);
1868
1869         eval {
1870             $bib = $ses->request(
1871                 'open-ils.pcrud.create.bre',
1872                 $self->{session}->{authtoken},
1873                 $bib
1874             )->gather(1);
1875         };
1876         if ($@) {
1877             undef($bib);
1878             eval {
1879                 $ses->request(
1880                     'open-ils.pcrud.transaction.rollback',
1881                     $self->{session}->{authtoken}
1882                 )->gather(1);
1883             };
1884         }
1885
1886         # Create the call number
1887         my $acn;
1888         if ($bib) {
1889             $acn = Fieldmapper::asset::call_number->new();
1890             $acn->creator($self->{session}->{user}->id());
1891             $acn->editor($self->{session}->{user}->id());
1892             $acn->label($item_info->{call_number});
1893             $acn->record($bib->id());
1894             $acn->owning_lib($self->{session}->{work_ou}->id());
1895             $acn->deleted('f');
1896             $acn->isnew(1);
1897
1898             eval {
1899                 $acn = $ses->request(
1900                     'open-ils.pcrud.create.acn',
1901                     $self->{session}->{authtoken},
1902                     $acn
1903                 )->gather(1);
1904             };
1905             if ($@) {
1906                 undef($acn);
1907                 eval {
1908                     $ses->request(
1909                         'open-ils.pcrud.transaction.rollback',
1910                         $self->{session}->{authtoken}
1911                     )->gather(1);
1912                 };
1913             }
1914         }
1915
1916         # create the copy
1917         if ($acn) {
1918             $item = Fieldmapper::asset::copy->new();
1919             $item->barcode($item_info->{barcode});
1920             $item->call_number($acn->id());
1921             $item->circ_lib($self->{session}->{work_ou}->id);
1922             $item->circulate('t');
1923             if ($self->{config}->{items}->{use_force_holds}) {
1924                 $item->holdable('f');
1925             } else {
1926                 $item->holdable('t');
1927             }
1928             $item->opac_visible('f');
1929             $item->deleted('f');
1930             $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
1931             $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
1932             $item->location(1);
1933             $item->status(0);
1934             $item->editor($self->{session}->{user}->id);
1935             $item->creator($self->{session}->{user}->id);
1936             $item->isnew(1);
1937
1938             eval {
1939                 $item = $ses->request(
1940                     'open-ils.pcrud.create.acp',
1941                     $self->{session}->{authtoken},
1942                     $item
1943                 )->gather(1);
1944
1945                 # Cross our fingers and commit the work.
1946                 $xact = $ses->request(
1947                     'open-ils.pcrud.transaction.commit',
1948                     $self->{session}->{authtoken}
1949                 )->gather(1);
1950             };
1951             if ($@) {
1952                 undef($item);
1953                 eval {
1954                     $ses->request(
1955                         'open-ils.pcrud.transaction.rollback',
1956                         $self->{session}->{authtoken}
1957                     )->gather(1) if ($xact);
1958                 };
1959             }
1960         }
1961     }
1962
1963     # We need to disconnect our session.
1964     $ses->disconnect();
1965
1966     # Now, we handle our asset stat_cat entries.
1967     if ($item) {
1968         # It would be nice to do these in the above transaction, but
1969         # pcrud does not support the ascecm object, yet.
1970         foreach my $entry (@{$self->{stat_cat_entries}}) {
1971             my $map = Fieldmapper::asset::stat_cat_entry_copy_map->new();
1972             $map->isnew(1);
1973             $map->stat_cat($entry->stat_cat());
1974             $map->stat_cat_entry($entry->id());
1975             $map->owning_copy($item->id());
1976             # We don't really worry if it succeeds or not.
1977             $U->simplereq(
1978                 'open-ils.circ',
1979                 'open-ils.circ.stat_cat.asset.copy_map.create',
1980                 $self->{session}->{authtoken},
1981                 $map
1982             );
1983         }
1984     }
1985
1986     return $item;
1987 }
1988
1989 =head2 place_hold
1990
1991     $hold = $ils->place_hold($item, $user, $location);
1992
1993 This function places a hold on $item for $user for pickup at
1994 $location. If location is not provided or undefined, the user's home
1995 library is used as a fallback.
1996
1997 $item can be a copy (asset::copy), volume (asset::call_number), or bib
1998 (biblio::record_entry). The appropriate hold type will be placed
1999 depending on the object.
2000
2001 On success, the method returns the object representing the hold. On
2002 failure, a NCIP::Problem object, describing the failure, is returned.
2003
2004 =cut
2005
2006 sub place_hold {
2007     my $self = shift;
2008     my $item = shift;
2009     my $user = shift;
2010     my $location = shift;
2011
2012     # If $location is undefined, use the user's home_ou, which should
2013     # have been fleshed when the user was retrieved.
2014     $location = $user->home_ou() unless ($location);
2015
2016     # $hold is the hold. $params is for the is_possible check.
2017     my ($hold, $params);
2018
2019     # Prep the hold with fields common to all hold types:
2020     $hold = Fieldmapper::action::hold_request->new();
2021     $hold->isnew(1); # Just to make sure.
2022     $hold->target($item->id());
2023     $hold->usr($user->id());
2024     $hold->pickup_lib($location->id());
2025     if (!$user->email()) {
2026         $hold->email_notify('f');
2027         $hold->phone_notify($user->day_phone()) if ($user->day_phone());
2028     } else {
2029         $hold->email_notify('t');
2030     }
2031
2032     # Ditto the params:
2033     $params = { pickup_lib => $location->id(), patronid => $user->id() };
2034
2035     if (ref($item) eq 'Fieldmapper::asset::copy') {
2036         my $type = ($self->{config}->{items}->{use_force_holds}) ? 'F' : 'C';
2037         $hold->hold_type($type);
2038         $hold->current_copy($item->id());
2039         $params->{hold_type} = $type;
2040         $params->{copy_id} = $item->id();
2041     } elsif (ref($item) eq 'Fieldmapper::asset::call_number') {
2042         $hold->hold_type('V');
2043         $params->{hold_type} = 'V';
2044         $params->{volume_id} = $item->id();
2045     } elsif (ref($item) eq 'Fieldmapper::biblio::record_entry') {
2046         $hold->hold_type('T');
2047         $params->{hold_type} = 'T';
2048         $params->{titleid} = $item->id();
2049     }
2050
2051     # Check for a duplicate hold:
2052     my $duplicate = $U->simplereq(
2053         'open-ils.pcrud',
2054         'open-ils.pcrud.search.ahr',
2055         $self->{session}->{authtoken},
2056         {
2057             hold_type => $hold->hold_type(),
2058             target => $hold->target(),
2059             usr => $hold->usr(),
2060             expire_time => {'>' => 'now'},
2061             cancel_time => undef,
2062             fulfillment_time => undef
2063         }
2064     );
2065     if ($duplicate) {
2066         return NCIP::Problem->new(
2067             {
2068                 ProblemType => 'Duplicate Request',
2069                 ProblemDetail => 'A request for this item already exists for this patron.',
2070                 ProblemElement => 'NULL',
2071                 ProblemValue => 'NULL'
2072             }
2073         );
2074     }
2075
2076     # Check if the hold is possible:
2077     my $r = $U->simplereq(
2078         'open-ils.circ',
2079         'open-ils.circ.title_hold.is_possible',
2080         $self->{session}->{authtoken},
2081         $params
2082     );
2083
2084     if ($r->{success}) {
2085         $hold = $U->simplereq(
2086             'open-ils.circ',
2087             'open-ils.circ.holds.create.override',
2088             $self->{session}->{authtoken},
2089             $hold
2090         );
2091         if (ref($hold) eq 'HASH') {
2092             $hold = _problem_from_event('Request Not Possible', $hold);
2093         }
2094     } elsif ($r->{last_event}) {
2095         $hold = _problem_from_event('Request Not Possible', $r->{last_event});
2096     } elsif ($r->{textcode}) {
2097         $hold = _problem_from_event('Request Not Possible', $r);
2098     } else {
2099         $hold = _problem_from_event('Request Not Possible');
2100     }
2101
2102     return $hold;
2103 }
2104
2105 =head2 cancel_hold
2106
2107     $ils->cancel_hold($hold);
2108
2109 This method cancels the hold argument. It makes no checks on the hold,
2110 so if there are certain conditions that need to be fulfilled before
2111 the hold is canceled, then you must check them before calling this
2112 method.
2113
2114 It returns undef on success or failure. If it fails, you've usually
2115 got bigger problems.
2116
2117 =cut
2118
2119 sub cancel_hold {
2120     my $self = shift;
2121     my $hold = shift;
2122
2123     my $r = $U->simplereq(
2124         'open-ils.circ',
2125         'open-ils.circ.hold.cancel',
2126         $self->{session}->{authtoken},
2127         $hold->id(),
2128         '5',
2129         'Canceled via NCIPServer'
2130     );
2131
2132     return undef;
2133 }
2134
2135 =head2 delete_copy
2136
2137     $ils->delete_copy($copy);
2138
2139 Deletes the copy, and if it is owned by our work_ou and not a precat,
2140 we also delete the volume and bib on which the copy depends.
2141
2142 =cut
2143
2144 sub delete_copy {
2145     my $self = shift;
2146     my $copy = shift;
2147
2148     # Shortcut for ownership checks below.
2149     my $ou_id = $self->{session}->{work_ou}->id();
2150
2151     # First, make sure the copy is not already deleted and we own it.
2152     return undef if ($U->is_true($copy->deleted()) || $copy->circ_lib() != $ou_id);
2153
2154     # Indicate we want to delete the copy.
2155     $copy->isdeleted(1);
2156
2157     # Delete the copy using a backend call that will delete the copy,
2158     # the call number, and bib when appropriate.
2159     my $result = $U->simplereq(
2160         'open-ils.cat',
2161         'open-ils.cat.asset.copy.fleshed.batch.update.override',
2162         $self->{session}->{authtoken},
2163         [$copy]
2164     );
2165
2166     # We are currently not checking for succes or failure of the
2167     # above. At some point, someone may want to.
2168
2169     return undef;
2170 }
2171
2172 =head2 copy_can_circulate
2173
2174     $can_circulate = $ils->copy_can_circulate($copy);
2175
2176 Check if the copy's location and the copy itself allow
2177 circulation. Return true if they do, and false if they do not.
2178
2179 =cut
2180
2181 sub copy_can_circulate {
2182     my $self = shift;
2183     my $copy = shift;
2184
2185     my $location = $copy->location();
2186     unless (ref($location)) {
2187         $location = $self->retrieve_copy_location($location);
2188     }
2189
2190     return ($U->is_true($copy->circulate()) && $U->is_true($location->circulate()));
2191 }
2192
2193 =head2 copy_can_fulfill
2194
2195     $can_fulfill = $ils->copy_can_fulfill($copy);
2196
2197 Check if the copy's location and the copy itself allow
2198 holds. Return true if they do, and false if they do not.
2199
2200 =cut
2201
2202 sub copy_can_fulfill {
2203     my $self = shift;
2204     my $copy = shift;
2205
2206     my $location = $copy->location();
2207     unless (ref($location)) {
2208         $location = $self->retrieve_copy_location($location);
2209     }
2210
2211     return ($U->is_true($copy->holdable()) && $U->is_true($location->holdable()));
2212 }
2213
2214 =head1 OVERRIDDEN PARENT METHODS
2215
2216 =head2 find_user_barcode
2217
2218 We dangerously override our parent's C<find_user_barcode> to return
2219 either the $barcode or a Problem object. In list context the barcode
2220 or problem will be the first argument and the id field, if any, will
2221 be the second. We also add a second, optional, argument to indicate a
2222 default value for the id field in the event of a failure to find
2223 anything at all. (Perl lets us get away with this.)
2224
2225 =cut
2226
2227 sub find_user_barcode {
2228     my $self = shift;
2229     my $request = shift;
2230     my $default = shift;
2231
2232     unless ($default) {
2233         my $message = $self->parse_request_type($request);
2234         if ($message eq 'LookupUser') {
2235             $default = 'AuthenticationInputData';
2236         } else {
2237             $default = 'UserIdentifierValue';
2238         }
2239     }
2240
2241     my ($value, $idfield) = $self->SUPER::find_user_barcode($request);
2242
2243     unless ($value) {
2244         $idfield = $default unless ($idfield);
2245         $value = NCIP::Problem->new();
2246         $value->ProblemType('Needed Data Missing');
2247         $value->ProblemDetail('Cannot find user barcode in message.');
2248         $value->ProblemElement($idfield);
2249         $value->ProblemValue('NULL');
2250     }
2251
2252     return (wantarray) ? ($value, $idfield) : $value;
2253 }
2254
2255 =head2 find_item_barcode
2256
2257 We do pretty much the same thing as with C<find_user_barcode> for
2258 C<find_item_barcode>.
2259
2260 =cut
2261
2262 sub find_item_barcode {
2263     my $self = shift;
2264     my $request = shift;
2265     my $default = shift || 'ItemIdentifierValue';
2266
2267     my ($value, $idfield) = $self->SUPER::find_item_barcode($request);
2268
2269     unless ($value) {
2270         $idfield = $default unless ($idfield);
2271         $value = NCIP::Problem->new();
2272         $value->ProblemType('Needed Data Missing');
2273         $value->ProblemDetail('Cannot find item barcode in message.');
2274         $value->ProblemElement($idfield);
2275         $value->ProblemValue('NULL');
2276     }
2277
2278     return (wantarray) ? ($value, $idfield) : $value;
2279 }
2280
2281 =head2 find_target_via_bibliographic_id
2282
2283     $item = $ils->find_target_via_bibliographic_id(@biblio_ids);
2284
2285 Searches for a bibliographic record to put on hold and returns an
2286 appropriate hold target item depending upon what it finds. If an
2287 appropriate, single target cannot be found, it returns an
2288 NCIP::Problem with the problem message.
2289
2290 Currently, we only look for SYSNUMBER, ISBN, and ISSN record
2291 identifiers. If nothing is found, this method can return undef. (Gotta
2292 love Perl and untyped/weakly typed languages in general!)
2293
2294 TODO: Figure out how to search OCLC numbers. We probably need to use
2295 "MARC Expert Search" if we don't want to do a JSON query on
2296 metabib.full_rec.
2297
2298 =cut
2299
2300 sub find_target_via_bibliographid_id {
2301     my $self = shift;
2302     my @biblio_ids = @_;
2303
2304     # The item that we find:
2305     my $item;
2306
2307     # Id for our bib in Evergreen:
2308     my $bibid;
2309
2310     # First, let's look for a SYSNUMBER:
2311     my ($idobj) = grep
2312         { $_->{BibligraphicRecordIdentifierCode} eq 'SYSNUMBER' || $_->{BibliographicItemIdentifierCode} eq 'SYSNUMBER'
2313               || $_->{AgencyId} }
2314             @biblio_ids;
2315     if ($idobj) {
2316         my $loc;
2317         # BibliographicRecordId can have an AgencyId field if the
2318         # BibliographicRecordIdentifierCode is absent.
2319         if ($idobj->{AgencyId}) {
2320             $bibid = $idobj->{BibliographicRecordIdentifier};
2321             my $locname = $idobj->{AgencyId};
2322             if ($locname) {
2323                 $locname =~ s/.*://;
2324                 $loc = $self->retrieve_org_unit_by_shortname($locname);
2325             }
2326         } elsif ($idobj->{BibliographicRecordIdentifierCode}) {
2327             $bibid = $idobj->{BibliographicRecordIdentifierCode}
2328         } else {
2329             $bibid = $idobj->{BibliographicItemIdentifierCode}
2330         }
2331         if ($bibid && $loc) {
2332             $item = $self->_call_number_search($bibid, $loc);
2333         } else {
2334             $item = $U->simplereq(
2335                 'open-ils.pcrud',
2336                 'open-ils.pcrud.retrieve.bre',
2337                 $self->{session}->{authtoken},
2338                 $bibid
2339             );
2340         }
2341         # Check if item is deleted so we'll look for more
2342         # possibilties.
2343         undef($item) if ($item && $U->is_true($item->deleted()));
2344     }
2345
2346     # Build an array of id objects based on the other identifier fields.
2347     my @idobjs = grep
2348         {
2349             $_->{BibliographicRecordIdentifierCode} eq 'ISBN' || $_->{BibliographicItemIdentifierCode} eq 'ISBN'
2350             ||
2351             $_->{BibliographicRecordIdentifierCode} eq 'ISSN' || $_->{BibliographicItemIdentifierCode} eq 'ISSN'
2352         } @biblio_ids;
2353
2354     if (@idobjs) {
2355         my $stashed_problem;
2356         # Reuse $idobj from above.
2357         foreach $idobj (@idobjs) {
2358             my ($idvalue, $idtype, $idfield);
2359             if ($_->{BibliographicItemIdentifier}) {
2360                 $idvalue = $_->{BibliographicItemIdentifier};
2361                 $idtype = $_->{BibliographicItemIdentifierCode};
2362                 $idfield = 'BibliographicItemIdentifier';
2363             } else {
2364                 $idvalue = $_->{BibliographicRecordIdentifier};
2365                 $idtype = $_->{BibliographicRecordIdentifierCode};
2366                 $idfield = 'BibliographicRecordIdentifier';
2367             }
2368             $item = $self->_bib_search($idvalue, $idtype);
2369             if (ref($item) eq 'NCIP::Problem') {
2370                 $stashed_problem = $item unless($stashed_problem);
2371                 $stashed_problem->ProblemElement($idfield);
2372                 undef($item);
2373             }
2374             last if ($item);
2375         }
2376         $item = $stashed_problem if (!$item && $stashed_problem);
2377     }
2378
2379     return $item;
2380 }
2381
2382 # private subroutines not meant to be used directly by subclasses.
2383 # Most have to do with setup and/or state checking of implementation
2384 # components.
2385
2386 # Find, load, and parse our configuration file:
2387 sub _configure {
2388     my $self = shift;
2389
2390     # Find the configuration file via variables:
2391     my $file = OILS_NCIP_CONFIG_DEFAULT;
2392     $file = $ENV{OILS_NCIP_CONFIG} if ($ENV{OILS_NCIP_CONFIG});
2393
2394     $self->{config} = XMLin($file, NormaliseSpace => 2,
2395                             ForceArray => ['block_profile', 'stat_cat_entry']);
2396 }
2397
2398 # Bootstrap OpenSRF::System and load the IDL.
2399 sub _bootstrap {
2400     my $self = shift;
2401
2402     my $bootstrap_config = $self->{config}->{bootstrap};
2403     OpenSRF::System->bootstrap_client(config_file => $bootstrap_config);
2404
2405     my $idl = OpenSRF::Utils::SettingsClient->new->config_value("IDL");
2406     Fieldmapper->import(IDL => $idl);
2407 }
2408
2409 # Login and then initialize some object data based on the
2410 # configuration.
2411 sub _init {
2412     my $self = shift;
2413
2414     # Login to Evergreen.
2415     $self->login();
2416
2417     # Load the barred groups as pgt objects into a blocked_profiles
2418     # list.
2419     $self->{blocked_profiles} = [];
2420     foreach (@{$self->{config}->{patrons}->{block_profile}}) {
2421         my $pgt;
2422         if (ref $_) {
2423             $pgt = $U->simplereq(
2424                 'open-ils.pcrud',
2425                 'open-ils.pcrud.retrieve.pgt',
2426                 $self->{session}->{authtoken},
2427                 $_->{grp}
2428             );
2429         } else {
2430             $pgt = $U->simplereq(
2431                 'open-ils.pcrud',
2432                 'open-ils.pcrud.search.pgt',
2433                 $self->{session}->{authtoken},
2434                 {name => $_}
2435             );
2436         }
2437         push(@{$self->{blocked_profiles}}, $pgt) if ($pgt);
2438     }
2439
2440     # Load the bib source if we're not using precats.
2441     unless ($self->{config}->{items}->{use_precats}) {
2442         # Retrieve the default
2443         $self->{bib_source} = $U->simplereq(
2444             'open-ils.pcrud',
2445             'open-ils.pcrud.retrieve.cbs',
2446             $self->{session}->{authtoken},
2447             BIB_SOURCE_DEFAULT);
2448         my $data = $self->{config}->{items}->{bib_source};
2449         if ($data) {
2450             $data = $data->[0] if (ref($data) eq 'ARRAY');
2451             my $result;
2452             if (ref $data) {
2453                 $result = $U->simplereq(
2454                     'open-ils.pcrud',
2455                     'open-ils.pcrud.retrieve.cbs',
2456                     $self->{session}->{authtoken},
2457                     $data->{cbs}
2458                 );
2459             } else {
2460                 $result = $U->simplereq(
2461                     'open-ils.pcrud',
2462                     'open-ils.pcrud.search.cbs',
2463                     $self->{session}->{authtoken},
2464                     {source => $data}
2465                 );
2466             }
2467             $self->{bib_source} = $result if ($result);
2468         }
2469     }
2470
2471     # Load the required asset.stat_cat_entries:
2472     $self->{stat_cat_entries} = [];
2473     # First, make a regex for our ou and ancestors:
2474     my $ancestors = join("|", @{$U->get_org_ancestors($self->{session}->{work_ou}->id())});
2475     my $re = qr/(?:$ancestors)/;
2476     # Get the uniq stat_cat ids from the configuration:
2477     my @cats = uniq map {$_->{stat_cat}} @{$self->{config}->{items}->{stat_cat_entry}};
2478     # Retrieve all of the fleshed stat_cats and entries for the above.
2479     my $stat_cats = $U->simplereq(
2480         'open-ils.circ',
2481         'open-ils.circ.stat_cat.asset.retrieve.batch',
2482         $self->{session}->{authtoken},
2483         @cats
2484     );
2485     foreach my $entry (@{$self->{config}->{items}->{stat_cat_entry}}) {
2486         # Must have the stat_cat attr and the name, so we must have a
2487         # reference.
2488         next unless(ref $entry);
2489         my ($stat) = grep {$_->id() == $entry->{stat_cat}} @$stat_cats;
2490         push(@{$self->{stat_cat_entries}}, grep {$_->owner() =~ $re && $_->value() eq $entry->{content}} @{$stat->entries()});
2491     }
2492 }
2493
2494 # Search asset.call_number by a bre.id and location object. Return the
2495 # "closest" call_number if found, undef otherwise.
2496 sub _call_number_search {
2497     my $self = shift;
2498     my $bibid = shift;
2499     my $location = shift;
2500
2501     # At some point, this should be smarter, and we should retrieve
2502     # ancestors and descendants and search with a JSON query or some
2503     # such with results ordered by proximity to the original location,
2504     # but I don't have time to implement that right now.
2505     my $acn = $U->simplereq(
2506         'open-ils.prcud',
2507         'open-ils.pcrud.search.acn',
2508         $self->{session}->{authtoken},
2509         {record => $bibid, owning_lib => $location->id()}
2510     );
2511
2512     return $acn;
2513 }
2514
2515 # Do a multiclass.query to search for items by isbn or issn.
2516 sub _bib_search {
2517     my $self = shift;
2518     my $idvalue = shift;
2519     my $idtype = shift;
2520     my $item;
2521
2522     my $result = $U->simplereq(
2523         'open-ils.search',
2524         'open-ils.search.biblio.multiclass',
2525         {searches => {lc($idtype) => $idvalue}}
2526     );
2527
2528     if ($result && $result->{count}) {
2529         if ($result->{count} > 1) {
2530             $item = NCIP::Problem->new(
2531                 {
2532                     ProblemType => 'Non-Unique Item',
2533                     ProblemDetail => 'More than one item matches the request.',
2534                     ProblemElement => '',
2535                     ProblemValue => $idvalue
2536                 }
2537             );
2538         }
2539         my $bibid = $result->{ids}->[0]->[0];
2540         $item = $U->simplereq(
2541             'open-ils.pcrud',
2542             'open-ils.pcrud.retrieve.bre',
2543             $self->{session}->{authtoken},
2544             $bibid
2545         );
2546     }
2547
2548     return $item;
2549 }
2550
2551 # Search for holds using the user and copy_details information:
2552 sub _hold_search {
2553     my $self = shift;
2554     my $user = shift;
2555     my $copy_details = shift;
2556
2557     my $hold;
2558
2559     # Retrieve all of the user's active holds, and then search them in Perl.
2560     my $holds_list = $U->simplereq(
2561         'open-ils.circ',
2562         'open-ils.circ.holds.retrieve',
2563         $self->{session}->{authtoken},
2564         $user->id(),
2565         0
2566     );
2567
2568     if ($holds_list && @$holds_list) {
2569         my @holds;
2570         # Look for title holds (the most common), first:
2571         my $targetid = $copy_details->{mvr}->doc_id();
2572         @holds = grep {$_->hold_type eq 'T' && $_->target == $targetid} @{$holds_list};
2573         unless (@holds) {
2574             # Look for volume holds, the next most common:
2575             $targetid = $copy_details->{volume}->id();
2576             @holds = grep {$_->hold_type eq 'V' && $_->target == $targetid} @{$holds_list};
2577         }
2578         unless (@holds) {
2579             # Look for copy and force holds, the least likely.
2580             $targetid = $copy_details->{copy}->id();
2581             @holds = grep {($_->hold_type eq 'C' || $_->hold_type eq 'F') && $_->target == $targetid} @{$holds_list};
2582         }
2583         # There should only be 1, at this point, if there are any.
2584         if (@holds) {
2585             $hold = $holds[0];
2586         }
2587     }
2588
2589     return $hold;
2590 }
2591
2592 # Standalone, "helper" functions.  These do not take an object or
2593 # class reference.
2594
2595 # Check if a user is past their expiration date.
2596 sub _expired {
2597     my $user = shift;
2598     my $expired = 0;
2599
2600     # Users might not expire.  If so, they have no expire_date.
2601     if ($user->expire_date()) {
2602         my $expires = DateTime::Format::ISO8601->parse_datetime(
2603             cleanse_ISO8601($user->expire_date())
2604         )->epoch();
2605         my $now = DateTime->now()->epoch();
2606         $expired = $now > $expires;
2607     }
2608
2609     return $expired;
2610 }
2611
2612 # Creates a NCIP Problem from an event. Takes a string for the problem
2613 # type, the event hashref (or a string to use for the detail), and
2614 # optional arguments for the ProblemElement and ProblemValue fields.
2615 sub _problem_from_event {
2616     my ($type, $evt, $element, $value) = @_;
2617
2618     my $detail;
2619
2620     # Check the event.
2621     if (ref($evt)) {
2622         my ($textcode, $desc);
2623
2624         # Get the textcode, if available. Otherwise, use the ilsevent
2625         # "id," if available.
2626         if ($evt->{textcode}) {
2627             $textcode = $evt->{textcode};
2628         } elsif ($evt->{ilsevent}) {
2629             $textcode = $evt->{ilsevent};
2630         }
2631
2632         # Get the description. We favor translated descriptions over
2633         # the English in ils_events.xml.
2634         if ($evt->{desc}) {
2635             $desc = $evt->{desc};
2636         }
2637
2638         # Check if $type was set. As an "undocumented" feature, you
2639         # can pass undef, and we'll use the textcode from the event.
2640         unless ($type) {
2641             if ($textcode) {
2642                 $type = $textcode;
2643             }
2644         }
2645
2646         # Set the detail from some combination of the above.
2647         if ($desc) {
2648             $detail = $desc;
2649         } elsif ($textcode eq 'PERM_FAILURE') {
2650             if ($evt->{ilsperm}) {
2651                 $detail = "Permission denied: " . $evt->{ilsperm};
2652                 $detail =~ s/\.override$//;
2653             }
2654         } elsif ($textcode) {
2655             $detail = "ILS returned $textcode error.";
2656         } else {
2657             $detail = 'Detail not available.';
2658         }
2659
2660     } else {
2661         $detail = $evt;
2662     }
2663
2664     return NCIP::Problem->new(
2665         {
2666             ProblemType => ($type) ? $type : 'Temporary Processing Failure',
2667             ProblemDetail => ($detail) ? $detail : 'Detail not available.',
2668             ProblemElement => ($element) ? $element : 'NULL',
2669             ProblemValue => ($value) ? $value : 'NULL'
2670         }
2671     );
2672 }
2673
2674 1;