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