Add some "smarts" to _problem_from_event in NCIP::ILS::Evergreen.
[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 Unkown 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 Unkown 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 =head1 METHODS USEFUL to SUBCLASSES
816
817 =head2 login
818
819     $ils->login();
820
821 Login to Evergreen via OpenSRF. It uses internal state from the
822 configuration file to login.
823
824 =cut
825
826 # Login via OpenSRF to Evergreen.
827 sub login {
828     my $self = shift;
829
830     # Get the authentication seed.
831     my $seed = $U->simplereq(
832         'open-ils.auth',
833         'open-ils.auth.authenticate.init',
834         $self->{config}->{credentials}->{username}
835     );
836
837     # Actually login.
838     if ($seed) {
839         my $response = $U->simplereq(
840             'open-ils.auth',
841             'open-ils.auth.authenticate.complete',
842             {
843                 username => $self->{config}->{credentials}->{username},
844                 password => md5_hex(
845                     $seed . md5_hex($self->{config}->{credentials}->{password})
846                 ),
847                 type => 'staff',
848                 workstation => $self->{config}->{credentials}->{workstation}
849             }
850         );
851         if ($response) {
852             $self->{session}->{authtoken} = $response->{payload}->{authtoken};
853             $self->{session}->{authtime} = $response->{payload}->{authtime};
854
855             # Set/reset the work_ou and user data in case something changed.
856
857             # Retrieve the work_ou as an object.
858             $self->{session}->{work_ou} = $U->simplereq(
859                 'open-ils.pcrud',
860                 'open-ils.pcrud.search.aou',
861                 $self->{session}->{authtoken},
862                 {shortname => $self->{config}->{credentials}->{work_ou}}
863             );
864
865             # We need the user information in order to do some things.
866             $self->{session}->{user} = $U->check_user_session($self->{session}->{authtoken});
867
868         }
869     }
870 }
871
872 =head2 checkauth
873
874     $valid = $ils->checkauth();
875
876 Returns 1 if the object a 'valid' authtoken, 0 if not.
877
878 =cut
879
880 sub checkauth {
881     my $self = shift;
882
883     # We use AppUtils to do the heavy lifting.
884     if (defined($self->{session})) {
885         if ($U->check_user_session($self->{session}->{authtoken})) {
886             return 1;
887         } else {
888             return 0;
889         }
890     }
891
892     # If we reach here, we don't have a session, so we are definitely
893     # not logged in.
894     return 0;
895 }
896
897 =head2 retrieve_user_by_barcode
898
899     $user = $ils->retrieve_user_by_barcode($user_barcode, $user_idfield);
900
901 Do a fleshed retrieve of a patron by barcode. Return the patron if
902 found and valid. Return a NCIP::Problem of 'Unknown User' otherwise.
903
904 The id field argument is used for the ProblemElement field in the
905 NCIP::Problem object.
906
907 An invalid patron is one where the barcode is not found in the
908 database, the patron is deleted, or the barcode used to retrieve the
909 patron is not active. The problem element is also returned if an error
910 occurs during the retrieval.
911
912 =cut
913
914 sub retrieve_user_by_barcode {
915     my ($self, $barcode, $idfield) = @_;
916     my $result = $U->simplereq(
917         'open-ils.actor',
918         'open-ils.actor.user.fleshed.retrieve_by_barcode',
919         $self->{session}->{authtoken},
920         $barcode,
921         1
922     );
923
924     # Check for a failure, or a deleted, inactive, or expired user,
925     # and if so, return empty userdata.
926     if (!$result || $U->event_code($result) || $U->is_true($result->deleted())
927             || !grep {$_->barcode() eq $barcode && $U->is_true($_->active())} @{$result->cards()}) {
928
929         my $problem = NCIP::Problem->new();
930         $problem->ProblemType('Unknown User');
931         $problem->ProblemDetail("User with barcode $barcode unknown");
932         $problem->ProblemElement($idfield);
933         $problem->ProblemValue($barcode);
934         $result = $problem;
935     }
936
937     return $result;
938 }
939
940 =head2 retrieve_user_by_id
941
942     $user = $ils->retrieve_user_by_id($id);
943
944 Similar to C<retrieve_user_by_barcode> but takes the user's database
945 id rather than barcode. This is useful when you have a circulation or
946 hold and need to get information about the user's involved in the hold
947 or circulaiton.
948
949 It returns a fleshed user on success or undef on failure.
950
951 =cut
952
953 sub retrieve_user_by_id {
954     my ($self, $id) = @_;
955
956     # Do a fleshed retrieve of the patron, and flesh the fields that
957     # we would normally use.
958     my $result = $U->simplereq(
959         'open-ils.actor',
960         'open-ils.actor.user.fleshed.retrieve',
961         $self->{session}->{authtoken},
962         $id,
963         [ 'card', 'cards', 'standing_penalties', 'addresses', 'home_ou' ]
964     );
965     # Check for an error.
966     undef($result) if ($result && $U->event_code($result));
967
968     return $result;
969 }
970
971 =head2 check_user_for_problems
972
973     $problem = $ils>check_user_for_problems($user, 'HOLD, 'CIRC', 'RENEW');
974
975 This function checks if a user has a blocked profile or any from a
976 list of provided blocks. If it does, then a NCIP::Problem object is
977 returned, otherwise an undefined value is returned.
978
979 The list of blocks appears as additional arguments after the user. You
980 can provide any value(s) that might appear in a standing penalty block
981 lit in Evergreen. The example above checks for HOLD, CIRC, and
982 RENEW. Any number of such values can be provided. If none are
983 provided, the function only checks if the patron's profiles appears in
984 the object's blocked profiles list.
985
986 It stops on the first matching block, if any.
987
988 =cut
989
990 sub check_user_for_problems {
991     my $self = shift;
992     my $user = shift;
993     my @blocks = @_;
994
995     # Fill this in if we have a problem, otherwise just return it.
996     my $problem;
997
998     # First, check the user's profile.
999     if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
1000         $problem = NCIP::Problem->new(
1001             {
1002                 ProblemType => 'User Blocked',
1003                 ProblemDetail => 'User blocked from inter-library loan',
1004                 ProblemElement => 'NULL',
1005                 ProblemValue => 'NULL'
1006             }
1007         );
1008     }
1009
1010     # Next, check if the patron has one of the indicated blocks.
1011     unless ($problem) {
1012         foreach my $block (@blocks) {
1013             if (grep {$_->standing_penalty->block_list() =~ /$block/} @{$user->standing_penalties()}) {
1014                 $problem = NCIP::Problem->new(
1015                     {
1016                         ProblemType => 'User Blocked',
1017                         ProblemDetail => 'User blocked from ' .
1018                             ($block eq 'HOLD') ? 'holds' : (($block eq 'RENEW') ? 'renewals' :
1019                                                                 (($block eq 'CIRC') ? 'checkout' : lc($block))),
1020                         ProblemElement => 'NULL',
1021                         ProblemValue => 'NULL'
1022                     }
1023                 );
1024                 last;
1025             }
1026         }
1027     }
1028
1029     return $problem;
1030 }
1031
1032 =head2 check_circ_details
1033
1034     $problem = $ils->check_circ_details($circ, $copy, $user);
1035
1036 Checks if we can checkin or renew a circulation. That is, the
1037 circulation is still open (i.e. the copy is still checked out), if we
1038 either own the copy or are the circulation location, and if the
1039 circulation is for the optional $user argument. $circ and $copy are
1040 required. $user is optional.
1041
1042 Returns a problem if any of the above conditions fail. Returns undef
1043 if they pass and we can proceed with the checkin or renewal.
1044
1045 If the failure occurred on the copy-related checks, then the
1046 ProblemElement field will be undefined and needs to be filled in with
1047 the item id field name. If the check for the copy being checked out to
1048 the provided user fails, then both ProblemElement and ProblemValue
1049 fields will be empty and need to be filled in by the caller.
1050
1051 =cut
1052
1053 sub check_circ_details {
1054     my ($self, $circ, $copy, $user) = @_;
1055
1056     # Shortcut for the next check.
1057     my $ou_id = $self->{session}->{work_ou}->id();
1058
1059     if (!$circ || $circ->checkin_time() || ($circ->circ_lib() != $ou_id && $copy->circ_lib() != $ou_id)) {
1060         # Item isn't checked out.
1061         return NCIP::Problem->new(
1062             {
1063                 ProblemType => 'Item Not Checked Out',
1064                 ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out.',
1065                 ProblemValue => $copy->barcode()
1066             }
1067         );
1068     } else {
1069         # Get data on the patron who has it checked out.
1070         my $circ_user = $self->retrieve_user_by_id($circ->usr());
1071         if ($user && $circ_user && $user->id() != $circ_user->id()) {
1072             # The ProblemElement and ProblemValue field need to be
1073             # filled in by the caller.
1074             return NCIP::Problem->new(
1075                 {
1076                     ProblemType => 'Item Not Checked Out To This User',
1077                     ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out to this user.',
1078                 }
1079             );
1080         }
1081     }
1082     # If we get here, we're good to go.
1083     return undef;
1084 }
1085
1086 =head2 retrieve_copy_details_by_barcode
1087
1088     $copy = $ils->retrieve_copy_details_by_barcode($copy_barcode);
1089
1090 Look up and retrieve some copy details by the copy barcode. This
1091 method returns either a hashref with the copy details or undefined if
1092 no copy exists with that barcode or if some error occurs.
1093
1094 The hashref has the fields copy, hold, transit, circ, volume, and mvr.
1095
1096 This method differs from C<retrieve_user_by_barcode> in that a copy
1097 cannot be invalid if it exists and it is not always an error if no
1098 copy exists. In some cases, when handling AcceptItem, we might prefer
1099 there to be no copy.
1100
1101 =cut
1102
1103 sub retrieve_copy_details_by_barcode {
1104     my $self = shift;
1105     my $barcode = shift;
1106
1107     my $copy = $U->simplereq(
1108         'open-ils.circ',
1109         'open-ils.circ.copy_details.retrieve.barcode',
1110         $self->{session}->{authtoken},
1111         $barcode
1112     );
1113
1114     # If $copy is an event, return undefined.
1115     if ($copy && $U->event_code($copy)) {
1116         undef($copy);
1117     }
1118
1119     return $copy;
1120 }
1121
1122 =head2 retrieve_org_unit_by_shortname
1123
1124     $org_unit = $ils->retrieve_org_unit_by_shortname($shortname);
1125
1126 Retrieves an org. unit from the database by shortname. Returns the
1127 org. unit as a Fieldmapper object or undefined.
1128
1129 =cut
1130
1131 sub retrieve_org_unit_by_shortname {
1132     my $self = shift;
1133     my $shortname = shift;
1134
1135     my $aou = $U->simplereq(
1136         'open-ils.pcrud',
1137         'open-ils.pcrud.search.aou',
1138         $self->{session}->{authtoken},
1139         {shortname => {'=' => {transform => 'lower', value => ['lower', $shortname]}}}
1140     );
1141
1142     return $aou;
1143 }
1144
1145 =head2 create_precat_copy
1146
1147     $item_info->{
1148         barcode => '312340123456789',
1149         author => 'Public, John Q.',
1150         title => 'Magnum Opus',
1151         call_number => '005.82',
1152         publisher => 'Brick House',
1153         publication_date => '2014'
1154     };
1155
1156     $item = $ils->create_precat_copy($item_info);
1157
1158
1159 Create a "precat" copy to use for the incoming item using a hashref of
1160 item information. At a minimum, the barcode, author and title fields
1161 need to be filled in. The other fields are ignored if provided.
1162
1163 This method is called by the AcceptItem handler if the C<use_precats>
1164 configuration option is turned on.
1165
1166 =cut
1167
1168 sub create_precat_copy {
1169     my $self = shift;
1170     my $item_info = shift;
1171
1172     my $item = Fieldmapper::asset::copy->new();
1173     $item->barcode($item_info->{barcode});
1174     $item->call_number(OILS_PRECAT_CALL_NUMBER);
1175     $item->dummy_title($item_info->{title});
1176     $item->dummy_author($item_info->{author});
1177     $item->circ_lib($self->{session}->{work_ou}->id());
1178     $item->circulate('t');
1179     $item->holdable('t');
1180     $item->opac_visible('f');
1181     $item->deleted('f');
1182     $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
1183     $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
1184     $item->location(1);
1185     $item->status(0);
1186     $item->editor($self->{session}->{user}->id());
1187     $item->creator($self->{session}->{user}->id());
1188     $item->isnew(1);
1189
1190     # Actually create it:
1191     my $xact;
1192     my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
1193     $ses->connect();
1194     eval {
1195         $xact = $ses->request(
1196             'open-ils.pcrud.transaction.begin',
1197             $self->{session}->{authtoken}
1198         )->gather(1);
1199         $item = $ses->request(
1200             'open-ils.pcrud.create.acp',
1201             $self->{session}->{authtoken},
1202             $item
1203         )->gather(1);
1204         $xact = $ses->request(
1205             'open-ils.pcrud.transaction.commit',
1206             $self->{session}->{authtoken}
1207         )->gather(1);
1208     };
1209     if ($@) {
1210         undef($item);
1211         if ($xact) {
1212             eval {
1213                 $ses->request(
1214                     'open-ils.pcrud.transaction.rollback',
1215                     $self->{session}->{authtoken}
1216                 )->gather(1);
1217             };
1218         }
1219     }
1220     $ses->disconnect();
1221
1222     return $item;
1223 }
1224
1225 =head2 create_fuller_copy
1226
1227     $item_info->{
1228         barcode => '31234003456789',
1229         author => 'Public, John Q.',
1230         title => 'Magnum Opus',
1231         call_number => '005.82',
1232         publisher => 'Brick House',
1233         publication_date => '2014'
1234     };
1235
1236     $item = $ils->create_fuller_copy($item_info);
1237
1238 Creates a skeletal bibliographic record, call number, and copy for the
1239 incoming item using a hashref with item information in it. At a
1240 minimum, the barcode, author, title, and call_number fields must be
1241 filled in.
1242
1243 This method is used by the AcceptItem handler if the C<use_precats>
1244 configuration option is NOT set.
1245
1246 =cut
1247
1248 sub create_fuller_copy {
1249     my $self = shift;
1250     my $item_info = shift;
1251
1252     my $item;
1253
1254     # We do everything in one transaction, because it should be atomic.
1255     my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
1256     $ses->connect();
1257     my $xact;
1258     eval {
1259         $xact = $ses->request(
1260             'open-ils.pcrud.transaction.begin',
1261             $self->{session}->{authtoken}
1262         )->gather(1);
1263     };
1264     if ($@) {
1265         undef($xact);
1266     }
1267
1268     # The rest depends on there being a transaction.
1269     if ($xact) {
1270
1271         # Create the MARC record.
1272         my $record = MARC::Record->new();
1273         $record->encoding('UTF-8');
1274         $record->leader('00881nam a2200193   4500');
1275         my $datespec = strftime("%Y%m%d%H%M%S.0", localtime);
1276         my @fields = ();
1277         push(@fields, MARC::Field->new('005', $datespec));
1278         push(@fields, MARC::Field->new('082', '0', '4', 'a' => $item_info->{call_number}));
1279         push(@fields, MARC::Field->new('245', '0', '0', 'a' => $item_info->{title}));
1280         # Publisher is a little trickier:
1281         if ($item_info->{publisher}) {
1282             my $pub = MARC::Field->new('260', ' ', ' ', 'a' => '[S.l.]', 'b' => $item_info->{publisher});
1283             $pub->add_subfields('c' => $item_info->{publication_date}) if ($item_info->{publication_date});
1284             push(@fields, $pub);
1285         }
1286         # We have no idea if the author is personal corporate or something else, so we use a 720.
1287         push(@fields, MARC::Field->new('720', ' ', ' ', 'a' => $item_info->{author}, '4' => 'aut'));
1288         $record->append_fields(@fields);
1289         my $marc = clean_marc($record);
1290
1291         # Create the bib object.
1292         my $bib = Fieldmapper::biblio::record_entry->new();
1293         $bib->creator($self->{session}->{user}->id());
1294         $bib->editor($self->{session}->{user}->id());
1295         $bib->source($self->{bib_source}->id());
1296         $bib->active('t');
1297         $bib->deleted('f');
1298         $bib->marc($marc);
1299         $bib->isnew(1);
1300
1301         eval {
1302             $bib = $ses->request(
1303                 'open-ils.pcrud.create.bre',
1304                 $self->{session}->{authtoken},
1305                 $bib
1306             )->gather(1);
1307         };
1308         if ($@) {
1309             undef($bib);
1310             eval {
1311                 $ses->request(
1312                     'open-ils.pcrud.transaction.rollback',
1313                     $self->{session}->{authtoken}
1314                 )->gather(1);
1315             };
1316         }
1317
1318         # Create the call number
1319         my $acn;
1320         if ($bib) {
1321             $acn = Fieldmapper::asset::call_number->new();
1322             $acn->creator($self->{session}->{user}->id());
1323             $acn->editor($self->{session}->{user}->id());
1324             $acn->label($item_info->{call_number});
1325             $acn->record($bib->id());
1326             $acn->owning_lib($self->{session}->{work_ou}->id());
1327             $acn->deleted('f');
1328             $acn->isnew(1);
1329
1330             eval {
1331                 $acn = $ses->request(
1332                     'open-ils.pcrud.create.acn',
1333                     $self->{session}->{authtoken},
1334                     $acn
1335                 )->gather(1);
1336             };
1337             if ($@) {
1338                 undef($acn);
1339                 eval {
1340                     $ses->request(
1341                         'open-ils.pcrud.transaction.rollback',
1342                         $self->{session}->{authtoken}
1343                     )->gather(1);
1344                 };
1345             }
1346         }
1347
1348         # create the copy
1349         if ($acn) {
1350             $item = Fieldmapper::asset::copy->new();
1351             $item->barcode($item_info->{barcode});
1352             $item->call_number($acn->id());
1353             $item->circ_lib($self->{session}->{work_ou}->id);
1354             $item->circulate('t');
1355             if ($self->{config}->{items}->{use_force_holds}) {
1356                 $item->holdable('f');
1357             } else {
1358                 $item->holdable('t');
1359             }
1360             $item->opac_visible('f');
1361             $item->deleted('f');
1362             $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
1363             $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
1364             $item->location(1);
1365             $item->status(0);
1366             $item->editor($self->{session}->{user}->id);
1367             $item->creator($self->{session}->{user}->id);
1368             $item->isnew(1);
1369
1370             eval {
1371                 $item = $ses->request(
1372                     'open-ils.pcrud.create.acp',
1373                     $self->{session}->{authtoken},
1374                     $item
1375                 )->gather(1);
1376
1377                 # Cross our fingers and commit the work.
1378                 $xact = $ses->request(
1379                     'open-ils.pcrud.transaction.commit',
1380                     $self->{session}->{authtoken}
1381                 )->gather(1);
1382             };
1383             if ($@) {
1384                 undef($item);
1385                 eval {
1386                     $ses->request(
1387                         'open-ils.pcrud.transaction.rollback',
1388                         $self->{session}->{authtoken}
1389                     )->gather(1) if ($xact);
1390                 };
1391             }
1392         }
1393     }
1394
1395     # We need to disconnect our session.
1396     $ses->disconnect();
1397
1398     # Now, we handle our asset stat_cat entries.
1399     if ($item) {
1400         # It would be nice to do these in the above transaction, but
1401         # pcrud does not support the ascecm object, yet.
1402         foreach my $entry (@{$self->{stat_cat_entries}}) {
1403             my $map = Fieldmapper::asset::stat_cat_entry_copy_map->new();
1404             $map->isnew(1);
1405             $map->stat_cat($entry->stat_cat());
1406             $map->stat_cat_entry($entry->id());
1407             $map->owning_copy($item->id());
1408             # We don't really worry if it succeeds or not.
1409             $U->simplereq(
1410                 'open-ils.circ',
1411                 'open-ils.circ.stat_cat.asset.copy_map.create',
1412                 $self->{session}->{authtoken},
1413                 $map
1414             );
1415         }
1416     }
1417
1418     return $item;
1419 }
1420
1421 =head2 place_hold
1422
1423     $hold = $ils->place_hold($item, $user, $location);
1424
1425 This function places a hold on $item for $user for pickup at
1426 $location. If location is not provided or undefined, the user's home
1427 library is used as a fallback.
1428
1429 $item can be a copy (asset::copy), volume (asset::call_number), or bib
1430 (biblio::record_entry). The appropriate hold type will be placed
1431 depending on the object.
1432
1433 On success, the method returns the object representing the hold. On
1434 failure, a NCIP::Problem object, describing the failure, is returned.
1435
1436 =cut
1437
1438 sub place_hold {
1439     my $self = shift;
1440     my $item = shift;
1441     my $user = shift;
1442     my $location = shift;
1443
1444     # If $location is undefined, use the user's home_ou, which should
1445     # have been fleshed when the user was retrieved.
1446     $location = $user->home_ou() unless ($location);
1447
1448     # $hold is the hold. $params is for the is_possible check.
1449     my ($hold, $params);
1450
1451     # Prep the hold with fields common to all hold types:
1452     $hold = Fieldmapper::action::hold_request->new();
1453     $hold->isnew(1); # Just to make sure.
1454     $hold->target($item->id());
1455     $hold->usr($user->id());
1456     $hold->pickup_lib($location->id());
1457     if (!$user->email()) {
1458         $hold->email_notify('f');
1459         $hold->phone_notify($user->day_phone()) if ($user->day_phone());
1460     } else {
1461         $hold->email_notify('t');
1462     }
1463
1464     # Ditto the params:
1465     $params = { pickup_lib => $location->id(), patronid => $user->id() };
1466
1467     if (ref($item) eq 'Fieldmapper::asset::copy') {
1468         my $type = ($self->{config}->{items}->{use_force_holds}) ? 'F' : 'C';
1469         $hold->hold_type($type);
1470         $hold->current_copy($item->id());
1471         $params->{hold_type} = $type;
1472         $params->{copy_id} = $item->id();
1473     } elsif (ref($item) eq 'Fieldmapper::asset::call_number') {
1474         $hold->hold_type('V');
1475         $params->{hold_type} = 'V';
1476         $params->{volume_id} = $item->id();
1477     } elsif (ref($item) eq 'Fieldmapper::biblio::record_entry') {
1478         $hold->hold_type('T');
1479         $params->{hold_type} = 'T';
1480         $params->{titleid} = $item->id();
1481     }
1482
1483     # Check if the hold is possible:
1484     my $r = $U->simplereq(
1485         'open-ils.circ',
1486         'open-ils.circ.title_hold.is_possible',
1487         $self->{session}->{authtoken},
1488         $params
1489     );
1490
1491     if ($r->{success}) {
1492         $hold = $U->simplereq(
1493             'open-ils.circ',
1494             'open-ils.circ.holds.create.override',
1495             $self->{session}->{authtoken},
1496             $hold
1497         );
1498         if (ref($hold) eq 'HASH') {
1499             $hold = _problem_from_event('Request Not Possible', $hold);
1500         }
1501     } elsif ($r->{last_event}) {
1502         $hold = _problem_from_event('Request Not Possible', $r->{last_event});
1503     } elsif ($r->{textcode}) {
1504         $hold = _problem_from_event('Request Not Possible', $r);
1505     } else {
1506         $hold = _problem_from_event('Request Not Possible');
1507     }
1508
1509     return $hold;
1510 }
1511
1512 =head2 delete_copy
1513
1514     $ils->delete_copy($copy);
1515
1516 Deletes the copy, and if it is owned by our work_ou and not a precat,
1517 we also delete the volume and bib on which the copy depends.
1518
1519 =cut
1520
1521 sub delete_copy {
1522     my $self = shift;
1523     my $copy = shift;
1524
1525     # Shortcut for ownership checks below.
1526     my $ou_id = $self->{session}->{work_ou}->id();
1527
1528     # First, make sure the copy is not already deleted and we own it.
1529     return undef if ($U->is_true($copy->deleted()) || $copy->circ_lib() != $ou_id);
1530
1531     # If call_number was fleshed, deflesh it.
1532     if (ref($copy->call_number())) {
1533         my $cn = $copy->call_number();
1534         $copy->call_number($cn->id());
1535     }
1536
1537     # We need a transaction & connected session.
1538     my $xact;
1539     my $session = OpenSRF::AppSession->create('open-ils.pcrud');
1540     $session->connect();
1541     eval {
1542         $xact = $session->request(
1543             'open-ils.pcrud.transaction.begin',
1544             $self->{session}->{authtoken}
1545         )->gather(1);
1546     };
1547     if ($@) {
1548         undef($xact);
1549     }
1550
1551     if ($xact) {
1552         # Do the rest in one eval block.
1553         eval {
1554             # Delete the copy.
1555             my $r = $session->request(
1556                 'open-ils.pcrud.delete.acp',
1557                 $self->{session}->{authtoken},
1558                 $copy
1559             )->gather(1);
1560             # Check for volume.
1561             if ($copy->call_number() != -1) {
1562                 # Retrieve the acn object and flesh the bib.
1563                 my $acn = $session->request(
1564                     'open-ils.pcrud.retrieve.acn',
1565                     $self->{session}->{authtoken},
1566                     $copy->call_number(),
1567                     {flesh => 2, flesh_fields => {acn => ['record','copies'], bre => ['call_numbers']}}
1568                 )->gather(1);
1569                 if ($acn) {
1570                     # Check if we own the call_number.
1571                     if ($acn->owning_lib() == $ou_id) {
1572                         # check for additional copies on the acn.
1573                         my @copies = grep {$_->id() != $copy->id() && !$U->is_true($_->deleted())} @{$acn->copies()};
1574                         unless (@copies) {
1575                             # Get the bib
1576                             my $bib = $acn->record();
1577                             $r = $session->request(
1578                                 'open-ils.pcrud.delete.acn',
1579                                 $self->{session}->{authtoken},
1580                                 $acn
1581                             )->gather(1);
1582                             if ($r) {
1583                                 # Check if we created the bib.
1584                                 if ($bib->creator() == $self->{session}->{user}->id()) {
1585                                 # Check for other call numbers on the bib:
1586                                     my @vols = grep {$_->id() != $acn->id() && !$U->is_true($_->deleted())}
1587                                         @{$bib->call_numbers()};
1588                                     unless (@vols) {
1589                                         $r = $session->request(
1590                                             'open-ils.pcrud.delete.bre',
1591                                             $self->{session}->{authtoken},
1592                                             $bib
1593                                         )->gather(1);
1594                                     }
1595                                 }
1596                             }
1597                         }
1598                     }
1599                 }
1600             }
1601             $r = $session->request(
1602                 'open-ils.pcrud.transaction.commit',
1603                 $self->{session}->{authtoken}
1604             )->gather(1);
1605         };
1606         if ($@) {
1607             eval {
1608                 my $r = $session->request(
1609                     'open-ils.pcrud.transaction.rollback',
1610                     $self->{session}->{authtoken}
1611                 )->gather(1);
1612             }
1613         }
1614     }
1615
1616     $session->disconnect();
1617
1618     return undef;
1619 }
1620
1621 =head1 OVERRIDDEN PARENT METHODS
1622
1623 =head2 find_user_barcode
1624
1625 We dangerously override our parent's C<find_user_barcode> to return
1626 either the $barcode or a Problem object. In list context the barcode
1627 or problem will be the first argument and the id field, if any, will
1628 be the second. We also add a second, optional, argument to indicate a
1629 default value for the id field in the event of a failure to find
1630 anything at all. (Perl lets us get away with this.)
1631
1632 =cut
1633
1634 sub find_user_barcode {
1635     my $self = shift;
1636     my $request = shift;
1637     my $default = shift;
1638
1639     unless ($default) {
1640         my $message = $self->parse_request_type($request);
1641         if ($message eq 'LookupUser') {
1642             $default = 'AuthenticationInputData';
1643         } else {
1644             $default = 'UserIdentifierValue';
1645         }
1646     }
1647
1648     my ($value, $idfield) = $self->SUPER::find_user_barcode($request);
1649
1650     unless ($value) {
1651         $idfield = $default unless ($idfield);
1652         $value = NCIP::Problem->new();
1653         $value->ProblemType('Needed Data Missing');
1654         $value->ProblemDetail('Cannot find user barcode in message.');
1655         $value->ProblemElement($idfield);
1656         $value->ProblemValue('NULL');
1657     }
1658
1659     return (wantarray) ? ($value, $idfield) : $value;
1660 }
1661
1662 =head2 find_item_barcode
1663
1664 We do pretty much the same thing as with C<find_user_barcode> for
1665 C<find_item_barcode>.
1666
1667 =cut
1668
1669 sub find_item_barcode {
1670     my $self = shift;
1671     my $request = shift;
1672     my $default = shift || 'ItemIdentifierValue';
1673
1674     my ($value, $idfield) = $self->SUPER::find_item_barcode($request);
1675
1676     unless ($value) {
1677         $idfield = $default unless ($idfield);
1678         $value = NCIP::Problem->new();
1679         $value->ProblemType('Needed Data Missing');
1680         $value->ProblemDetail('Cannot find item barcode in message.');
1681         $value->ProblemElement($idfield);
1682         $value->ProblemValue('NULL');
1683     }
1684
1685     return (wantarray) ? ($value, $idfield) : $value;
1686 }
1687
1688 # private subroutines not meant to be used directly by subclasses.
1689 # Most have to do with setup and/or state checking of implementation
1690 # components.
1691
1692 # Find, load, and parse our configuration file:
1693 sub _configure {
1694     my $self = shift;
1695
1696     # Find the configuration file via variables:
1697     my $file = OILS_NCIP_CONFIG_DEFAULT;
1698     $file = $ENV{OILS_NCIP_CONFIG} if ($ENV{OILS_NCIP_CONFIG});
1699
1700     $self->{config} = XMLin($file, NormaliseSpace => 2,
1701                             ForceArray => ['block_profile', 'stat_cat_entry']);
1702 }
1703
1704 # Bootstrap OpenSRF::System and load the IDL.
1705 sub _bootstrap {
1706     my $self = shift;
1707
1708     my $bootstrap_config = $self->{config}->{bootstrap};
1709     OpenSRF::System->bootstrap_client(config_file => $bootstrap_config);
1710
1711     my $idl = OpenSRF::Utils::SettingsClient->new->config_value("IDL");
1712     Fieldmapper->import(IDL => $idl);
1713 }
1714
1715 # Login and then initialize some object data based on the
1716 # configuration.
1717 sub _init {
1718     my $self = shift;
1719
1720     # Login to Evergreen.
1721     $self->login();
1722
1723     # Load the barred groups as pgt objects into a blocked_profiles
1724     # list.
1725     $self->{blocked_profiles} = [];
1726     foreach (@{$self->{config}->{patrons}->{block_profile}}) {
1727         my $pgt;
1728         if (ref $_) {
1729             $pgt = $U->simplereq(
1730                 'open-ils.pcrud',
1731                 'open-ils.pcrud.retrieve.pgt',
1732                 $self->{session}->{authtoken},
1733                 $_->{grp}
1734             );
1735         } else {
1736             $pgt = $U->simplereq(
1737                 'open-ils.pcrud',
1738                 'open-ils.pcrud.search.pgt',
1739                 $self->{session}->{authtoken},
1740                 {name => $_}
1741             );
1742         }
1743         push(@{$self->{blocked_profiles}}, $pgt) if ($pgt);
1744     }
1745
1746     # Load the bib source if we're not using precats.
1747     unless ($self->{config}->{items}->{use_precats}) {
1748         # Retrieve the default
1749         $self->{bib_source} = $U->simplereq(
1750             'open-ils.pcrud',
1751             'open-ils.pcrud.retrieve.cbs',
1752             $self->{session}->{authtoken},
1753             BIB_SOURCE_DEFAULT);
1754         my $data = $self->{config}->{items}->{bib_source};
1755         if ($data) {
1756             $data = $data->[0] if (ref($data) eq 'ARRAY');
1757             my $result;
1758             if (ref $data) {
1759                 $result = $U->simplereq(
1760                     'open-ils.pcrud',
1761                     'open-ils.pcrud.retrieve.cbs',
1762                     $self->{session}->{authtoken},
1763                     $data->{cbs}
1764                 );
1765             } else {
1766                 $result = $U->simplereq(
1767                     'open-ils.pcrud',
1768                     'open-ils.pcrud.search.cbs',
1769                     $self->{session}->{authtoken},
1770                     {source => $data}
1771                 );
1772             }
1773             $self->{bib_source} = $result if ($result);
1774         }
1775     }
1776
1777     # Load the required asset.stat_cat_entries:
1778     $self->{stat_cat_entries} = [];
1779     # First, make a regex for our ou and ancestors:
1780     my $ancestors = join("|", @{$U->get_org_ancestors($self->{session}->{work_ou}->id())});
1781     my $re = qr/(?:$ancestors)/;
1782     # Get the uniq stat_cat ids from the configuration:
1783     my @cats = uniq map {$_->{stat_cat}} @{$self->{config}->{items}->{stat_cat_entry}};
1784     # Retrieve all of the fleshed stat_cats and entries for the above.
1785     my $stat_cats = $U->simplereq(
1786         'open-ils.circ',
1787         'open-ils.circ.stat_cat.asset.retrieve.batch',
1788         $self->{session}->{authtoken},
1789         @cats
1790     );
1791     foreach my $entry (@{$self->{config}->{items}->{stat_cat_entry}}) {
1792         # Must have the stat_cat attr and the name, so we must have a
1793         # reference.
1794         next unless(ref $entry);
1795         my ($stat) = grep {$_->id() == $entry->{stat_cat}} @$stat_cats;
1796         push(@{$self->{stat_cat_entries}}, grep {$_->owner() =~ $re && $_->value() eq $entry->{content}} @{$stat->entries()});
1797     }
1798 }
1799
1800 # Standalone, "helper" functions.  These do not take an object or
1801 # class reference.
1802
1803 # Check if a user is past their expiration date.
1804 sub _expired {
1805     my $user = shift;
1806     my $expired = 0;
1807
1808     # Users might not expire.  If so, they have no expire_date.
1809     if ($user->expire_date()) {
1810         my $expires = DateTime::Format::ISO8601->parse_datetime(
1811             cleanse_ISO8601($user->expire_date())
1812         )->epoch();
1813         my $now = DateTime->now()->epoch();
1814         $expired = $now > $expires;
1815     }
1816
1817     return $expired;
1818 }
1819
1820 # Creates a NCIP Problem from an event. Takes a string for the problem
1821 # type, the event hashref (or a string to use for the detail), and
1822 # optional arguments for the ProblemElement and ProblemValue fields.
1823 sub _problem_from_event {
1824     my ($type, $evt, $element, $value) = @_;
1825
1826     my $detail;
1827
1828     # Check the event.
1829     if (ref($evt)) {
1830         my ($textcode, $desc);
1831
1832         # Get the textcode, if available. We favor those defined in
1833         # ils_events.xml over those made up on the fly.
1834         if ($evt->{ilsevent} && $evt->{ilsevent}->{textcode}) {
1835             $textcode = $evt->{ilsevent}->{textcode};
1836         } elsif ($evt->{textcode}) {
1837             $textcode = $evt->{textcode};
1838         }
1839
1840         # Get the description. We favor translated descriptions over
1841         # the English in ils_events.xml.
1842         if ($evt->{desc}) {
1843             $desc = $evt->{desc};
1844         } elsif ($evt->{ilsevent} && $evt->{ilsevent}->{desc}) {
1845             $desc = $evt->{ilsevent}->{desc};
1846         }
1847
1848         # Check if $type was set. As an "undocumented" feature, you
1849         # can pass undef, and we'll use the textcode from the event.
1850         unless ($type) {
1851             if ($textcode) {
1852                 $type = $textcode;
1853             } else {
1854                 # Because we have to give them something.
1855                 $type = 'Temporary Processing Failure';
1856             }
1857         }
1858
1859         # Set the detail from some combination of the above.
1860         if ($desc) {
1861             $detail = $desc;
1862         } elsif ($textcode eq 'PERM_FAILURE') {
1863             if ($evt->{ilsperm}) {
1864                 $detail = "Permission denied: " . $evt->{ilsperm};
1865                 $detail =~ s/\.override$//;
1866             }
1867         } elsif ($textcode) {
1868             $detail = "ILS returned $textcode error.";
1869         } else {
1870             $detail = 'Detail not available.';
1871         }
1872
1873     } else {
1874         $detail = $evt;
1875     }
1876
1877     return NCIP::Problem->new(
1878         {
1879             ProblemType => $type,
1880             ProblemDetail => $detail,
1881             ProblemElement => ($element) ? $element : 'NULL',
1882             ProblemValue => ($value) ? $value : 'NULL'
1883         }
1884     );
1885 }
1886
1887 1;