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     my $is_meta = delete $unapi_args->{metarecord};
 281     my $unapi_type = $is_meta ? 'unapi.mmr' : 'unapi.bre';
 282
 283     $unapi_cache ||= OpenSRF::Utils::Cache->new('global');
 284     my $unapi_cache_key_suffix = join(
 285         '_',
 286         $is_meta || 0,
 287         $unapi_args->{site},
 288         $unapi_args->{depth},
 289         $unapi_args->{flesh_depth},
 290         ($unapi_args->{pref_lib} || '')
 291     );
 292
 293     my %tmp_data;
 294     my $outer_self = $self;
 295     $self->timelog("get_records_and_facets(): about to call multisession");
 296     my $ses = OpenSRF::MultiSession->new(
 297         app => 'open-ils.cstore',
 298         cap => 10, # XXX config
 299         success_handler => sub {
 300             my($self, $req) = @_;
 301             my $data = $req->{response}->[0]->content;
 302
 303             $outer_self->timelog("get_records_and_facets(): got response content");
 304
 305             # Protect against requests for non-existent records
 306             return unless $data->{$unapi_type};
 307
 308             my $xml = XML::LibXML->new->parse_string($data->{$unapi_type})->documentElement;
 309
 310             $outer_self->timelog("get_records_and_facets(): parsed xml");
 311             # Protect against legacy invalid MARCXML that might not have a 901c
 312             my $bre_id;
 313             my $mmr_id;
 314             my $bre_id_nodes =  $xml->find('*[@tag="901"]/*[@code="c"]');
 315             if ($bre_id_nodes) {
 316                 $bre_id =  $bre_id_nodes->[0]->textContent;
 317             } else {
 318                 $logger->warn("Missing 901 subfield 'c' in " . $xml->toString());
 319             }
 320
 321             if ($is_meta) {
 322                 # extract metarecord ID from mmr.unapi tag
 323                 for my $node ($xml->getElementsByTagName('abbr')) {
 324                     my $title = $node->getAttribute('title');
 325                     ($mmr_id = $title) =~
 326                         s/tag:open-ils.org:U2\@mmr\/(\d+)\/.*/$1/g;
 327                     last if $mmr_id;
 328                 }
 329             }
 330
 331             my $rec_id = $mmr_id ? $mmr_id : $bre_id;
 332             $tmp_data{$rec_id} = {
 333                 id => $rec_id,
 334                 bre_id => $bre_id,
 335                 mmr_id => $mmr_id,
 336                 marc_xml => $xml
 337             };
 338
 339             if ($rec_id) {
 340                 # Let other backends grab our data now that we're done.
 341                 my $key = 'TPAC_unapi_cache_'.$rec_id.'_'.$unapi_cache_key_suffix;
 342                 my $cache_data = $unapi_cache->get_cache($key);
 343                 if ($$cache_data{running}) {
 344                     $unapi_cache->put_cache($key, {
 345                         bre_id => $bre_id,
 346                         mmr_id => $mmr_id,
 347                         id => $rec_id,
 348                         marc_xml => $data->{$unapi_type}
 349                     }, 10);
 350                 }
 351             }
 352
 353             $outer_self->timelog("get_records_and_facets(): end of success handler");
 354         }
 355     );
 356
 357     $self->timelog("get_records_and_facets(): about to call ".
 358         "$unapi_type via json_query (rec_ids has " . scalar(@$rec_ids));
 359
 360     my @loop_recs = @$rec_ids;
 361     my %rec_timeout;
 362
 363     while (my $bid = shift @loop_recs) {
 364
 365         sleep(0.1) if $rec_timeout{$bid};
 366
 367         my $unapi_cache_key = 'TPAC_unapi_cache_'.$bid.'_'.$unapi_cache_key_suffix;
 368         my $unapi_data = $unapi_cache->get_cache($unapi_cache_key) || {};
 369
 370         if ($unapi_data->{running}) { #cache entry from ongoing, concurrent retrieval
 371             if (!$rec_timeout{$bid}) {
 372                 $rec_timeout{$bid} = time() + 10;
 373             }
 374
 375             if ( time() > $rec_timeout{$bid} ) { # we've waited too long. just do it
 376                 $unapi_data = {};
 377                 delete $rec_timeout{$bid};
 378             } else { # we'll pause next time around to let this one try again
 379                 push(@loop_recs, $bid);
 380                 next;
 381             }
 382         }
 383
 384         if ($unapi_data->{marc_xml}) { # we got data from the cache
 385             $unapi_data->{marc_xml} = XML::LibXML->new->parse_string($unapi_data->{marc_xml})->documentElement;
 386             $tmp_data{$unapi_data->{id}} = $unapi_data;
 387         } else { # we're the first or we timed out. success_handler will populate the real value
 388             $unapi_cache->put_cache($unapi_cache_key, { running => $$ }, 10);
 389
 390             my $sdepth = $unapi_args->{flesh_depth};
 391             my $slimit = "acn=>$sdepth,acp=>$sdepth";
 392             $slimit .= ",bre=>$sdepth" if $is_meta;
 393             my $flesh = $unapi_args->{flesh} || '';
 394
 395             # tag the record with the MR id
 396             $flesh =~ s/}$/,mmr.unapi}/g if $is_meta;
 397
 398             $ses->request(
 399                 'open-ils.cstore.json_query',
 400                  {from => [
 401                     $unapi_type, $bid, 'marcxml','record', $flesh,
 402                     $unapi_args->{site},
 403                     $unapi_args->{depth},
 404                     $slimit,
 405                     undef, undef, $unapi_args->{pref_lib}
 406                 ]}
 407             );
 408         }
 409     }
 410
 411
 412     $self->timelog("get_records_and_facets():almost ready to fetch facets");
 413     # collect the facet data
 414     my $search = OpenSRF::AppSession->create('open-ils.search');
 415     my $facet_req = $search->request(
 416         'open-ils.search.facet_cache.retrieve', $facet_key
 417     ) if $facet_key;
 418
 419     # gather up the unapi recs
 420     $ses->session_wait(1);
 421     $self->timelog("get_records_and_facets():past session wait");
 422
 423     my $facets = {};
 424     if ($facet_key) {
 425         my $tmp_facets = $facet_req->gather(1);
 426         $self->timelog("get_records_and_facets(): gathered facet data");
 427         for my $cmf_id (keys %$tmp_facets) {
 428
 429             # sort highest to lowest match count
 430             my @entries;
 431             my $entries = $tmp_facets->{$cmf_id};
 432             for my $ent (keys %$entries) {
 433                 push(@entries, {value => $ent, count => $$entries{$ent}});
 434             };
 435
 436             # Sort facet entries by 1) count descending, 2) text ascending
 437             @entries = sort {
 438                 $b->{count} <=> $a->{count} ||
 439                 $a->{value} cmp $b->{value}
 440             } @entries;
 441
 442             $facets->{$cmf_id} = {
 443                 cmf => $self->ctx->{get_cmf}->($cmf_id),
 444                 data => \@entries
 445             }
 446         }
 447         $self->timelog("get_records_and_facets(): gathered/sorted facet data");
 448     } else {
 449         $facets = undef;
 450     }
 451
 452     $search->kill_me;
 453
 454     return ($facets, map { $tmp_data{$_} } @$rec_ids);
 455 }
 456
 457 sub _resolve_org_id_or_shortname {
 458     my ($self, $str) = @_;
 459
 460     if (length $str) {
 461         # Match on shortname case insensitively, but only if there's exactly
 462         # one match.  We wouldn't want the system to arbitrarily interpret
 463         # 'foo' as either the org unit with shortname 'FOO' or 'Foo' and fail
 464         # to make it clear to the user which one was chosen and why.
 465         my $res = $self->editor->search_actor_org_unit({
 466             shortname => {
 467                 '=' => {
 468                     transform => 'evergreen.lowercase',
 469                     value => lc($str)
 470                 }
 471             }
 472         });
 473         return $res->[0]->id if $res and @$res == 1;
 474     }
 475
 476     # Note that we don't validate IDs; we only try a shortname lookup and then
 477     # assume anything else must be an ID.
 478     return int($str); # Wrapping in int() prevents 500 on unmatched string.
 479 }
 480
 481 sub _get_search_lib {
 482     my $self = shift;
 483     my $ctx = $self->ctx;
 484
 485     # avoid duplicate lookups
 486     return $ctx->{search_ou} if $ctx->{search_ou};
 487
 488     my $loc = $ctx->{copy_location_group_org};
 489     return $loc if $loc;
 490
 491     # loc param takes precedence
 492     # XXX ^-- over what exactly? We could use clarification here. To me it looks
 493     # like locg takes precedence over loc which in turn takes precedence over
 494     # request headers which take precedence over pref_lib (which can be
 495     # specified a lot of different ways and eventually falls back to
 496     # physical_loc) and it all finally defaults to top of the org tree.
 497     # To say nothing of all the code that doesn't look to this function at all
 498     # but rather accesses some subset of these inputs directly.
 499
 500     $loc = $self->cgi->param('loc');
 501     return $loc if $loc;
 502
 503     if ($self->apache->headers_in->get('OILS-Search-Lib')) {
 504         return $self->apache->headers_in->get('OILS-Search-Lib');
 505     }
 506
 507     my $pref_lib = $self->_get_pref_lib();
 508     return $pref_lib if $pref_lib;
 509
 510     return $ctx->{aou_tree}->()->id;
 511 }
 512
 513 sub _get_pref_lib {
 514     my $self = shift;
 515     my $ctx = $self->ctx;
 516
 517     # plib param takes precedence
 518     my $plib = $self->cgi->param('plib');
 519     return $plib if $plib;
 520
 521     if ($self->apache->headers_in->get('OILS-Pref-Lib')) {
 522         return $self->apache->headers_in->get('OILS-Pref-Lib');
 523     }
 524
 525     if ($ctx->{user}) {
 526         # See if the user has a search library preference
 527         my $lset = $self->editor->search_actor_user_setting({
 528             usr => $ctx->{user}->id,
 529             name => 'opac.default_search_location'
 530         })->[0];
 531         return OpenSRF::Utils::JSON->JSON2perl($lset->value) if $lset;
 532
 533         # Otherwise return the user's home library
 534         my $ou = $ctx->{user}->home_ou;
 535         return ref($ou) ? $ou->id : $ou;
 536     }
 537
 538     if ($ctx->{physical_loc}) {
 539         return $ctx->{physical_loc};
 540     }
 541
 542 }
 543
 544 # This is defensively coded since we don't do much manual reading from the
 545 # file system in this module.
 546 sub load_eg_cache_hash {
 547     my ($self) = @_;
 548
 549     # just a context helper
 550     $self->ctx->{eg_cache_hash} = sub { return $cache{eg_cache_hash}; };
 551
 552     # Need to actually load the value? If already done, move on.
 553     return if defined $cache{eg_cache_hash};
 554
 555     # In this way even if we fail, we won't slow things down by ever trying
 556     # again within this Apache process' lifetime.
 557     $cache{eg_cache_hash} = 0;
 558
 559     my $path = File::Spec->catfile(
 560         $self->apache->document_root, "eg_cache_hash"
 561     );
 562
 563     if (not open FH, "<$path") {
 564         $self->apache->log->warn("error opening $path : $!");
 565         return;
 566     } else {
 567         my $buf;
 568         my $rv = read FH, $buf, 64;  # defensive
 569         close FH;
 570
 571         if (not defined $rv) {  # error
 572             $self->apache->log->warn("error reading $path : $!");
 573         } elsif ($rv > 0) {     # no error, something read
 574             chomp $buf;
 575             $cache{eg_cache_hash} = $buf;
 576         }
 577     }
 578 }
 579
 580 # Extracts the copy location org unit and group from the
 581 # "logc" param, which takes the form org_id:grp_id.
 582 sub extract_copy_location_group_info {
 583     my $self = shift;
 584     my $ctx = $self->ctx;
 585     if (my $clump = $self->cgi->param('locg')) {
 586         my ($org, $grp) = split(/:/, $clump);
 587         $ctx->{copy_location_group_org} =
 588             $self->_resolve_org_id_or_shortname($org);
 589         $ctx->{copy_location_group} = $grp if $grp;
 590     }
 591 }
 592
 593 sub load_copy_location_groups {
 594     my $self = shift;
 595     my $ctx = $self->ctx;
 596
 597     # User can access to the search location groups at the current
 598     # search lib, the physical location lib, and the patron's home ou.
 599     my @ctx_orgs = $ctx->{search_ou};
 600     push(@ctx_orgs, $ctx->{physical_loc}) if $ctx->{physical_loc};
 601     push(@ctx_orgs, $ctx->{user}->home_ou) if $ctx->{user};
 602
 603     my $grps = $self->editor->search_asset_copy_location_group([
 604         {
 605             opac_visible => 't',
 606             owner => {
 607                 in => {
 608                     select => {aou => [{
 609                         column => 'id',
 610                         transform => 'actor.org_unit_full_path',
 611                         result_field => 'id',
 612                     }]},
 613                     from => 'aou',
 614                     where => {id => \@ctx_orgs}
 615                 }
 616             }
 617         },
 618         {order_by => {acplg => 'pos'}}
 619     ]);
 620
 621     my %buckets;
 622     push(@{$buckets{$_->owner}}, $_) for @$grps;
 623     $ctx->{copy_location_groups} = \%buckets;
 624 }
 625
 626 sub set_file_download_headers {
 627     my $self = shift;
 628     my $filename = shift;
 629     my $ctype = shift || "text/plain; encoding=utf8";
 630
 631     $self->apache->content_type($ctype);
 632
 633     $self->apache->headers_out->add(
 634         "Content-Disposition",
 635         "attachment;filename=$filename"
 636     );
 637
 638     return Apache2::Const::OK;
 639 }
 640
 641 sub apache_log_if_event {
 642     my ($self, $event, $prefix_text, $success_ok, $level) = @_;
 643
 644     $prefix_text ||= "Evergreen returned event";
 645     $success_ok ||= 0;
 646     $level ||= "warn";
 647
 648     chomp $prefix_text;
 649     $prefix_text .= ": ";
 650
 651     my $code = $U->event_code($event);
 652     if (defined $code and ($code or not $success_ok)) {
 653         $self->apache->log->$level(
 654             $prefix_text .
 655             ($event->{textcode} || "") . " ($code)" .
 656             ($event->{note} ? (": " . $event->{note}) : "")
 657         );
 658         return 1;
 659     }
 660
 661     return;
 662 }
 663
 664 sub load_search_filter_groups {
 665     my $self = shift;
 666     my $ctx_org = shift;
 667     my $org_list = $U->get_org_ancestors($ctx_org, 1);
 668
 669     my %seen;
 670     for my $org_id (@$org_list) {
 671
 672         my $grps;
 673         if (! ($grps = $cache{search_filter_groups}{$org_id}) ) {
 674             $grps = $self->editor->search_actor_search_filter_group([
 675                 {owner => $org_id},
 676                 {   flesh => 2,
 677                     flesh_fields => {
 678                         asfg => ['entries'],
 679                         asfge => ['query']
 680                     },
 681                     order_by => {asfge => 'pos'}
 682                 }
 683             ]);
 684             $cache{search_filter_groups}{$org_id} = $grps;
 685         }
 686
 687         # for the current context, if a descendant org has a group
 688         # with a matching code replace the group from the parent.
 689         $seen{$_->code} = $_ for @$grps;
 690     }
 691
 692     return $self->ctx->{search_filter_groups} = \%seen;
 693 }
 694
 695
 696 sub check_for_temp_list_warning {
 697     my $self = shift;
 698     my $ctx = $self->ctx;
 699     my $cgi = $self->cgi;
 700
 701     my $lib = $self->_get_search_lib;
 702     my $warn = ($ctx->{get_org_setting}->($lib || 1, 'opac.patron.temporary_list_warn')) ? 1 : 0;
 703
 704     if ($warn && $ctx->{user}) {
 705         $self->_load_user_with_prefs;
 706         my $map = $ctx->{user_setting_map};
 707         $warn = 0 if ($$map{'opac.temporary_list_no_warn'});
 708     }
 709
 710     # Check for a cookie disabling the warning.
 711     $warn = 0 if ($warn && $cgi->cookie('no_temp_list_warn'));
 712
 713     return $warn;
 714 }
 715
 716 sub load_org_util_funcs {
 717     my $self = shift;
 718     my $ctx = $self->ctx;
 719
 720     # evaluates to true if test_ou is within the same depth-
 721     # scoped tree as ctx_ou. both ou's are org unit objects.
 722     $ctx->{org_within_scope} = sub {
 723         my ($ctx_ou, $test_ou, $depth) = @_;
 724
 725         return 1 if $ctx_ou->id == $test_ou->id;
 726
 727         if ($depth) {
 728
 729             # find the top-most ctx-org ancestor at the provided depth
 730             while ($depth < $ctx_ou->ou_type->depth
 731                     and $ctx_ou->id != $test_ou->id) {
 732                 $ctx_ou = $ctx->{get_aou}->($ctx_ou->parent_ou);
 733             }
 734
 735             # the preceeding loop may have landed on our org
 736             return 1 if $ctx_ou->id == $test_ou->id;
 737
 738         } else {
 739
 740             return 1 if defined $depth; # $depth == 0;
 741         }
 742
 743         for my $child (@{$ctx_ou->children}) {
 744             return 1 if $ctx->{org_within_scope}->($child, $test_ou);
 745         }
 746
 747         return 0;
 748     };
 749
 750     # Returns true if the provided org unit is within the same
 751     # org unit hiding depth-scoped tree as the physical location.
 752     # Org unit hiding is based on the immutable physical_loc
 753     # and is not meant to change as search/pref/etc libs change
 754     $ctx->{org_within_hiding_scope} = sub {
 755         my $org_id = shift;
 756         my $ploc = $ctx->{physical_loc} or return 1;
 757
 758         my $depth = $ctx->{get_org_setting}->(
 759             $ploc, 'opac.org_unit_hiding.depth');
 760
 761         return 1 unless $depth; # 0 or undef
 762
 763         return $ctx->{org_within_scope}->(
 764             $ctx->{get_aou}->($ploc),
 765             $ctx->{get_aou}->($org_id), $depth);
 766
 767     };
 768
 769     # Evaluates to true if the context org (defaults to get_library)
 770     # is not within the hiding scope.  Also evaluates to true if the
 771     # user's pref_ou is set and it's out of hiding scope.
 772     # Always evaluates to true when ctx.is_staff
 773     $ctx->{org_hiding_disabled} = sub {
 774         my $ctx_org = shift || $ctx->{search_ou};
 775
 776         return 1 if $ctx->{is_staff};
 777
 778         # beware locg values formatted as org:loc
 779         $ctx_org =~ s/:.*//g;
 780
 781         return 1 if !$ctx->{org_within_hiding_scope}->($ctx_org);
 782
 783         return 1 if $ctx->{pref_ou} and $ctx->{pref_ou} != $ctx_org
 784             and !$ctx->{org_within_hiding_scope}->($ctx->{pref_ou});
 785
 786         return 0;
 787     };
 788
 789 }
 790
 791 # returns the list of org unit IDs for which the
 792 # selected org unit setting returned a true value
 793 sub setting_is_true_for_orgs {
 794     my ($self, $setting) = @_;
 795     my $ctx = $self->ctx;
 796     my @valid_orgs;
 797
 798     my $test_org;
 799     $test_org = sub {
 800         my $org = shift;
 801         push (@valid_orgs, $org->id) if
 802             $ctx->{get_org_setting}->($org->id, $setting);
 803         $test_org->($_) for @{$org->children};
 804     };
 805
 806     $test_org->($ctx->{aou_tree}->());
 807     return \@valid_orgs;
 808 }
 809
 810
 811
 812 1;