]> git.evergreen-ils.org Git - Evergreen.git/blob - Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader/Util.pm
Consistent response type from TPAC pref lib lookup
[Evergreen.git] / Open-ILS / src / perlmods / lib / OpenILS / WWW / EGCatLoader / Util.pm
1 package OpenILS::WWW::EGCatLoader;
2 use strict; use warnings;
3 use Apache2::Const -compile => qw(OK DECLINED FORBIDDEN HTTP_INTERNAL_SERVER_ERROR REDIRECT HTTP_BAD_REQUEST);
4 use File::Spec;
5 use OpenSRF::Utils::Logger qw/$logger/;
6 use OpenILS::Utils::CStoreEditor qw/:funcs/;
7 use OpenILS::Utils::Fieldmapper;
8 use OpenILS::Application::AppUtils;
9 use OpenSRF::MultiSession;
10 my $U = 'OpenILS::Application::AppUtils';
11
12 my $ro_object_subs; # cached subs
13 our %cache = ( # cached data
14     map => {en_us => {}},
15     list => {en_us => {}},
16     search => {en_us => {}},
17     org_settings => {en_us => {}},
18     search_filter_groups => {en_us => {}},
19     aou_tree => {en_us => undef},
20     aouct_tree => {},
21     eg_cache_hash => undef
22 );
23
24 sub init_ro_object_cache {
25     my $self = shift;
26     my $e = $self->editor;
27     my $ctx = $self->ctx;
28
29     # reset org unit setting cache on each page load to avoid the
30     # requirement of reloading apache with each org-setting change
31     $cache{org_settings} = {};
32
33     if($ro_object_subs) {
34         # subs have been built.  insert into the context then move along.
35         $ctx->{$_} = $ro_object_subs->{$_} for keys %$ro_object_subs;
36         return;
37     }
38
39     # make all "field_safe" classes accesible by default in the template context
40     my @classes = grep {
41         ($Fieldmapper::fieldmap->{$_}->{field_safe} || '') =~ /true/i
42     } keys %{ $Fieldmapper::fieldmap };
43
44     for my $class (@classes) {
45
46         my $hint = $Fieldmapper::fieldmap->{$class}->{hint};
47         next if $hint eq 'aou'; # handled separately
48
49         my $ident_field =  $Fieldmapper::fieldmap->{$class}->{identity};
50         (my $eclass = $class) =~ s/Fieldmapper:://o;
51         $eclass =~ s/::/_/g;
52
53         my $list_key = "${hint}_list";
54         my $get_key = "get_$hint";
55         my $search_key = "search_$hint";
56
57         # Retrieve the full set of objects with class $hint
58         $ro_object_subs->{$list_key} = sub {
59             my $method = "retrieve_all_$eclass";
60             $cache{list}{$ctx->{locale}}{$hint} = $e->$method() unless $cache{list}{$ctx->{locale}}{$hint};
61             return $cache{list}{$ctx->{locale}}{$hint};
62         };
63
64         # locate object of class $hint with Ident field $id
65         $cache{map}{$hint} = {};
66         $ro_object_subs->{$get_key} = sub {
67             my $id = shift;
68             return $cache{map}{$ctx->{locale}}{$hint}{$id} if $cache{map}{$ctx->{locale}}{$hint}{$id};
69             ($cache{map}{$ctx->{locale}}{$hint}{$id}) = grep { $_->$ident_field eq $id } @{$ro_object_subs->{$list_key}->()};
70             return $cache{map}{$ctx->{locale}}{$hint}{$id};
71         };
72
73         # search for objects of class $hint where field=value
74         $cache{search}{$hint} = {};
75         $ro_object_subs->{$search_key} = sub {
76             my ($field, $val, $filterfield, $filterval) = @_;
77             my $method = "search_$eclass";
78             my $cacheval = $val;
79             if (ref $val) {
80                 $val = [sort(@$val)] if ref $val eq 'ARRAY';
81                 $cacheval = OpenSRF::Utils::JSON->perl2JSON($val);
82                 #$self->apache->log->info("cacheval : $cacheval");
83             }
84             my $search_obj = {$field => $val};
85             if($filterfield) {
86                 $search_obj->{$filterfield} = $filterval;
87                 $cacheval .= ':' . $filterfield . ':' . $filterval;
88             }
89             #$cache{search}{$ctx->{locale}}{$hint}{$field} = {} unless $cache{search}{$ctx->{locale}}{$hint}{$field};
90             $cache{search}{$ctx->{locale}}{$hint}{$field}{$cacheval} = $e->$method($search_obj)
91                 unless $cache{search}{$ctx->{locale}}{$hint}{$field}{$cacheval};
92             return $cache{search}{$ctx->{locale}}{$hint}{$field}{$cacheval};
93         };
94     }
95
96     $ro_object_subs->{aou_tree} = sub {
97
98         # fetch the org unit tree
99         unless($cache{aou_tree}{$ctx->{locale}}) {
100             my $tree = $e->search_actor_org_unit([
101                             {   parent_ou => undef},
102                             {   flesh            => -1,
103                                     flesh_fields    => {aou =>  ['children']},
104                                     order_by        => {aou => 'name'}
105                             }
106                     ])->[0];
107
108             # flesh the org unit type for each org unit
109             # and simultaneously set the id => aou map cache
110             sub flesh_aout {
111                 my $node = shift;
112                 my $ro_object_subs = shift;
113                 my $ctx = shift;
114                 $node->ou_type( $ro_object_subs->{get_aout}->($node->ou_type) );
115                 $cache{map}{$ctx->{locale}}{aou}{$node->id} = $node;
116                 flesh_aout($_, $ro_object_subs, $ctx) foreach @{$node->children};
117             };
118             flesh_aout($tree, $ro_object_subs, $ctx);
119
120             $cache{aou_tree}{$ctx->{locale}} = $tree;
121         }
122
123         return $cache{aou_tree}{$ctx->{locale}};
124     };
125
126     # Add a special handler for the tree-shaped org unit cache
127     $ro_object_subs->{get_aou} = sub {
128         my $org_id = shift;
129         return undef unless defined $org_id;
130         $ro_object_subs->{aou_tree}->(); # force the org tree to load
131         return $cache{map}{$ctx->{locale}}{aou}{$org_id};
132     };
133
134     # Returns a flat list of aou objects.  often easier to manage than a tree.
135     $ro_object_subs->{aou_list} = sub {
136         $ro_object_subs->{aou_tree}->(); # force the org tree to load
137         return [ values %{$cache{map}{$ctx->{locale}}{aou}} ];
138     };
139
140     # returns the org unit object by shortname
141     $ro_object_subs->{get_aou_by_shortname} = sub {
142         my $sn = shift or return undef;
143         my $list = $ro_object_subs->{aou_list}->();
144         return (grep {$_->shortname eq $sn} @$list)[0];
145     };
146
147     $ro_object_subs->{aouct_tree} = sub {
148
149         # fetch the org unit tree
150         unless(exists $cache{aouct_tree}{$ctx->{locale}}) {
151             $cache{aouct_tree}{$ctx->{locale}} = undef;
152
153             my $tree_id = $e->search_actor_org_unit_custom_tree(
154                 {purpose => 'opac', active => 't'},
155                 {idlist => 1}
156             )->[0];
157
158             if ($tree_id) {
159                 my $node_tree = $e->search_actor_org_unit_custom_tree_node([
160                 {parent_node => undef, tree => $tree_id},
161                 {   flesh        => -1,
162                     flesh_fields => {aouctn => ['children', 'org_unit']},
163                     order_by     => {aouctn => 'sibling_order'}
164                 }
165                 ])->[0];
166
167                 # tree-ify the org units.  note that since the orgs are fleshed
168                 # upon retrieval, this org tree will not clobber ctx->{aou_tree}.
169                 my @nodes = ($node_tree);
170                 while (my $node = shift(@nodes)) {
171                     my $aou = $node->org_unit;
172                     $aou->children([]);
173                     for my $cnode (@{$node->children}) {
174                         my $child_org = $cnode->org_unit;
175                         $child_org->parent_ou($aou->id);
176                         $child_org->ou_type( $ro_object_subs->{get_aout}->($child_org->ou_type) );
177                         push(@{$aou->children}, $child_org);
178                         push(@nodes, $cnode);
179                     }
180                 }
181
182                 $cache{aouct_tree}{$ctx->{locale}} = $node_tree->org_unit;
183             }
184         }
185
186         return $cache{aouct_tree}{$ctx->{locale}};
187     };
188
189     # turns an ISO date into something TT can understand
190     $ro_object_subs->{parse_datetime} = sub {
191         my $date = shift;
192
193         # Probably an accidental entry like '0212' instead of '2012',
194         # but 1) the leading 0 may get stripped in cstore and
195         # 2) DateTime::Format::ISO8601 returns an error as years
196         # must be 2 or 4 digits
197         if ($date =~ m/^\d{3}-/) {
198             $logger->warn("Invalid date had a 3-digit year: $date");
199             $date = '0' . $date;
200         } elsif ($date =~ m/^\d{1}-/) {
201             $logger->warn("Invalid date had a 1-digit year: $date");
202             $date = '000' . $date;
203         }
204
205         my $cleansed_date = cleanse_ISO8601($date);
206
207         $date = DateTime::Format::ISO8601->new->parse_datetime($cleansed_date);
208         return sprintf(
209             "%0.2d:%0.2d:%0.2d %0.2d-%0.2d-%0.4d",
210             $date->hour,
211             $date->minute,
212             $date->second,
213             $date->day,
214             $date->month,
215             $date->year
216         );
217     };
218
219     # retrieve and cache org unit setting values
220     $ro_object_subs->{get_org_setting} = sub {
221         my($org_id, $setting) = @_;
222
223         $cache{org_settings}{$ctx->{locale}}{$org_id}{$setting} =
224             $U->ou_ancestor_setting_value($org_id, $setting)
225                 unless exists $cache{org_settings}{$ctx->{locale}}{$org_id}{$setting};
226
227         return $cache{org_settings}{$ctx->{locale}}{$org_id}{$setting};
228     };
229
230     $ctx->{$_} = $ro_object_subs->{$_} for keys %$ro_object_subs;
231 }
232
233 sub generic_redirect {
234     my $self = shift;
235     my $url = shift;
236     my $cookie = shift; # can be an array of cgi.cookie's
237
238     $self->apache->print(
239         $self->cgi->redirect(
240             -url => $url || 
241                 $self->cgi->param('redirect_to') || 
242                 $self->ctx->{referer} || 
243                 $self->ctx->{home_page},
244             -cookie => $cookie
245         )
246     );
247
248     return Apache2::Const::REDIRECT;
249 }
250
251 sub get_records_and_facets {
252     my ($self, $rec_ids, $facet_key, $unapi_args) = @_;
253
254     $unapi_args ||= {};
255     $unapi_args->{site} ||= $self->ctx->{aou_tree}->()->shortname;
256     $unapi_args->{depth} ||= $self->ctx->{aou_tree}->()->ou_type->depth;
257     $unapi_args->{flesh_depth} ||= 5;
258
259     my @data;
260     my $outer_self = $self;
261     $self->timelog("get_records_and_facets(): about to call multisession");
262     my $ses = OpenSRF::MultiSession->new(
263         app => 'open-ils.cstore',
264         cap => 10, # XXX config
265         success_handler => sub {
266             my($self, $req) = @_;
267             my $data = $req->{response}->[0]->content;
268
269             $outer_self->timelog("get_records_and_facets(): got response content");
270
271             # Protect against requests for non-existent records
272             return unless $data->{'unapi.bre'};
273
274             my $xml = XML::LibXML->new->parse_string($data->{'unapi.bre'})->documentElement;
275
276             $outer_self->timelog("get_records_and_facets(): parsed xml");
277             # Protect against legacy invalid MARCXML that might not have a 901c
278             my $bre_id;
279             my $bre_id_nodes =  $xml->find('*[@tag="901"]/*[@code="c"]');
280             if ($bre_id_nodes) {
281                 $bre_id =  $bre_id_nodes->[0]->textContent;
282             } else {
283                 $logger->warn("Missing 901 subfield 'c' in " . $xml->toString());
284             }
285             push(@data, {id => $bre_id, marc_xml => $xml});
286             $outer_self->timelog("get_records_and_facets(): end of success handler");
287         }
288     );
289
290     $self->timelog("get_records_and_facets(): about to call unapi.bre via json_query (rec_ids has " . scalar(@$rec_ids));
291
292     $ses->request(
293         'open-ils.cstore.json_query',
294          {from => [
295             'unapi.bre', $_, 'marcxml','record', 
296             $unapi_args->{flesh}, 
297             $unapi_args->{site}, 
298             $unapi_args->{depth}, 
299             'acn=>' . $unapi_args->{flesh_depth} . ',acp=>' . $unapi_args->{flesh_depth}, 
300             undef, undef, $unapi_args->{pref_lib}
301         ]}
302     ) for @$rec_ids;
303
304
305     $self->timelog("get_records_and_facets():almost ready to fetch facets");
306     # collect the facet data
307     my $search = OpenSRF::AppSession->create('open-ils.search');
308     my $facet_req = $search->request(
309         'open-ils.search.facet_cache.retrieve', $facet_key
310     ) if $facet_key;
311
312     # gather up the unapi recs
313     $ses->session_wait(1);
314     $self->timelog("get_records_and_facets():past session wait");
315
316     my $facets = {};
317     if ($facet_key) {
318         my $tmp_facets = $facet_req->gather(1);
319         $self->timelog("get_records_and_facets(): gathered facet data");
320         for my $cmf_id (keys %$tmp_facets) {
321
322             # sort highest to lowest match count
323             my @entries;
324             my $entries = $tmp_facets->{$cmf_id};
325             for my $ent (keys %$entries) {
326                 push(@entries, {value => $ent, count => $$entries{$ent}});
327             };
328
329             # Sort facet entries by 1) count descending, 2) text ascending
330             @entries = sort {
331                 $b->{count} <=> $a->{count} ||
332                 $a->{value} cmp $b->{value}
333             } @entries;
334
335             $facets->{$cmf_id} = {
336                 cmf => $self->ctx->{get_cmf}->($cmf_id),
337                 data => \@entries
338             }
339         }
340         $self->timelog("get_records_and_facets(): gathered/sorted facet data");
341     } else {
342         $facets = undef;
343     }
344
345     $search->kill_me;
346
347     return ($facets, @data);
348 }
349
350 sub _get_search_lib {
351     my $self = shift;
352     my $ctx = $self->ctx;
353
354     # avoid duplicate lookups
355     return $ctx->{search_ou} if $ctx->{search_ou};
356
357     my $loc = $ctx->{copy_location_group_org};
358     return $loc if $loc;
359
360     # loc param takes precedence
361     $loc = $self->cgi->param('loc');
362     return $loc if $loc;
363
364     if ($self->apache->headers_in->get('OILS-Search-Lib')) {
365         return $self->apache->headers_in->get('OILS-Search-Lib');
366     }
367
368     my $pref_lib = $self->_get_pref_lib();
369     return $pref_lib if $pref_lib;
370
371     return $ctx->{aou_tree}->()->id;
372 }
373
374 sub _get_pref_lib {
375     my $self = shift;
376     my $ctx = $self->ctx;
377
378     # plib param takes precedence
379     my $plib = $self->cgi->param('plib');
380     return $plib if $plib;
381
382     if ($self->apache->headers_in->get('OILS-Pref-Lib')) {
383         return $self->apache->headers_in->get('OILS-Pref-Lib');
384     }
385
386     if ($ctx->{user}) {
387         # See if the user has a search library preference
388         my $lset = $self->editor->search_actor_user_setting({
389             usr => $ctx->{user}->id, 
390             name => 'opac.default_search_location'
391         })->[0];
392         return OpenSRF::Utils::JSON->JSON2perl($lset->value) if $lset;
393
394         # Otherwise return the user's home library
395         my $ou = $ctx->{user}->home_ou;
396         return ref($ou) ? $ou->id : $ou;
397     }
398
399     if ($ctx->{physical_loc}) {
400         return $ctx->{physical_loc};
401     }
402
403 }
404
405 # This is defensively coded since we don't do much manual reading from the
406 # file system in this module.
407 sub load_eg_cache_hash {
408     my ($self) = @_;
409
410     # just a context helper
411     $self->ctx->{eg_cache_hash} = sub { return $cache{eg_cache_hash}; };
412
413     # Need to actually load the value? If already done, move on.
414     return if defined $cache{eg_cache_hash};
415
416     # In this way even if we fail, we won't slow things down by ever trying
417     # again within this Apache process' lifetime.
418     $cache{eg_cache_hash} = 0;
419
420     my $path = File::Spec->catfile(
421         $self->apache->document_root, "eg_cache_hash"
422     );
423
424     if (not open FH, "<$path") {
425         $self->apache->log->warn("error opening $path : $!");
426         return;
427     } else {
428         my $buf;
429         my $rv = read FH, $buf, 64;  # defensive
430         close FH;
431
432         if (not defined $rv) {  # error
433             $self->apache->log->warn("error reading $path : $!");
434         } elsif ($rv > 0) {     # no error, something read
435             chomp $buf;
436             $cache{eg_cache_hash} = $buf;
437         }
438     }
439 }
440
441 # Extracts the copy location org unit and group from the 
442 # "logc" param, which takes the form org_id:grp_id.
443 sub extract_copy_location_group_info {
444     my $self = shift;
445     my $ctx = $self->ctx;
446     if (my $clump = $self->cgi->param('locg')) {
447         my ($org, $grp) = split(/:/, $clump);
448         $ctx->{copy_location_group_org} = $org;
449         $ctx->{copy_location_group} = $grp if $grp;
450     }
451 }
452
453 sub load_copy_location_groups {
454     my $self = shift;
455     my $ctx = $self->ctx;
456
457     # User can access to the search location groups at the current 
458     # search lib, the physical location lib, and the patron's home ou.
459     my @ctx_orgs = $ctx->{search_ou};
460     push(@ctx_orgs, $ctx->{physical_loc}) if $ctx->{physical_loc};
461     push(@ctx_orgs, $ctx->{user}->home_ou) if $ctx->{user};
462
463     my $grps = $self->editor->search_asset_copy_location_group([
464         {
465             opac_visible => 't',
466             owner => {
467                 in => {
468                     select => {aou => [{
469                         column => 'id', 
470                         transform => 'actor.org_unit_full_path',
471                         result_field => 'id',
472                     }]},
473                     from => 'aou',
474                     where => {id => \@ctx_orgs}
475                 }
476             }
477         },
478         {order_by => {acplg => 'pos'}}
479     ]);
480
481     my %buckets;
482     push(@{$buckets{$_->owner}}, $_) for @$grps;
483     $ctx->{copy_location_groups} = \%buckets;
484 }
485
486 sub set_file_download_headers {
487     my $self = shift;
488     my $filename = shift;
489     my $ctype = shift || "text/plain; encoding=utf8";
490
491     $self->apache->content_type($ctype);
492
493     $self->apache->headers_out->add(
494         "Content-Disposition",
495         "attachment;filename=$filename"
496     );
497
498     return Apache2::Const::OK;
499 }
500
501 sub apache_log_if_event {
502     my ($self, $event, $prefix_text, $success_ok, $level) = @_;
503
504     $prefix_text ||= "Evergreen returned event";
505     $success_ok ||= 0;
506     $level ||= "warn";
507
508     chomp $prefix_text;
509     $prefix_text .= ": ";
510
511     my $code = $U->event_code($event);
512     if (defined $code and ($code or not $success_ok)) {
513         $self->apache->log->$level(
514             $prefix_text .
515             ($event->{textcode} || "") . " ($code)" .
516             ($event->{note} ? (": " . $event->{note}) : "")
517         );
518         return 1;
519     }
520
521     return;
522 }
523
524 sub load_search_filter_groups {
525     my $self = shift;
526     my $ctx_org = shift;
527     my $org_list = $U->get_org_ancestors($ctx_org, 1);
528
529     my %seen;
530     for my $org_id (@$org_list) {
531
532         my $grps;
533         if (! ($grps = $cache{search_filter_groups}{$org_id}) ) {
534             $grps = $self->editor->search_actor_search_filter_group([
535                 {owner => $org_id},
536                 {   flesh => 2, 
537                     flesh_fields => {
538                         asfg => ['entries'],
539                         asfge => ['query']
540                     },
541                     order_by => {asfge => 'pos'}
542                 }
543             ]);
544             $cache{search_filter_groups}{$org_id} = $grps;
545         }
546
547         # for the current context, if a descendant org has a group 
548         # with a matching code replace the group from the parent.
549         $seen{$_->code} = $_ for @$grps;
550     }
551
552     return $self->ctx->{search_filter_groups} = \%seen;
553 }
554
555
556 sub check_for_temp_list_warning {
557     my $self = shift;
558     my $ctx = $self->ctx;
559     my $cgi = $self->cgi;
560
561     my $lib = $self->_get_search_lib;
562     my $warn = ($ctx->{get_org_setting}->($lib || 1, 'opac.patron.temporary_list_warn')) ? 1 : 0;
563
564     if ($warn && $ctx->{user}) {
565         $self->_load_user_with_prefs;
566         my $map = $ctx->{user_setting_map};
567         $warn = 0 if ($$map{'opac.temporary_list_no_warn'});
568     }
569
570     # Check for a cookie disabling the warning.
571     $warn = 0 if ($warn && $cgi->cookie('no_temp_list_warn'));
572
573     return $warn;
574 }
575
576 sub load_org_util_funcs {
577     my $self = shift;
578     my $ctx = $self->ctx;
579
580     # evaluates to true if test_ou is within the same depth-
581     # scoped tree as ctx_ou. both ou's are org unit objects.
582     $ctx->{org_within_scope} = sub {
583         my ($ctx_ou, $test_ou, $depth) = @_;
584
585         return 1 if $ctx_ou->id == $test_ou->id;
586
587         if ($depth) {
588
589             # find the top-most ctx-org ancestor at the provided depth
590             while ($depth < $ctx_ou->ou_type->depth 
591                     and $ctx_ou->id != $test_ou->id) {
592                 $ctx_ou = $ctx->{get_aou}->($ctx_ou->parent_ou);
593             }
594
595             # the preceeding loop may have landed on our org
596             return 1 if $ctx_ou->id == $test_ou->id;
597
598         } else {
599
600             return 1 if defined $depth; # $depth == 0;
601         }
602
603         for my $child (@{$ctx_ou->children}) {
604             return 1 if $ctx->{org_within_scope}->($child, $test_ou);
605         }
606
607         return 0;
608     };
609
610     # Returns true if the provided org unit is within the same 
611     # org unit hiding depth-scoped tree as the physical location.
612     # Org unit hiding is based on the immutable physical_loc
613     # and is not meant to change as search/pref/etc libs change
614     $ctx->{org_within_hiding_scope} = sub {
615         my $org_id = shift;
616         my $ploc = $ctx->{physical_loc} or return 1;
617
618         my $depth = $ctx->{get_org_setting}->(
619             $ploc, 'opac.org_unit_hiding.depth');
620
621         return 1 unless $depth; # 0 or undef
622
623         return $ctx->{org_within_scope}->( 
624             $ctx->{get_aou}->($ploc), 
625             $ctx->{get_aou}->($org_id), $depth);
626  
627     };
628
629     # Evaluates to true if the context org (defaults to get_library) 
630     # is not within the hiding scope.  Also evaluates to true if the 
631     # user's pref_ou is set and it's out of hiding scope.
632     # Always evaluates to true when ctx.is_staff
633     $ctx->{org_hiding_disabled} = sub {
634         my $ctx_org = shift || $ctx->{search_ou};
635
636         return 1 if $ctx->{is_staff};
637
638         # beware locg values formatted as org:loc
639         $ctx_org =~ s/:.*//g;
640
641         return 1 if !$ctx->{org_within_hiding_scope}->($ctx_org);
642
643         return 1 if $ctx->{pref_ou} and $ctx->{pref_ou} != $ctx_org 
644             and !$ctx->{org_within_hiding_scope}->($ctx->{pref_ou});
645
646         return 0;
647     };
648
649 }
650
651
652     
653
654
655 1;