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