4fb15e8d959772cd5b3d49c1e4e4fa8cb6eedaaa
[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::Utils qw/:datetime/;
28 use OpenSRF::Utils::SettingsClient;
29 use OpenILS::Utils::Fieldmapper;
30 use OpenILS::Utils::CStoreEditor qw/:funcs/;
31 use OpenILS::Application::AppUtils;
32 use OpenILS::Const qw/:const/;
33 use MARC::Record;
34 use MARC::Field;
35 use MARC::File::XML;
36
37 # We need a bunch of NCIP::* objects.
38 use NCIP::Response;
39 use NCIP::Problem;
40 use NCIP::User;
41 use NCIP::User::OptionalFields;
42 use NCIP::User::AddressInformation;
43 use NCIP::User::Id;
44 use NCIP::User::BlockOrTrap;
45 use NCIP::User::Privilege;
46 use NCIP::User::PrivilegeStatus;
47 use NCIP::StructuredPersonalUserName;
48 use NCIP::StructuredAddress;
49 use NCIP::ElectronicAddress;
50
51 # Inherit from NCIP::ILS.
52 use parent qw(NCIP::ILS);
53
54 # Default values we define for things that might be missing in our
55 # runtime environment or configuration file that absolutely must have
56 # values.
57 #
58 # OILS_NCIP_CONFIG_DEFAULT is the default location to find our
59 # driver's configuration file.  This location can be overridden by
60 # setting the path in the OILS_NCIP_CONFIG environment variable.
61 #
62 # BIB_SOURCE_DEFAULT is the config.bib_source.id to use when creating
63 # "short" bibs.  It is used only if no entry is supplied in the
64 # configuration file.  The provided default is 2, the id of the
65 # "System Local" source that comes with a default Evergreen
66 # installation.
67 use constant {
68     OILS_NCIP_CONFIG_DEFAULT => '/openils/conf/oils_ncip.xml',
69     BIB_SOURCE_DEFAULT => 2
70 };
71
72 # A common Evergreen code shortcut to use AppUtils:
73 my $U = 'OpenILS::Application::AppUtils';
74
75 # The usual constructor:
76 sub new {
77     my $class = shift;
78     $class = ref($class) if (ref $class);
79
80     # Instantiate our parent with the rest of the arguments.  It
81     # creates a blessed hashref.
82     my $self = $class->SUPER::new(@_);
83
84     # Look for our configuration file, load, and parse it:
85     $self->_configure();
86
87     # Bootstrap OpenSRF and prepare some OpenILS components.
88     $self->_bootstrap();
89
90     # Initialize the rest of our internal state.
91     $self->_init();
92
93     return $self;
94 }
95
96 sub lookupuser {
97     my $self = shift;
98     my $request = shift;
99
100     # Check our session and login if necessary.
101     $self->login() unless ($self->checkauth());
102
103     my $message_type = $self->parse_request_type($request);
104
105     # Let's go ahead and create our response object. We need this even
106     # if there is a problem.
107     my $response = NCIP::Response->new({type => $message_type . "Response"});
108     $response->header($self->make_header($request));
109
110     # Need to parse the request object to get the barcode and other
111     # data out.
112     my $barcode = $self->find_barcode($request);
113
114     # If we can't find a barcode, report a problem.
115     unless ($barcode) {
116         # Fill in a problem object and stuff it in the response.
117         my $problem = NCIP::Problem->new();
118         $problem->ProblemType('Needed Data Missing');
119         $problem->ProblemDetail('Cannot find user barcode in message.');
120         $problem->ProblemElement('AuthenticationInputType');
121         $problem->ProblemValue('Barcode');
122         $response->problem($problem);
123         return $response;
124     }
125
126     # Look up our patron by barcode:
127     my $user = $U->simplereq(
128         'open-ils.actor',
129         'open-ils.actor.user.fleshed.retrieve_by_barcode',
130         $self->{session}->{authtoken},
131         $barcode,
132         0
133     );
134
135     # Check for a failure, or a deleted, inactive, or expired user,
136     # and if so, return empty userdata.
137     if (!$user || $U->event_code($user) || $U->is_true($user->deleted())
138             || !grep {$_->barcode() eq $barcode && $U->is_true($_->active())} @{$user->cards()}) {
139
140         my $problem = NCIP::Problem->new();
141         $problem->ProblemType('Unknown User');
142         $problem->ProblemDetail("User with barcode $barcode unknown");
143         $problem->ProblemElement('AuthenticationInputData');
144         $problem->ProblemValue($barcode);
145         $response->problem($problem);
146         return $response;
147     }
148
149     # We got the information, so lets fill in our userdata.
150     my $userdata = NCIP::User->new();
151
152     # Make an array of the user's active barcodes.
153     my $ids = [];
154     foreach my $card (@{$user->cards()}) {
155         if ($U->is_true($card->active())) {
156             my $id = NCIP::User::Id->new({
157                 UserIdentifierType => 'Barcode',
158                 UserIdentifierValue => $card->barcode()
159             });
160             push(@$ids, $id);
161         }
162     }
163     $userdata->UserId($ids);
164
165     # Check if they requested any optional fields and return those.
166     my $elements = $request->{$message_type}->{UserElementType};
167     if ($elements) {
168         $elements = [$elements] unless (ref $elements eq 'ARRAY');
169         my $optionalfields = NCIP::User::OptionalFields->new();
170
171         # First, we'll look for name information.
172         if (grep {$_ eq 'Name Information'} @$elements) {
173             my $name = NCIP::StructuredPersonalUserName->new();
174             $name->Surname($user->family_name());
175             $name->GivenName($user->first_given_name());
176             $name->Prefix($user->prefix());
177             $name->Suffix($user->suffix());
178             $optionalfields->NameInformation($name);
179         }
180
181         # Next, check for user address information.
182         if (grep {$_ eq 'User Address Information'} @$elements) {
183             my $addresses = [];
184
185             # See if the user has any valid, physcial addresses.
186             foreach my $addr (@{$user->addresses()}) {
187                 next if ($U->is_true($addr->pending()));
188                 my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>$addr->address_type()});
189                 my $physical = NCIP::StructuredAddress->new();
190                 $physical->Line1($addr->street1());
191                 $physical->Line2($addr->street2());
192                 $physical->Locality($addr->city());
193                 $physical->Region($addr->state());
194                 $physical->PostalCode($addr->post_code());
195                 $physical->Country($addr->country());
196                 $address->PhysicalAddress($physical);
197                 push @$addresses, $address;
198             }
199
200             # Right now, we're only sharing email address if the user
201             # has it. We don't share phone numbers.
202             if ($user->email()) {
203                 my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>'Email Address'});
204                 $address->ElectronicAddress(
205                     NCIP::ElectronicAddress->new({
206                         Type=>'Email Address',
207                         Data=>$user->email()
208                     })
209                 );
210                 push @$addresses, $address;
211             }
212
213             $optionalfields->UserAddressInformation($addresses);
214         }
215
216         # Fetch the user's home_ou. We'll need for a couple of things
217         # below here.
218         my $aou = $self->editor->retrieve_actor_org_unit($user->home_ou());
219
220         # Check for User Privilege.
221         if (grep {$_ eq 'User Privilege'} @$elements) {
222             # Get the user's group:
223             my $pgt = $self->editor->retrieve_permission_grp_tree($user->profile());
224             if ($pgt) {
225                 my $privilege = NCIP::User::Privilege->new();
226                 $privilege->AgencyId($aou->shortname());
227                 $privilege->AgencyUserPrivilegeType($pgt->name());
228                 $privilege->ValidToDate($user->expire_date());
229
230                 my $status = 'Active';
231                 if (_expired($user)) {
232                     $status = 'Expired';
233                 } elsif ($U->is_true($user->barred())) {
234                     $status = 'Barred';
235                 } elsif (!$U->is_true($user->active())) {
236                     $status = 'Inactive';
237                 }
238                 if ($status) {
239                     $privilege->UserPrivilegeStatus(
240                         NCIP::User::PrivilegeStatus->new({
241                             UserPrivilegeStatusType => $status
242                         })
243                     );
244                 }
245
246                 $optionalfields->UserPrivilege([$privilege]);
247             }
248         }
249
250         # Check for Block Or Trap.
251         if (grep {$_ eq 'Block Or Trap'} @$elements) {
252             my $blocks = [];
253
254             # First, let's check if the profile is blocked from ILL.
255             if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
256                 my $block = NCIP::User::BlockOrTrap->new();
257                 $block->AgencyId($aou->shortname());
258                 $block->BlockOrTrapType('Block Interlibrary Loan');
259                 push @$blocks, $block;
260             }
261
262             # Next, we loop through the user's standing penalties
263             # looking for blocks on CIRC, HOLD, and RENEW.
264             my ($have_circ, $have_renew, $have_hold) = (0,0,0);
265             foreach my $penalty (@{$user->standing_penalties()}) {
266                 next unless($penalty->standing_penalty->block_list());
267                 my @block_list = split(/\|/, $penalty->standing_penalty->block_list());
268                 my $ou = $self->editor->retrieve_actor_org_unit($penalty->org_unit());
269
270                 # Block checkout.
271                 if (!$have_circ && grep {$_ eq 'CIRC'} @block_list) {
272                     my $bot = NCIP::User::BlockOrTrap->new();
273                     $bot->AgencyId($ou->shortname());
274                     $bot->BlockOrTrapType('Block Checkout');
275                     push @$blocks, $bot;
276                     $have_circ = 1;
277                 }
278
279                 # Block holds.
280                 if (!$have_hold && grep {$_ eq 'HOLD' || $_ eq 'FULFILL'} @block_list) {
281                     my $bot = NCIP::User::BlockOrTrap->new();
282                     $bot->AgencyId($ou->shortname());
283                     $bot->BlockOrTrapType('Block Holds');
284                     push @$blocks, $bot;
285                     $have_hold = 1;
286                 }
287
288                 # Block renewals.
289                 if (!$have_renew && grep {$_ eq 'RENEW'} @block_list) {
290                     my $bot = NCIP::User::BlockOrTrap->new();
291                     $bot->AgencyId($ou->shortname());
292                     $bot->BlockOrTrapType('Block Renewals');
293                     push @$blocks, $bot;
294                     $have_renew = 1;
295                 }
296
297                 # Stop after we report one of each, even if more
298                 # blocks remain.
299                 last if ($have_circ && $have_renew && $have_hold);
300             }
301
302             $optionalfields->BlockOrTrap($blocks);
303         }
304
305         $userdata->UserOptionalFields($optionalfields);
306     }
307
308     $response->data($userdata);
309
310     return $response;
311 }
312
313 # Implementation functions that might be useful to a subclass.
314
315 # Get a CStoreEditor:
316 sub editor {
317     my $self = shift;
318
319     # If we have an editor, check the validity of the auth session, then
320     # invalidate the editor if the session is not valid.
321     if ($self->{editor}) {
322         undef($self->{editor}) unless ($self->checkauth());
323     }
324
325     # If we don't have an editor, make a new one.
326     unless (defined($self->{editor})) {
327         $self->login() unless ($self->checkauth());
328         $self->{editor} = new_editor(authtoken=>$self->{session}->{authtoken});
329     }
330
331     return $self->{editor};
332 }
333
334 # Login via OpenSRF to Evergreen.
335 sub login {
336     my $self = shift;
337
338     # Get the authentication seed.
339     my $seed = $U->simplereq(
340         'open-ils.auth',
341         'open-ils.auth.authenticate.init',
342         $self->{config}->{credentials}->{username}
343     );
344
345     # Actually login.
346     if ($seed) {
347         my $response = $U->simplereq(
348             'open-ils.auth',
349             'open-ils.auth.authenticate.complete',
350             {
351                 username => $self->{config}->{credentials}->{username},
352                 password => md5_hex(
353                     $seed . md5_hex($self->{config}->{credentials}->{password})
354                 ),
355                 type => 'staff',
356                 workstation => $self->{config}->{credentials}->{workstation}
357             }
358         );
359         if ($response) {
360             $self->{session}->{authtoken} = $response->{payload}->{authtoken};
361             $self->{session}->{authtime} = $response->{payload}->{authtime};
362         }
363     }
364 }
365
366 # Return 1 if we have a 'valid' authtoken, 0 if not.
367 sub checkauth {
368     my $self = shift;
369
370     # We implement our own version of this function, rather than rely
371     # on CStoreEditor, because we may want to check this at times that
372     # we don't have a CStoreEditor.
373
374     # We use AppUtils to do the heavy lifting.
375     if (defined($self->{session})) {
376         if ($U->check_user_session($self->{session}->{authtoken})) {
377             return 1;
378         } else {
379             return 0;
380         }
381     }
382
383     # If we reach here, we don't have a session, so we are definitely
384     # not logged in.
385     return 0;
386 }
387
388 # private subroutines not meant to be used directly by subclasses.
389 # Most have to do with setup and/or state checking of implementation
390 # components.
391
392 # Find, load, and parse our configuration file:
393 sub _configure {
394     my $self = shift;
395
396     # Find the configuration file via variables:
397     my $file = OILS_NCIP_CONFIG_DEFAULT;
398     $file = $ENV{OILS_NCIP_CONFIG} if ($ENV{OILS_NCIP_CONFIG});
399
400     $self->{config} = XMLin($file, NormaliseSpace => 2,
401                             ForceArray => ['block_profile', 'stat_cat_entry']);
402 }
403
404 # Bootstrap OpenSRF::System, load the IDL, and initialize the
405 # CStoreEditor module.
406 sub _bootstrap {
407     my $self = shift;
408
409     my $bootstrap_config = $self->{config}->{bootstrap};
410     OpenSRF::System->bootstrap_client(config_file => $bootstrap_config);
411
412     my $idl = OpenSRF::Utils::SettingsClient->new->config_value("IDL");
413     Fieldmapper->import(IDL => $idl);
414
415     OpenILS::Utils::CStoreEditor->init;
416 }
417
418 # Login and then initialize some object data based on the
419 # configuration.
420 sub _init {
421     my $self = shift;
422
423     # Login to Evergreen.
424     $self->login();
425
426     # Create an editor.
427     my $e = $self->editor();
428
429     # Retrieve the work_ou as an object.
430     my $work_ou = $e->search_actor_org_unit(
431         {shortname => $self->{config}->{credentials}->{work_ou}}
432     );
433     $self->{work_ou} = $work_ou->[0] if ($work_ou && @$work_ou);
434
435     # Load the barred groups as pgt objects into a blocked_profiles
436     # list.
437     $self->{blocked_profiles} = [];
438     foreach (@{$self->{config}->{patrons}->{block_profile}}) {
439         if (ref $_) {
440             my $pgt = $e->retrieve_permission_grp_tree($_->{grp});
441             push(@{$self->{blocked_profiles}}, $pgt) if ($pgt);
442         } else {
443             my $result = $e->search_permission_grp_tree({name => $_});
444             if ($result && @$result) {
445                 map {push(@{$self->{blocked_profiles}}, $_)} @$result;
446             }
447         }
448     }
449
450     # Load the bib source if we're not using precats.
451     unless ($self->{config}->{items}->{use_precats}) {
452         # Retrieve the default
453         my $cbs = $e->retrieve_config_bib_source(BIB_SOURCE_DEFAULT);
454         my $data = $self->{config}->{items}->{bib_source};
455         if ($data) {
456             $data = $data->[0] if (ref($data) eq 'ARRAY');
457             if (ref $data) {
458                 my $result = $e->retrieve_config_bib_source($data->{cbs});
459                 $cbs = $result if ($result);
460             } else {
461                 my $result = $e->search_config_bib_source({source => $data});
462                 if ($result && @$result) {
463                     $cbs = $result->[0]; # Use the first one.
464                 }
465             }
466         }
467         $self->{bib_source} = $cbs;
468     }
469
470     # Load the required asset.stat_cat_entries:
471     $self->{stat_cat_entries} = [];
472     foreach (@{$self->{config}->{items}->{stat_cat_entry}}) {
473         # Must have the stat_cat attr and the name, so we must have a
474         # reference.
475         next unless(ref $_);
476         # We want to limit the search to the work org and its
477         # ancestors.
478         my $ancestors = $U->get_org_ancestors($self->{work_ou}->id());
479         my $result = $e->search_asset_stat_cat_entry(
480             {
481                 stat_cat => $_->{stat_cat},
482                 value => $_->{content},
483                 owner => $ancestors
484             }
485         );
486         if ($result && @$result) {
487             map {push(@{$self->{stat_cat_entries}}, $_)} @$result;
488         }
489     }
490 }
491
492 # Standalone, "helper" functions.  These do not take an object or
493 # class reference.
494
495 # Check if a user is past their expiration date.
496 sub _expired {
497     my $user = shift;
498     my $expired = 0;
499
500     # Users might not expire.  If so, they have no expire_date.
501     if ($user->expire_date()) {
502         my $expires = DateTime::Format::ISO8601->parse_datetime(
503             cleanse_ISO8601($user->expire_date())
504         )->epoch();
505         my $now = DateTime->now()->epoch();
506         $expired = $now > $expires;
507     }
508
509     return $expired;
510 }
511
512 1;