LP#1552778: copy some date/time utils from OpenSRF
[working/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 Time::HiRes qw/time sleep/;
6 use OpenSRF::Utils::Cache;
7 use OpenSRF::Utils::Logger qw/$logger/;
8 use OpenILS::Utils::CStoreEditor qw/:funcs/;
9 use OpenILS::Utils::Fieldmapper;
10 use OpenILS::Application::AppUtils;
11 use OpenSRF::MultiSession;
12
13 my $U = 'OpenILS::Application::AppUtils';
14
15 my $ro_object_subs; # cached subs
16 our %cache = ( # cached data
17     map => {en_us => {}},
18     list => {en_us => {}},
19     search => {en_us => {}},
20     org_settings => {en_us => {}},
21     search_filter_groups => {en_us => {}},
22     aou_tree => {en_us => undef},
23     aouct_tree => {},
24     eg_cache_hash => undef,
25     authority_fields => {en_us => {}}
26 );
27
28 sub child_init {
29     my $class = shift;
30     my %locales = @_;
31
32     # create a stub object with just enough in place
33     # to call init_ro_object_cache()
34     my $stub = bless({}, ref($class) || $class);
35     my $ctx = {};
36     $stub->ctx($ctx);
37
38     foreach my $locale (sort keys %locales) {
39         OpenSRF::AppSession->default_locale($locales{$locale});
40         $ctx->{locale} = $locale;
41         $stub->init_ro_object_cache();
42
43         # pre-cache various sets of objects
44         # known to be time-consuming to retrieve
45         # the first go around
46         $ro_object_subs->{$locale}->{aou_tree}();
47         $ro_object_subs->{$locale}->{aouct_tree}();
48         $ro_object_subs->{$locale}->{ccvm_list}();
49         $ro_object_subs->{$locale}->{crad_list}();
50         $ro_object_subs->{$locale}->{get_authority_fields}(1);
51     }
52 }
53
54 sub init_ro_object_cache {
55     my $self = shift;
56     my $ctx = $self->ctx;
57     my $memcache ||= OpenSRF::Utils::Cache->new('global');
58
59     # reset org unit setting cache on each page load to avoid the
60     # requirement of reloading apache with each org-setting change
61     $cache{org_settings} = {};
62
63     if($ro_object_subs->{$ctx->{locale}}) {
64         # subs have been built.  insert into the context then move along.
65         $ctx->{$_} = $ro_object_subs->{$ctx->{locale}}->{$_} for keys %{ $ro_object_subs->{$ctx->{locale}} };
66         return;
67     }
68
69     my $locale_subs = {};
70     my $locale = $ctx->{locale};
71
72     # make all "field_safe" classes accesible by default in the template context
73     my @classes = grep {
74         ($Fieldmapper::fieldmap->{$_}->{field_safe} || '') =~ /true/i
75     } keys %{ $Fieldmapper::fieldmap };
76
77     for my $class (@classes) {
78
79         my $hint = $Fieldmapper::fieldmap->{$class}->{hint};
80         next if $hint eq 'aou'; # handled separately
81
82         my $ident_field =  $Fieldmapper::fieldmap->{$class}->{identity};
83         (my $eclass = $class) =~ s/Fieldmapper:://o;
84         $eclass =~ s/::/_/g;
85
86         my $list_key = "${hint}_list";
87         my $get_key = "get_$hint";
88         my $search_key = "search_$hint";
89
90         my $memcache_key = join('.', 'EGWeb',$locale,$hint) . '.';
91
92         # Retrieve the full set of objects with class $hint
93         $locale_subs->{$list_key} = sub {
94             my $from_memcache = 0;
95             my $list = $memcache->get_cache($memcache_key.'list');
96             if ($list) {
97                 $cache{list}{$locale}{$hint} = $list;
98                 $from_memcache = 1;
99             }
100             my $method = "retrieve_all_$eclass";
101             my $e = new_editor();
102             $cache{list}{$locale}{$hint} = $e->$method() unless $cache{list}{$locale}{$hint};
103             undef $e;
104             $memcache->put_cache($memcache_key.'list',$cache{list}{$locale}{$hint}) unless $from_memcache;
105             return $cache{list}{$locale}{$hint};
106         };
107
108         # locate object of class $hint with Ident field $id
109         $cache{map}{$hint} = {};
110         $locale_subs->{$get_key} = sub {
111             my $id = shift;
112             return $cache{map}{$locale}{$hint}{$id} if $cache{map}{$locale}{$hint}{$id};
113             ($cache{map}{$locale}{$hint}{$id}) = grep { $_->$ident_field eq $id } @{$locale_subs->{$list_key}->()};
114             return $cache{map}{$locale}{$hint}{$id};
115         };
116
117         # search for objects of class $hint where field=value
118         $cache{search}{$hint} = {};
119         $locale_subs->{$search_key} = sub {
120             my ($field, $val, $filterfield, $filterval) = @_;
121             my $method = "search_$eclass";
122             my $cacheval = $val;
123             my $scalar_cacheval = 1;
124
125             if (ref $val) {
126                 $scalar_cacheval = 0;
127                 $val = [sort(@$val)] if ref $val eq 'ARRAY';
128                 $cacheval = OpenSRF::Utils::JSON->perl2JSON($val);
129                 #$self->apache->log->info("cacheval : $cacheval");
130             }
131
132             my $search_obj = {$field => $val};
133             if($filterfield) {
134                 $search_obj->{$filterfield} = $filterval;
135                 $cacheval .= ':' . $filterfield . ':' . $filterval;
136             } elsif (
137                 $scalar_cacheval
138                 and $cache{list}{$locale}{$hint}
139                 and !$cache{search}{$locale}{$hint}{$field}{$cacheval}
140             ) {
141                 return $cache{search}{$locale}{$hint}{$field}{$cacheval} =
142                     [ grep { $_->$field() eq $val } @{$cache{list}{$locale}{$hint}} ];
143             }
144
145             my $e = new_editor();
146             $cache{search}{$locale}{$hint}{$field}{$cacheval} = $e->$method($search_obj)
147                 unless $cache{search}{$locale}{$hint}{$field}{$cacheval};
148             undef $e;
149             return $cache{search}{$locale}{$hint}{$field}{$cacheval};
150         };
151     }
152
153     $locale_subs->{aou_tree} = sub {
154
155         # fetch the org unit tree
156         unless($cache{aou_tree}{$locale}) {
157             my $e = new_editor();
158             my $tree = $e->search_actor_org_unit([
159                 {   parent_ou => undef},
160                 {   flesh            => -1,
161                     flesh_fields    => {aou =>  ['children']},
162                     order_by        => {aou => 'name'}
163                 }
164             ])->[0];
165
166             # flesh the org unit type for each org unit
167             # and simultaneously set the id => aou map cache
168             sub flesh_aout {
169                 my $node = shift;
170                 my $locale_subs = shift;
171                 my $locale = shift;
172                 $node->ou_type( $locale_subs->{get_aout}->($node->ou_type) );
173                 $cache{map}{$locale}{aou}{$node->id} = $node;
174                 flesh_aout($_, $locale_subs, $locale) foreach @{$node->children};
175             };
176             flesh_aout($tree, $locale_subs, $locale);
177             undef $e;
178             $cache{aou_tree}{$locale} = $tree;
179         }
180
181         return $cache{aou_tree}{$locale};
182     };
183
184     # Add a special handler for the tree-shaped org unit cache
185     $locale_subs->{get_aou} = sub {
186         my $org_id = shift;
187         return undef unless defined $org_id;
188         $locale_subs->{aou_tree}->(); # force the org tree to load
189         return $cache{map}{$locale}{aou}{$org_id};
190     };
191
192     # Returns a flat list of aou objects.  often easier to manage than a tree.
193     $locale_subs->{aou_list} = sub {
194         $locale_subs->{aou_tree}->(); # force the org tree to load
195         return [ values %{$cache{map}{$locale}{aou}} ];
196     };
197
198     # returns the org unit object by shortname
199     $locale_subs->{get_aou_by_shortname} = sub {
200         my $sn = shift or return undef;
201         my $list = $locale_subs->{aou_list}->();
202         return (grep {$_->shortname eq $sn} @$list)[0];
203     };
204
205     $locale_subs->{aouct_tree} = sub {
206
207         # fetch the org unit tree
208         unless(exists $cache{aouct_tree}{$locale}) {
209             $cache{aouct_tree}{$locale} = undef;
210
211             my $e = new_editor();
212             my $tree_id = $e->search_actor_org_unit_custom_tree(
213                 {purpose => 'opac', active => 't'},
214                 {idlist => 1}
215             )->[0];
216
217             if ($tree_id) {
218                 my $node_tree = $e->search_actor_org_unit_custom_tree_node([
219                 {parent_node => undef, tree => $tree_id},
220                 {   flesh        => -1,
221                     flesh_fields => {aouctn => ['children', 'org_unit']},
222                     order_by     => {aouctn => 'sibling_order'}
223                 }
224                 ])->[0];
225
226                 # tree-ify the org units.  note that since the orgs are fleshed
227                 # upon retrieval, this org tree will not clobber ctx->{aou_tree}.
228                 my @nodes = ($node_tree);
229                 while (my $node = shift(@nodes)) {
230                     my $aou = $node->org_unit;
231                     $aou->children([]);
232                     for my $cnode (@{$node->children}) {
233                         my $child_org = $cnode->org_unit;
234                         $child_org->parent_ou($aou->id);
235                         $child_org->ou_type( $locale_subs->{get_aout}->($child_org->ou_type) );
236                         push(@{$aou->children}, $child_org);
237                         push(@nodes, $cnode);
238                     }
239                 }
240
241                 $cache{aouct_tree}{$locale} = 
242                     $node_tree->org_unit if $node_tree;
243             }
244             undef $e;
245         }
246
247         return $cache{aouct_tree}{$locale};
248     };
249
250     # turns an ISO date into something TT can understand
251     $locale_subs->{parse_datetime} = sub {
252         my $date = shift;
253         my $context_org = shift; # optional, for setting timezone via YAOUS
254
255         # Calling parse_datetime() with empty $date will lead to Internal Server Error
256         return '' if (!defined($date) or $date eq '');
257
258         # Probably an accidental entry like '0212' instead of '2012',
259         # but 1) the leading 0 may get stripped in cstore and
260         # 2) DateTime::Format::ISO8601 returns an error as years
261         # must be 2 or 4 digits
262         if ($date =~ m/^\d{3}-/) {
263             $logger->warn("Invalid date had a 3-digit year: $date");
264             $date = '0' . $date;
265         } elsif ($date =~ m/^\d{1}-/) {
266             $logger->warn("Invalid date had a 1-digit year: $date");
267             $date = '000' . $date;
268         }
269
270         my $cleansed_date = clean_ISO8601($date);
271
272         $date = DateTime::Format::ISO8601->new->parse_datetime($cleansed_date);
273         if ($context_org) {
274             $context_org = $context_org->id if ref($context_org);
275             my $tz = $locale_subs->{get_org_setting}->($context_org,'lib.timezone');
276             if ($tz) {
277                 try {
278                     $date->set_time_zone($tz);
279                 } catch Error with {
280                     $logger->warn("Invalid timezone: $tz");
281                 };
282             }
283         }
284         return sprintf(
285             "%0.2d:%0.2d:%0.2d %0.2d-%0.2d-%0.4d",
286             $date->hour,
287             $date->minute,
288             $date->second,
289             $date->day,
290             $date->month,
291             $date->year
292         );
293     };
294
295     # retrieve and cache org unit setting values
296     $locale_subs->{get_org_setting} = sub {
297         my($org_id, $setting) = @_;
298
299         $cache{org_settings}{$locale}{$org_id}{$setting} =
300             $U->ou_ancestor_setting_value($org_id, $setting)
301                 unless exists $cache{org_settings}{$locale}{$org_id}{$setting};
302
303         return $cache{org_settings}{$locale}{$org_id}{$setting};
304     };
305
306     # retrieve and cache acsaf values
307     $locale_subs->{get_authority_fields} = sub {
308         my ($control_set) = @_;
309
310         if (not exists $cache{authority_fields}{$locale}{$control_set}) {
311             my $e = new_editor();
312             if (my $acs = $e->search_authority_control_set_authority_field(
313                                     {control_set => $control_set}
314                                 )
315             ) {
316                 $cache{authority_fields}{$locale}{$control_set} =
317                  +{ map { $_->id => $_ } @$acs };
318                 undef $e;
319             } else {
320                 undef $e;
321                 return;
322             }
323         }
324
325         return $cache{authority_fields}{$locale}{$control_set};
326     };
327
328     $ctx->{$_} = $locale_subs->{$_} for keys %$locale_subs;
329     $ro_object_subs->{$locale} = $locale_subs;
330 }
331
332 sub generic_redirect {
333     my $self = shift;
334     my $url = shift;
335     my $cookie = shift; # can be an array of cgi.cookie's
336
337     $self->apache->print(
338         $self->cgi->redirect(
339             -url => $url || 
340                 $self->cgi->param('redirect_to') || 
341                 $self->ctx->{referer} || 
342                 $self->ctx->{home_page},
343             -cookie => $cookie
344         )
345     );
346
347     return Apache2::Const::REDIRECT;
348 }
349
350 my $unapi_cache;
351 sub get_records_and_facets {
352     my ($self, $rec_ids, $facet_key, $unapi_args) = @_;
353
354     # collect the facet data
355     my $search = OpenSRF::AppSession->create('open-ils.search');
356     my $facet_req;
357     if ($facet_key) {
358         $facet_req = $search->request(
359             'open-ils.search.facet_cache.retrieve', $facet_key
360         );
361     }
362
363     $unapi_args ||= {};
364     $unapi_args->{site} ||= $self->ctx->{aou_tree}->()->shortname;
365     $unapi_args->{depth} ||= $self->ctx->{aou_tree}->()->ou_type->depth;
366     $unapi_args->{flesh_depth} ||= 5;
367
368     my $is_meta = delete $unapi_args->{metarecord};
369     #my $unapi_type = $is_meta ? 'unapi.mmr' : 'unapi.bre';
370     my $unapi_type = $is_meta ? 'unapi.metabib_virtual_record_feed' : 'unapi.biblio_record_entry_feed';
371
372     $unapi_cache ||= OpenSRF::Utils::Cache->new('global');
373     my $unapi_cache_key_suffix = join(
374         '_',
375         $is_meta || 0,
376         $unapi_args->{site},
377         $unapi_args->{depth},
378         $unapi_args->{flesh_depth},
379         ($unapi_args->{pref_lib} || '')
380     );
381
382     my %tmp_data;
383     my %hl_tmp_data;
384     my $outer_self = $self;
385
386     my $sdepth = $unapi_args->{flesh_depth};
387     my $slimit = "acn=>$sdepth,acp=>$sdepth";
388     $slimit .= ",bre=>$sdepth" if $is_meta;
389     my $flesh = $unapi_args->{flesh} || '';
390
391     # tag the record with the MR id
392     $flesh =~ s/}$/,mmr.unapi}/g if $is_meta;
393
394     my $ses = OpenSRF::AppSession->create('open-ils.cstore');
395     my $hl_ses = OpenSRF::AppSession->create('open-ils.search');
396
397     my @loop_recs;
398     for my $bid (@$rec_ids) {
399         my $unapi_cache_key = 'TPAC_unapi_cache_'.$bid.'_'.$unapi_cache_key_suffix;
400         my $unapi_data = $unapi_cache->get_cache($unapi_cache_key);
401
402         if (!$unapi_data || $unapi_data->{running}) { #cache entry not done yet, get our own copy
403             push(@loop_recs, $bid);
404         } else {
405             $unapi_data->{marc_xml} = XML::LibXML->new->parse_string($unapi_data->{marc_xml})->documentElement;
406             $tmp_data{$unapi_data->{id}} = $unapi_data;
407             $unapi_cache->put_cache($unapi_cache_key, { running => $$ }, 5);
408         }
409     }
410
411     my $hl_req = $hl_ses->request(
412         'open-ils.search.fetch.metabib.display_field.highlight.atomic',
413         $self->ctx->{query_struct}{additional_data}{highlight_map},
414         @$rec_ids
415     ) if (!$is_meta);
416
417     if (@loop_recs) {
418         my $unapi_req = $ses->request(
419             'open-ils.cstore.json_query',
420              {from => [
421                 $unapi_type, '{'.join(',',@loop_recs).'}', 'marcxml', $flesh,
422                 $unapi_args->{site}, 
423                 $unapi_args->{depth}, 
424                 $slimit,
425                 undef, undef, undef, undef, undef, undef, undef, undef,
426                 $unapi_args->{pref_lib}
427             ]}
428         );
429     
430         my $data = $unapi_req->gather(1);
431     
432         $outer_self->timelog("get_records_and_facets(): got feed content");
433     
434         # Protect against requests for non-existent records
435         return unless ($data->{$unapi_type});
436     
437         my $doc = XML::LibXML->new->parse_string($data->{$unapi_type})->documentElement;
438     
439         $outer_self->timelog("get_records_and_facets(): parsed xml");
440         for my $xml ($doc->getElementsByTagName('record')) {
441             $xml = XML::LibXML->new->parse_string($xml->toString)->documentElement;
442     
443             # Protect against legacy invalid MARCXML that might not have a 901c
444             my $bre_id;
445             my $mmr_id;
446             my $bre_id_nodes =  $xml->find('*[@tag="901"]/*[@code="c"]');
447             if ($bre_id_nodes) {
448                 $bre_id =  $bre_id_nodes->[0]->textContent;
449             } else {
450                 $logger->warn("Missing 901 subfield 'c' in " . $xml->toString());
451             }
452         
453             if ($is_meta) {
454                 # extract metarecord ID from mmr.unapi tag
455                 for my $node ($xml->getElementsByTagName('abbr')) {
456                     my $title = $node->getAttribute('title');
457                     ($mmr_id = $title) =~ 
458                         s/tag:open-ils.org:U2\@mmr\/(\d+)\/.*/$1/g;
459                     last if $mmr_id;
460                 }
461             }
462         
463             my $rec_id = $mmr_id ? $mmr_id : $bre_id;
464             $tmp_data{$rec_id} = {
465                 id => $rec_id, 
466                 bre_id => $bre_id, 
467                 mmr_id => $mmr_id,
468                 marc_xml => $xml
469             };
470         
471             if ($rec_id) {
472                 # Let other backends grab our data now that we're done.
473                 my $key = 'TPAC_unapi_cache_'.$rec_id.'_'.$unapi_cache_key_suffix;
474                 my $cache_data = $unapi_cache->get_cache($key);
475                 if (!$cache_data || $$cache_data{running} == $$) {
476                     $unapi_cache->put_cache($key, {
477                         bre_id => $bre_id,
478                         mmr_id => $mmr_id,
479                         id => $rec_id, 
480                         marc_xml => $xml->toString
481                     }, 10);
482                 }
483             }
484         }
485     }
486
487     if (!$is_meta) {
488         my $hl_data = $hl_req->gather(1); # list of arrayref of hashrefs
489         $self->ctx->{_hl_data} = { map { ''.$$_[0]{source} => $_ } @$hl_data };
490         $outer_self->timelog("get_records_and_facets(): got highlighting content (". keys(%{$self->ctx->{_hl_data}}).")");
491     }
492
493     my $facets = {};
494     if ($facet_req) {
495         $self->timelog("get_records_and_facets():almost ready to fetch facets");
496
497         my $tmp_facets = $facet_req->gather(1);
498         $self->timelog("get_records_and_facets(): gathered facet data");
499         for my $cmf_id (keys %$tmp_facets) {
500
501             # sort highest to lowest match count
502             my @entries;
503             my $entries = $tmp_facets->{$cmf_id};
504             for my $ent (keys %$entries) {
505                 push(@entries, {value => $ent, count => $$entries{$ent}});
506             };
507
508             # Sort facet entries by 1) count descending, 2) text ascending
509             @entries = sort {
510                 $b->{count} <=> $a->{count} ||
511                 $a->{value} cmp $b->{value}
512             } @entries;
513
514             $facets->{$cmf_id} = {
515                 cmf => $self->ctx->{get_cmf}->($cmf_id),
516                 data => \@entries
517             }
518         }
519         $self->timelog("get_records_and_facets(): gathered/sorted facet data");
520     } else {
521         $facets = undef;
522     }
523     $search->kill_me;
524
525
526     return ($facets, map { $tmp_data{$_} } @$rec_ids);
527 }
528
529 sub _resolve_org_id_or_shortname {
530     my ($self, $str) = @_;
531
532     if (length $str) {
533         # Match on shortname case insensitively, but only if there's exactly
534         # one match.  We wouldn't want the system to arbitrarily interpret
535         # 'foo' as either the org unit with shortname 'FOO' or 'Foo' and fail
536         # to make it clear to the user which one was chosen and why.
537         my $res = $self->editor->search_actor_org_unit({
538             shortname => {
539                 '=' => {
540                     transform => 'evergreen.lowercase',
541                     value => lc($str)
542                 }
543             }
544         });
545         return $res->[0]->id if $res and @$res == 1;
546     }
547
548     # Note that we don't validate IDs; we only try a shortname lookup and then
549     # assume anything else must be an ID.
550     return int($str); # Wrapping in int() prevents 500 on unmatched string.
551 }
552
553 sub _get_search_lib {
554     my $self = shift;
555     my $ctx = $self->ctx;
556
557     # avoid duplicate lookups
558     return $ctx->{search_ou} if $ctx->{search_ou};
559
560     my $loc = $ctx->{copy_location_group_org};
561     return $loc if $loc;
562
563     # loc param takes precedence
564     # XXX ^-- over what exactly? We could use clarification here. To me it looks
565     # like locg takes precedence over loc which in turn takes precedence over
566     # request headers which take precedence over pref_lib (which can be
567     # specified a lot of different ways and eventually falls back to
568     # physical_loc) and it all finally defaults to top of the org tree.
569     # To say nothing of all the code that doesn't look to this function at all
570     # but rather accesses some subset of these inputs directly.
571
572     $loc = $self->cgi->param('loc');
573     return $loc if $loc;
574
575     if ($self->apache->headers_in->get('OILS-Search-Lib')) {
576         return $self->apache->headers_in->get('OILS-Search-Lib');
577     }
578     if ($self->cgi->cookie('eg_search_lib')) {
579         return $self->cgi->cookie('eg_search_lib');
580     }
581
582     my $pref_lib = $self->_get_pref_lib();
583     return $pref_lib if $pref_lib;
584
585     return $ctx->{aou_tree}->()->id;
586 }
587
588 sub _get_pref_lib {
589     my $self = shift;
590     my $ctx = $self->ctx;
591
592     # plib param takes precedence
593     my $plib = $self->cgi->param('plib');
594     return $plib if $plib;
595
596     if ($self->apache->headers_in->get('OILS-Pref-Lib')) {
597         return $self->apache->headers_in->get('OILS-Pref-Lib');
598     }
599     if ($self->cgi->cookie('eg_pref_lib')) {
600         return $self->cgi->cookie('eg_pref_lib');
601     }
602
603     if ($ctx->{user}) {
604         # See if the user has a search library preference
605         my $lset = $self->editor->search_actor_user_setting({
606             usr => $ctx->{user}->id, 
607             name => 'opac.default_search_location'
608         })->[0];
609         return OpenSRF::Utils::JSON->JSON2perl($lset->value) if $lset;
610
611         # Otherwise return the user's home library
612         my $ou = $ctx->{user}->home_ou;
613         return ref($ou) ? $ou->id : $ou;
614     }
615
616     if ($ctx->{physical_loc}) {
617         return $ctx->{physical_loc};
618     }
619
620 }
621
622 # This is defensively coded since we don't do much manual reading from the
623 # file system in this module.
624 sub load_eg_cache_hash {
625     my ($self) = @_;
626
627     # just a context helper
628     $self->ctx->{eg_cache_hash} = sub { return $cache{eg_cache_hash}; };
629
630     # Need to actually load the value? If already done, move on.
631     return if defined $cache{eg_cache_hash};
632
633     # In this way even if we fail, we won't slow things down by ever trying
634     # again within this Apache process' lifetime.
635     $cache{eg_cache_hash} = 0;
636
637     my $path = File::Spec->catfile(
638         $self->apache->document_root, "eg_cache_hash"
639     );
640
641     if (not open FH, "<$path") {
642         $self->apache->log->warn("error opening $path : $!");
643         return;
644     } else {
645         my $buf;
646         my $rv = read FH, $buf, 64;  # defensive
647         close FH;
648
649         if (not defined $rv) {  # error
650             $self->apache->log->warn("error reading $path : $!");
651         } elsif ($rv > 0) {     # no error, something read
652             chomp $buf;
653             $cache{eg_cache_hash} = $buf;
654         }
655     }
656 }
657
658 # Extracts the copy location org unit and group from the 
659 # "logc" param, which takes the form org_id:grp_id.
660 sub extract_copy_location_group_info {
661     my $self = shift;
662     my $ctx = $self->ctx;
663     if (my $clump = $self->cgi->param('locg')) {
664         my ($org, $grp) = split(/:/, $clump);
665         $ctx->{copy_location_group_org} =
666             $self->_resolve_org_id_or_shortname($org);
667         $ctx->{copy_location_group} = $grp if $grp;
668     }
669 }
670
671 sub load_copy_location_groups {
672     my $self = shift;
673     my $ctx = $self->ctx;
674
675     # User can access to the search location groups at the current 
676     # search lib, the physical location lib, and the patron's home ou.
677     my @ctx_orgs = $ctx->{search_ou};
678     push(@ctx_orgs, $ctx->{physical_loc}) if $ctx->{physical_loc};
679     push(@ctx_orgs, $ctx->{user}->home_ou) if $ctx->{user};
680
681     my $grps = $self->editor->search_asset_copy_location_group([
682         {
683             opac_visible => 't',
684             owner => {
685                 in => {
686                     select => {aou => [{
687                         column => 'id', 
688                         transform => 'actor.org_unit_full_path',
689                         result_field => 'id',
690                     }]},
691                     from => 'aou',
692                     where => {id => \@ctx_orgs}
693                 }
694             }
695         },
696         {order_by => {acplg => 'pos'}}
697     ]);
698
699     my %buckets;
700     push(@{$buckets{$_->owner}}, $_) for @$grps;
701     $ctx->{copy_location_groups} = \%buckets;
702 }
703
704 sub set_file_download_headers {
705     my $self = shift;
706     my $filename = shift;
707     my $ctype = shift || "text/plain; encoding=utf8";
708
709     $self->apache->content_type($ctype);
710
711     $self->apache->headers_out->add(
712         "Content-Disposition",
713         "attachment;filename=$filename"
714     );
715
716     return Apache2::Const::OK;
717 }
718
719 sub apache_log_if_event {
720     my ($self, $event, $prefix_text, $success_ok, $level) = @_;
721
722     $prefix_text ||= "Evergreen returned event";
723     $success_ok ||= 0;
724     $level ||= "warn";
725
726     chomp $prefix_text;
727     $prefix_text .= ": ";
728
729     my $code = $U->event_code($event);
730     if (defined $code and ($code or not $success_ok)) {
731         $self->apache->log->$level(
732             $prefix_text .
733             ($event->{textcode} || "") . " ($code)" .
734             ($event->{note} ? (": " . $event->{note}) : "")
735         );
736         return 1;
737     }
738
739     return;
740 }
741
742 sub load_search_filter_groups {
743     my $self = shift;
744     my $ctx_org = shift;
745     my $org_list = $U->get_org_ancestors($ctx_org, 1);
746
747     my %seen;
748     for my $org_id (@$org_list) {
749
750         my $grps;
751         if (! ($grps = $cache{search_filter_groups}{$org_id}) ) {
752             $grps = $self->editor->search_actor_search_filter_group([
753                 {owner => $org_id},
754                 {   flesh => 2, 
755                     flesh_fields => {
756                         asfg => ['entries'],
757                         asfge => ['query']
758                     },
759                     order_by => {asfge => 'pos'}
760                 }
761             ]);
762             $cache{search_filter_groups}{$org_id} = $grps;
763         }
764
765         # for the current context, if a descendant org has a group 
766         # with a matching code replace the group from the parent.
767         $seen{$_->code} = $_ for @$grps;
768     }
769
770     return $self->ctx->{search_filter_groups} = \%seen;
771 }
772
773
774 sub check_for_temp_list_warning {
775     my $self = shift;
776     my $ctx = $self->ctx;
777     my $cgi = $self->cgi;
778
779     my $lib = $self->_get_search_lib;
780     my $warn = ($ctx->{get_org_setting}->($lib || 1, 'opac.patron.temporary_list_warn')) ? 1 : 0;
781
782     if ($warn && $ctx->{user}) {
783         $self->_load_user_with_prefs;
784         my $map = $ctx->{user_setting_map};
785         $warn = 0 if ($$map{'opac.temporary_list_no_warn'});
786     }
787
788     # Check for a cookie disabling the warning.
789     $warn = 0 if ($warn && $cgi->cookie('no_temp_list_warn'));
790
791     return $warn;
792 }
793
794 sub load_org_util_funcs {
795     my $self = shift;
796     my $ctx = $self->ctx;
797
798     # evaluates to true if test_ou is within the same depth-
799     # scoped tree as ctx_ou. both ou's are org unit objects.
800     $ctx->{org_within_scope} = sub {
801         my ($ctx_ou, $test_ou, $depth) = @_;
802
803         return 1 if $ctx_ou->id == $test_ou->id;
804
805         if ($depth) {
806
807             # find the top-most ctx-org ancestor at the provided depth
808             while ($depth < $ctx_ou->ou_type->depth 
809                     and $ctx_ou->id != $test_ou->id) {
810                 $ctx_ou = $ctx->{get_aou}->($ctx_ou->parent_ou);
811             }
812
813             # the preceeding loop may have landed on our org
814             return 1 if $ctx_ou->id == $test_ou->id;
815
816         } else {
817
818             return 1 if defined $depth; # $depth == 0;
819         }
820
821         for my $child (@{$ctx_ou->children}) {
822             return 1 if $ctx->{org_within_scope}->($child, $test_ou);
823         }
824
825         return 0;
826     };
827
828     # Returns true if the provided org unit is within the same 
829     # org unit hiding depth-scoped tree as the physical location.
830     # Org unit hiding is based on the immutable physical_loc
831     # and is not meant to change as search/pref/etc libs change
832     $ctx->{org_within_hiding_scope} = sub {
833         my $org_id = shift;
834         my $ploc = $ctx->{physical_loc} or return 1;
835
836         my $depth = $ctx->{get_org_setting}->(
837             $ploc, 'opac.org_unit_hiding.depth');
838
839         return 1 unless $depth; # 0 or undef
840
841         return $ctx->{org_within_scope}->( 
842             $ctx->{get_aou}->($ploc), 
843             $ctx->{get_aou}->($org_id), $depth);
844  
845     };
846
847     # Evaluates to true if the context org (defaults to get_library) 
848     # is not within the hiding scope.  Also evaluates to true if the 
849     # user's pref_ou is set and it's out of hiding scope.
850     # Always evaluates to true when ctx.is_staff
851     $ctx->{org_hiding_disabled} = sub {
852         my $ctx_org = shift || $ctx->{search_ou};
853
854         return 1 if $ctx->{is_staff};
855
856         # beware locg values formatted as org:loc
857         $ctx_org =~ s/:.*//g;
858
859         return 1 if !$ctx->{org_within_hiding_scope}->($ctx_org);
860
861         return 1 if $ctx->{pref_ou} and $ctx->{pref_ou} != $ctx_org 
862             and !$ctx->{org_within_hiding_scope}->($ctx->{pref_ou});
863
864         return 0;
865     };
866
867 }
868
869 # returns the list of org unit IDs for which the 
870 # selected org unit setting returned a true value
871 sub setting_is_true_for_orgs {
872     my ($self, $setting) = @_;
873     my $ctx = $self->ctx;
874     my @valid_orgs;
875
876     my $test_org;
877     $test_org = sub {
878         my $org = shift;
879         push (@valid_orgs, $org->id) if
880             $ctx->{get_org_setting}->($org->id, $setting);
881         $test_org->($_) for @{$org->children};
882     };
883
884     $test_org->($ctx->{aou_tree}->());
885     return \@valid_orgs;
886 }
887
888 # Builds and links a perm checking function, testing permissions against
889 # the currently logged in user.  
890 # ctx->{has_perm}->(perm_code, org_id) => 1/undef
891 # For security, perm checks are cached per page, not per process.
892 sub load_perm_funcs {
893     my $self = shift;
894     my %perm_cache;
895     $self->ctx->{has_perm} = sub {
896         my ($perm_code, $org_id) = @_;
897         return 0 unless $self->editor->requestor;
898
899         if ($perm_cache{$org_id}) {
900             return $perm_cache{$org_id}{$perm_code} 
901                 if exists $perm_cache{$org_id}{$perm_code};
902         } else {
903             $perm_cache{$org_id} = {};
904         }
905         return $perm_cache{$org_id}{$perm_code} =
906             $self->editor->allowed($perm_code, $org_id);
907     }
908 }
909     
910
911
912 1;