Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader/Search.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 OpenSRF::Utils::Logger qw/$logger/;
   5 use OpenILS::Utils::CStoreEditor qw/:funcs/;
   6 use OpenILS::Utils::Fieldmapper;
   7 use OpenILS::Application::AppUtils;
   8 use OpenSRF::Utils::JSON;
   9 use Data::Dumper;
  10 $Data::Dumper::Indent = 0;
  11 my $U = 'OpenILS::Application::AppUtils';
  12
  13 # when fetching "all" search results for staff client
  14 # start/end paging, fetch this many IDs at most
  15 my $all_recs_limit = 10000;
  16
  17
  18 sub _prepare_biblio_search_basics {
  19     my ($cgi) = @_;
  20
  21     return $cgi->param('query') unless $cgi->param('qtype');
  22
  23     my %parts;
  24     my @part_names = qw/qtype contains query bool/;
  25     $parts{$_} = [ $cgi->param($_) ] for (@part_names);
  26
  27     my $full_query = '';
  28     for (my $i = 0; $i < scalar @{$parts{'qtype'}}; $i++) {
  29         my ($qtype, $contains, $query, $bool) = map { $parts{$_}->[$i] } @part_names;
  30
  31         next unless $query =~ /\S/;
  32
  33         # This stuff probably will need refined or rethought to better handle
  34         # the weird things Real Users will surely type in.
  35         $contains = "" unless defined $contains; # silence warning
  36         if ($contains eq 'nocontains') {
  37             $query =~ s/"//g;
  38             $query = ('"' . $query . '"') if index $query, ' ';
  39             $query = '-' . $query;
  40         } elsif ($contains eq 'phrase') {
  41             $query =~ s/"//g;
  42             $query = ('"' . $query . '"') if index $query, ' ';
  43         } elsif ($contains eq 'exact') {
  44             $query =~ s/[\^\$]//g;
  45             $query = '^' . $query . '$';
  46         }
  47         $query = "$qtype:$query" unless $qtype eq 'keyword' and $i == 0;
  48
  49         $bool = ($bool and $bool eq 'or') ? '||' : '&&';
  50         $full_query = $full_query ? "($full_query $bool $query)" : $query;
  51     }
  52
  53     return $full_query;
  54 }
  55
  56 sub _prepare_biblio_search {
  57     my ($cgi, $ctx) = @_;
  58
  59     my $query = _prepare_biblio_search_basics($cgi) || '';
  60
  61     foreach ($cgi->param('modifier')) {
  62         # The unless bit is to avoid stacking modifiers.
  63         $query = ('#' . $_ . ' ' . $query) unless $query =~ qr/\#\Q$_/;
  64     }
  65
  66     # filters
  67     foreach (grep /^fi:/, $cgi->param) {
  68         /:(-?\w+)$/ or next;
  69         my $term = join(",", $cgi->param($_));
  70         $query .= " $1($term)" if length $term;
  71     }
  72
  73     # sort is treated specially, even though it's actually a filter
  74     if ($cgi->param('sort')) {
  75         $query =~ s/sort\([^\)]*\)//g;  # override existing sort(). no stacking.
  76         my ($axis, $desc) = split /\./, $cgi->param('sort');
  77         $query .= " sort($axis)";
  78         if ($desc and not $query =~ /\#descending/) {
  79             $query .= '#descending';
  80         } elsif (not $desc) {
  81             $query =~ s/\#descending//;
  82         }
  83     }
  84
  85     if ($cgi->param('pubdate') && $cgi->param('date1')) {
  86         if ($cgi->param('pubdate') eq 'between') {
  87             $query .= ' between(' . $cgi->param('date1');
  88             $query .= ',' .  $cgi->param('date2') if $cgi->param('date2');
  89             $query .= ')';
  90         } elsif ($cgi->param('pubdate') eq 'is') {
  91             $query .= ' between(' . $cgi->param('date1') .
  92                 ',' .  $cgi->param('date1') . ')';  # sic, date1 twice
  93         } else {
  94             $query .= ' ' . $cgi->param('pubdate') .
  95                 '(' . $cgi->param('date1') . ')';
  96         }
  97     }
  98
  99     my $site;
 100     my $org = $ctx->{search_ou};
 101     if (defined($org) and $org ne '' and ($org ne $ctx->{aou_tree}->()->id) and not $query =~ /site\(\S+\)/) {
 102         $site = $ctx->{get_aou}->($org)->shortname;
 103         $query .= " site($site)";
 104     }
 105
 106     if(!$site) {
 107         ($site) = ($query =~ /site\(([^\)]+)\)/);
 108         $site ||= $ctx->{aou_tree}->()->shortname;
 109     }
 110
 111     my $depth;
 112     if ($query =~ /depth\(\d+\)/) {
 113
 114         # depth is encoded in the search query
 115         ($depth) = ($query =~ /depth\((\d+)\)/);
 116
 117     } else {
 118
 119         if (defined $cgi->param('depth')) {
 120             $depth = $cgi->param('depth');
 121         } else {
 122             # no depth specified.  match the depth to the search org
 123             my ($org) = grep { $_->shortname eq $site } @{$ctx->{aou_list}->()};
 124             $depth = $org->ou_type->depth;
 125         }
 126         $query .= " depth($depth)";
 127     }
 128
 129     $logger->info("tpac: site=$site, depth=$depth, query=$query");
 130
 131     return ($query, $site, $depth);
 132 }
 133
 134 sub _get_search_limit {
 135     my $self = shift;
 136
 137     # param takes precedence
 138     my $limit = $self->cgi->param('limit');
 139     return $limit if $limit;
 140
 141     if($self->editor->requestor) {
 142         # See if the user has a hit count preference
 143         my $lset = $self->editor->search_actor_user_setting({
 144             usr => $self->editor->requestor->id,
 145             name => 'opac.hits_per_page'
 146         })->[0];
 147         return OpenSRF::Utils::JSON->JSON2perl($lset->value) if $lset;
 148     }
 149
 150     return 10; # default
 151 }
 152
 153 sub tag_circed_items {
 154     my $self = shift;
 155     my $e = $self->editor;
 156
 157     return 0 unless $e->requestor;
 158     return 0 unless $self->ctx->{get_org_setting}->(
 159         $e->requestor->home_ou,
 160         'opac.search.tag_circulated_items');
 161
 162     # user has to be opted-in to circ history in some capacity
 163     my $sets = $e->search_actor_user_setting({
 164         usr => $e->requestor->id,
 165         name => [
 166             'history.circ.retention_age',
 167             'history.circ.retention_start'
 168         ]
 169     });
 170
 171     return 0 unless @$sets;
 172     return 1;
 173 }
 174
 175 # context additions:
 176 #   page_size
 177 #   hit_count
 178 #   records : list of bre's and copy-count objects
 179 sub load_rresults {
 180     my $self = shift;
 181     my %args = @_;
 182     my $internal = $args{internal};
 183     my $cgi = $self->cgi;
 184     my $ctx = $self->ctx;
 185     my $e = $self->editor;
 186
 187     $ctx->{page} = 'rresult' unless $internal;
 188     $ctx->{ids} = [];
 189     $ctx->{records} = [];
 190     $ctx->{search_facets} = {};
 191     $ctx->{hit_count} = 0;
 192
 193     # Special alternative searches here.  This could all stand to be cleaner.
 194     if ($cgi->param("_special")) {
 195         return $self->marc_expert_search(%args) if scalar($cgi->param("tag"));
 196         return $self->item_barcode_shortcut if (
 197             $cgi->param("qtype") and ($cgi->param("qtype") eq "item_barcode")
 198         );
 199         return $self->call_number_browse_standalone if (
 200             $cgi->param("qtype") and ($cgi->param("qtype") eq "cnbrowse")
 201         );
 202     }
 203
 204     my $page = $cgi->param('page') || 0;
 205     my @facets = $cgi->param('facet');
 206     my $limit = $self->_get_search_limit;
 207     $ctx->{search_ou} = $self->_get_search_lib();
 208     my $offset = $page * $limit;
 209     my $metarecord = $cgi->param('metarecord');
 210     my $results;
 211     my $tag_circs = $self->tag_circed_items;
 212
 213     $ctx->{page_size} = $limit;
 214     $ctx->{search_page} = $page;
 215
 216     # fetch the first hit from the next page
 217     if ($internal) {
 218         $limit = $all_recs_limit;
 219         $offset = 0;
 220     }
 221
 222     my ($query, $site, $depth) = _prepare_biblio_search($cgi, $ctx);
 223
 224     $self->get_staff_search_settings;
 225
 226     if ($ctx->{staff_saved_search_size}) {
 227         my ($key, $list) = $self->staff_save_search($query);
 228         if ($key) {
 229             $self->apache->headers_out->add(
 230                 "Set-Cookie" => $self->cgi->cookie(
 231                     -name => (ref $self)->COOKIE_ANON_CACHE,
 232                     -path => "/",
 233                     -value => ($key || ''),
 234                     -expires => ($key ? undef : "-1h")
 235                 )
 236             );
 237             $ctx->{saved_searches} = $list;
 238         }
 239     }
 240
 241     if ($metarecord and !$internal) {
 242
 243         # TODO: other limits, like SVF/format, etc.
 244         $results = $U->simplereq(
 245             'open-ils.search',
 246             'open-ils.search.biblio.metarecord_to_records',
 247             $metarecord, {org => $ctx->{search_ou}, depth => $depth}
 248         );
 249
 250         # force the metarecord result blob to match the format of regular search results
 251         $results->{ids} = [map { [$_] } @{$results->{ids}}];
 252
 253     } else {
 254
 255         if (!$query) {
 256             return Apache2::Const::OK if $internal;
 257             return $self->generic_redirect;
 258         }
 259
 260         # Limit and offset will stay here. Everything else should be part of
 261         # the query string, not special args.
 262         my $args = {'limit' => $limit, 'offset' => $offset};
 263
 264         if ($tag_circs) {
 265             $args->{tag_circulated_records} = 1;
 266             $args->{authtoken} = $self->editor->authtoken;
 267         }
 268
 269         # Stuff these into the TT context so that templates can use them in redrawing forms
 270         $ctx->{processed_search_query} = $query;
 271
 272         $query .= " $_" for @facets;
 273
 274         $logger->activity("EGWeb: [search] $query");
 275
 276         try {
 277
 278             my $method = 'open-ils.search.biblio.multiclass.query';
 279             $method .= '.staff' if $ctx->{is_staff};
 280             $results = $U->simplereq('open-ils.search', $method, $args, $query, 1);
 281
 282         } catch Error with {
 283             my $err = shift;
 284             $logger->error("multiclass search error: $err");
 285             $results = {count => 0, ids => []};
 286         };
 287     }
 288
 289     my $rec_ids = [map { $_->[0] } @{$results->{ids}}];
 290
 291     $ctx->{ids} = $rec_ids;
 292     $ctx->{hit_count} = $results->{count};
 293     $ctx->{parsed_query} = $results->{parsed_query};
 294
 295     return Apache2::Const::OK if @$rec_ids == 0 or $internal;
 296
 297     my ($facets, @data) = $self->get_records_and_facets(
 298         $rec_ids, $results->{facet_key},
 299         {
 300             flesh => '{holdings_xml,mra,acp,acnp,acns,bmp}',
 301             site => $site,
 302             depth => $depth
 303         }
 304     );
 305
 306     if ($page == 0) {
 307         my $stat = $self->check_1hit_redirect($rec_ids);
 308         return $stat if $stat;
 309     }
 310
 311     # shove recs into context in search results order
 312     for my $rec_id (@$rec_ids) {
 313         push(
 314             @{$ctx->{records}},
 315             grep { $_->{id} == $rec_id } @data
 316         );
 317     }
 318
 319     if ($tag_circs) {
 320         for my $rec (@{$ctx->{records}}) {
 321             my ($res_rec) = grep { $_->[0] == $rec->{id} } @{$results->{ids}};
 322             # index 1 in the per-record result array is a boolean which
 323             # indicates whether the record in question is in the users
 324             # accessible circ history list
 325             $rec->{user_circulated} = 1 if $res_rec->[1];
 326         }
 327     }
 328
 329     $ctx->{search_facets} = $facets;
 330
 331     return Apache2::Const::OK;
 332 }
 333
 334 # If the calling search results in 1 record and the client
 335 # is configured to do so, redirect the search results to
 336 # the record details page.
 337 sub check_1hit_redirect {
 338     my ($self, $rec_ids) = @_;
 339     my $ctx = $self->ctx;
 340
 341     return undef unless $rec_ids and @$rec_ids == 1;
 342
 343     my ($sname, $org);
 344
 345     if ($ctx->{is_staff}) {
 346         $sname = 'opac.staff.jump_to_details_on_single_hit';
 347         $org = $ctx->{user}->ws_ou;
 348
 349     } else {
 350         $sname = 'opac.patron.jump_to_details_on_single_hit';
 351         $org = $self->_get_search_lib();
 352     }
 353
 354     return undef unless
 355         $self->ctx->{get_org_setting}->($org, $sname);
 356
 357     my $base_url = sprintf(
 358         '%s://%s%s/record/%s',
 359         $ctx->{proto},
 360         $self->apache->hostname,
 361         $self->ctx->{opac_root},
 362         $$rec_ids[0],
 363     );
 364
 365     # If we get here from the same record detail page to which we
 366     # now wish to redirect, do not perform the redirect.  This
 367     # approach seems to work well, with the rare exception of
 368     # performing a new serach directly from the detail page that
 369     # happens to result in the same single hit.  In this case, the
 370     # user will be left on the search results page.  This could be
 371     # overcome w/ additional CGI, etc., but I'm not sure it's necessary.
 372     if (my $referer = $ctx->{referer}) {
 373         $referer =~ s/([^?]*).*/$1/g;
 374         return undef if $base_url eq $referer;
 375     }
 376
 377     return $self->generic_redirect($base_url . '?' . $self->cgi->query_string);
 378 }
 379
 380 # Searching by barcode is a special search that does /not/ respect any other
 381 # of the usual search parameters, not even the ones for sorting and paging!
 382 sub item_barcode_shortcut {
 383     my ($self) = @_;
 384
 385     my $method = "open-ils.search.multi_home.bib_ids.by_barcode";
 386     if (my $search = create OpenSRF::AppSession("open-ils.search")) {
 387         my $rec_ids = $search->request(
 388             $method, $self->cgi->param("query")
 389         )->gather(1);
 390         $search->kill_me;
 391
 392         if (ref $rec_ids ne 'ARRAY') {
 393
 394             if($U->event_equals($rec_ids, 'ASSET_COPY_NOT_FOUND')) {
 395                 $rec_ids = [];
 396
 397             } else {
 398                 if (defined $U->event_code($rec_ids)) {
 399                     $self->apache->log->warn(
 400                         "$method returned event: " . $U->event_code($rec_ids)
 401                     );
 402                 } else {
 403                     $self->apache->log->warn(
 404                         "$method returned something unexpected: $rec_ids"
 405                     );
 406                 }
 407                 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
 408             }
 409         }
 410
 411         my ($facets, @data) = $self->get_records_and_facets(
 412             $rec_ids, undef, {flesh => "{holdings_xml,mra,acnp,acns,bmp}"}
 413         );
 414
 415         $self->ctx->{records} = [@data];
 416         $self->ctx->{search_facets} = {};
 417         $self->ctx->{hit_count} = scalar @data;
 418         $self->ctx->{page_size} = $self->ctx->{hit_count};
 419
 420         return Apache2::Const::OK;
 421     } {
 422         $self->apache->log->warn("couldn't connect to open-ils.search");
 423         return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
 424     }
 425 }
 426
 427 # like item_barcode_search, this can't take all the usual search params, but
 428 # this one will at least do site, limit and page
 429 sub marc_expert_search {
 430     my ($self, %args) = @_;
 431
 432     my @tags = $self->cgi->param("tag");
 433     my @subfields = $self->cgi->param("subfield");
 434     my @terms = $self->cgi->param("term");
 435
 436     my $query = [];
 437     for (my $i = 0; $i < scalar @tags; $i++) {
 438         next if ($tags[$i] eq "" || $terms[$i] eq "");
 439         $subfields[$i] = '_' unless $subfields[$i];
 440         push @$query, {
 441             "term" => $terms[$i],
 442             "restrict" => [{"tag" => $tags[$i], "subfield" => $subfields[$i]}]
 443         };
 444     }
 445
 446     $logger->info("query for expert search: " . Dumper($query));
 447
 448     # loc, limit and offset
 449     my $page = $self->cgi->param("page") || 0;
 450     my $limit = $self->_get_search_limit;
 451     $self->ctx->{search_ou} = $self->_get_search_lib();
 452     my $offset = $page * $limit;
 453
 454     $self->ctx->{records} = [];
 455     $self->ctx->{search_facets} = {};
 456     $self->ctx->{page_size} = $limit;
 457     $self->ctx->{hit_count} = 0;
 458     $self->ctx->{ids} = [];
 459     $self->ctx->{search_page} = $page;
 460
 461     # nothing to do
 462     return Apache2::Const::OK if @$query == 0;
 463
 464     if ($args{internal}) {
 465         $limit = $all_recs_limit;
 466         $offset = 0;
 467     }
 468
 469     my $timeout = 120;
 470     my $ses = OpenSRF::AppSession->create('open-ils.search');
 471     my $req = $ses->request(
 472         'open-ils.search.biblio.marc',
 473         {searches => $query, org_unit => $self->ctx->{search_ou}},
 474         $limit, $offset, $timeout);
 475
 476     my $resp = $req->recv($timeout);
 477     my $results = $resp ? $resp->content : undef;
 478     $ses->kill_me;
 479
 480     if (defined $U->event_code($results)) {
 481         $self->apache->log->warn(
 482             "open-ils.search.biblio.marc returned event: " .
 483             $U->event_code($results)
 484         );
 485         return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
 486     }
 487
 488     $self->ctx->{ids} = [ grep { $_ } @{$results->{ids}} ];
 489     $self->ctx->{hit_count} = $results->{count};
 490
 491     return Apache2::Const::OK if @{$self->ctx->{ids}} == 0 or $args{internal};
 492
 493     if ($page == 0) {
 494         my $stat = $self->check_1hit_redirect($self->ctx->{ids});
 495         return $stat if $stat;
 496     }
 497
 498     my ($facets, @data) = $self->get_records_and_facets(
 499         $self->ctx->{ids}, undef, {flesh => "{holdings_xml,mra,acnp,acns}"}
 500     );
 501
 502     $self->ctx->{records} = [@data];
 503
 504     return Apache2::Const::OK;
 505 }
 506
 507 sub call_number_browse_standalone {
 508     my ($self) = @_;
 509
 510     if (my $cnfrag = $self->cgi->param("query")) {
 511         my $url = sprintf(
 512             'http%s://%s%s/cnbrowse?cn=%s',
 513             $self->cgi->https ? "s" : "",
 514             $self->apache->hostname,
 515             $self->ctx->{opac_root},
 516             $cnfrag # XXX some kind of escaping needed here?
 517         );
 518         return $self->generic_redirect($url);
 519     } else {
 520         return $self->generic_redirect; # return to search page
 521     }
 522 }
 523
 524 sub load_cnbrowse {
 525     my ($self) = @_;
 526
 527     $self->prepare_browse_call_numbers();
 528
 529     return Apache2::Const::OK;
 530 }
 531
 532 sub get_staff_search_settings {
 533     my ($self) = @_;
 534
 535     unless ($self->ctx->{is_staff}) {
 536         $self->ctx->{staff_saved_search_size} = 0;
 537         return;
 538     }
 539
 540     my $sss_size = $self->ctx->{get_org_setting}->(
 541         $self->ctx->{physical_loc} || $self->ctx->{aou_tree}->()->id,
 542         "opac.staff_saved_search.size",
 543     );
 544
 545     # Sic: 0 is 0 (off), but undefined is 10.
 546     $sss_size = 10 unless defined $sss_size;
 547
 548     $self->ctx->{staff_saved_search_size} = $sss_size;
 549 }
 550
 551 sub staff_load_searches {
 552     my ($self) = @_;
 553
 554     my $cache_key = $self->cgi->cookie((ref $self)->COOKIE_ANON_CACHE);
 555
 556     my $list = [];
 557     if ($cache_key) {
 558         $list = $U->simplereq(
 559             "open-ils.actor",
 560             "open-ils.actor.anon_cache.get_value",
 561             $cache_key, (ref $self)->ANON_CACHE_STAFF_SEARCH
 562         );
 563
 564         unless ($list) {
 565             undef $cache_key;
 566             $list = [];
 567         }
 568     }
 569
 570     return ($cache_key, $list);
 571 }
 572
 573 sub staff_save_search {
 574     my ($self, $query) = @_;
 575
 576     my $sss_size = $self->ctx->{staff_saved_search_size};
 577     return unless $sss_size > 0;
 578
 579     my ($cache_key, $list) = $self->staff_load_searches;
 580     my %already = ( map { $_ => 1 } @$list );
 581
 582     unshift @$list, $query unless $already{$query};
 583
 584     splice @$list, $sss_size;
 585
 586     $cache_key = $U->simplereq(
 587         "open-ils.actor",
 588         "open-ils.actor.anon_cache.set_value",
 589         $cache_key, (ref $self)->ANON_CACHE_STAFF_SEARCH, $list
 590     );
 591
 592     return ($cache_key, $list);
 593 }
 594
 595 1;