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;
10 $Data::Dumper::Indent = 0;
11 my $U = 'OpenILS::Application::AppUtils';
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;
18 sub _prepare_biblio_search_basics {
21 return $cgi->param('query') unless $cgi->param('qtype');
24 my @part_names = qw/qtype contains query bool/;
25 $parts{$_} = [ $cgi->param($_) ] for (@part_names);
28 for (my $i = 0; $i < scalar @{$parts{'qtype'}}; $i++) {
29 my ($qtype, $contains, $query, $bool) = map { $parts{$_}->[$i] } @part_names;
31 next unless $query =~ /\S/;
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') {
38 $query = ('"' . $query . '"') if index $query, ' ';
39 $query = '-' . $query;
40 } elsif ($contains eq 'phrase') {
42 $query = ('"' . $query . '"') if index $query, ' ';
43 } elsif ($contains eq 'exact') {
44 $query =~ s/[\^\$]//g;
45 $query = '^' . $query . '$';
47 $query = "$qtype:$query" unless $qtype eq 'keyword' and $i == 0;
49 $bool = ($bool and $bool eq 'or') ? '||' : '&&';
50 $full_query = $full_query ? "($full_query $bool $query)" : $query;
56 sub _prepare_biblio_search {
59 my $query = _prepare_biblio_search_basics($cgi) || '';
61 foreach ($cgi->param('modifier')) {
62 # The unless bit is to avoid stacking modifiers.
63 $query = ('#' . $_ . ' ' . $query) unless $query =~ qr/\#\Q$_/;
67 foreach (grep /^fi:/, $cgi->param) {
69 my $term = join(",", $cgi->param($_));
70 $query .= " $1($term)" if length $term;
73 if ($cgi->param("bookbag")) {
74 $query .= " container(bre,bookbag," . int($cgi->param("bookbag")) . ")";
77 if ($cgi->param('pubdate') && $cgi->param('date1')) {
78 if ($cgi->param('pubdate') eq 'between') {
79 $query .= ' between(' . $cgi->param('date1');
80 $query .= ',' . $cgi->param('date2') if $cgi->param('date2');
82 } elsif ($cgi->param('pubdate') eq 'is') {
83 $query .= ' between(' . $cgi->param('date1') .
84 ',' . $cgi->param('date1') . ')'; # sic, date1 twice
86 $query .= ' ' . $cgi->param('pubdate') .
87 '(' . $cgi->param('date1') . ')';
91 # ---------------------------------------------------------------------
92 # Nothing below here constitutes a query by itself. If the query value
93 # is still empty up to this point, there is no query. abandon ship.
94 return () unless $query;
96 # sort is treated specially, even though it's actually a filter
97 if ($cgi->param('sort')) {
98 $query =~ s/sort\([^\)]*\)//g; # override existing sort(). no stacking.
99 my ($axis, $desc) = split /\./, $cgi->param('sort');
100 $query .= " sort($axis)";
101 if ($desc and not $query =~ /\#descending/) {
102 $query .= '#descending';
103 } elsif (not $desc) {
104 $query =~ s/\#descending//;
109 my $org = $ctx->{search_ou};
110 if (defined($org) and $org ne '' and ($org ne $ctx->{aou_tree}->()->id) and not $query =~ /site\(\S+\)/) {
111 $site = $ctx->{get_aou}->($org)->shortname;
112 $query .= " site($site)";
115 if (my $grp = $ctx->{copy_location_group}) {
116 $query .= " location_groups($grp)";
120 ($site) = ($query =~ /site\(([^\)]+)\)/);
121 $site ||= $ctx->{aou_tree}->()->shortname;
125 if ($query =~ /depth\(\d+\)/) {
127 # depth is encoded in the search query
128 ($depth) = ($query =~ /depth\((\d+)\)/);
132 if (defined $cgi->param('depth')) {
133 $depth = $cgi->param('depth');
135 # no depth specified. match the depth to the search org
136 my ($org) = grep { $_->shortname eq $site } @{$ctx->{aou_list}->()};
137 $depth = $org->ou_type->depth;
139 $query .= " depth($depth)";
142 $logger->info("tpac: site=$site, depth=$depth, query=$query");
144 return ($query, $site, $depth);
147 sub _get_search_limit {
150 # param takes precedence
151 my $limit = $self->cgi->param('limit');
152 return $limit if $limit;
154 if($self->editor->requestor) {
155 # See if the user has a hit count preference
156 my $lset = $self->editor->search_actor_user_setting({
157 usr => $self->editor->requestor->id,
158 name => 'opac.hits_per_page'
160 return OpenSRF::Utils::JSON->JSON2perl($lset->value) if $lset;
166 sub tag_circed_items {
168 my $e = $self->editor;
170 return 0 unless $e->requestor;
171 return 0 unless $self->ctx->{get_org_setting}->(
172 $e->requestor->home_ou,
173 'opac.search.tag_circulated_items');
175 # user has to be opted-in to circ history in some capacity
176 my $sets = $e->search_actor_user_setting({
177 usr => $e->requestor->id,
179 'history.circ.retention_age',
180 'history.circ.retention_start'
184 return 0 unless @$sets;
189 # This only loads the bookbag itself (in support of a record results page)
190 # if a "bookbag" CGI parameter is specified and if the bookbag is public
191 # or owned by the logged-in user (if any). Bookbag notes are fetched
192 # later if applicable.
193 sub load_rresults_bookbag {
196 my $bookbag_id = int($self->cgi->param("bookbag") || 0);
197 return if $bookbag_id < 1;
199 my %authz = $self->ctx->{"user"} ?
200 ("-or" => {"pub" => "t", "owner" => $self->ctx->{"user"}->id}) :
203 my $bbag = $self->editor->search_container_biblio_record_entry_bucket(
204 {"id" => $bookbag_id, "btype" => "bookbag", %authz}
208 $self->apache->log->warn(
209 "error from cstore retrieving bookbag $bookbag_id!"
211 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
213 $self->ctx->{"bookbag"} = shift @$bbag;
219 # assumes context has a bookbag we're already authorized to look at, and
220 # a list of rec_ids, reasonably sized (from paged search).
221 sub load_rresults_bookbag_item_notes {
222 my ($self, $rec_ids) = @_;
224 my $items_with_notes =
225 $self->editor->search_container_biblio_record_entry_bucket_item([
226 {"target_biblio_record_entry" => $rec_ids,
227 "bucket" => $self->ctx->{"bookbag"}->id},
228 {"flesh" => 1, "flesh_fields" => {"cbrebi" => ["notes"]},
229 "order_by" => {"cbrebi" => ["id"]}}
232 if (!$items_with_notes) {
233 $self->apache->log->warn("error from cstore retrieving cbrebi objects");
234 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
237 $self->ctx->{"bookbag_items_by_bre_id"} = +{
238 map { $_->target_biblio_record_entry => $_ } @$items_with_notes
247 # records : list of bre's and copy-count objects
251 my $internal = $args{internal};
252 my $cgi = $self->cgi;
253 my $ctx = $self->ctx;
254 my $e = $self->editor;
256 # load bookbag metadata, if requested.
257 if (my $bbag_err = $self->load_rresults_bookbag) {
261 $ctx->{page} = 'rresult' unless $internal;
263 $ctx->{records} = [];
264 $ctx->{search_facets} = {};
265 $ctx->{hit_count} = 0;
267 # Special alternative searches here. This could all stand to be cleaner.
268 if ($cgi->param("_special")) {
269 return $self->marc_expert_search(%args) if scalar($cgi->param("tag"));
270 return $self->item_barcode_shortcut if (
271 $cgi->param("qtype") and ($cgi->param("qtype") eq "item_barcode")
273 return $self->call_number_browse_standalone if (
274 $cgi->param("qtype") and ($cgi->param("qtype") eq "cnbrowse")
278 my $page = $cgi->param('page') || 0;
279 my @facets = $cgi->param('facet');
280 my $limit = $self->_get_search_limit;
281 $ctx->{search_ou} = $self->_get_search_lib();
282 $ctx->{pref_ou} = $self->_get_pref_lib() || $ctx->{search_ou};
283 my $offset = $page * $limit;
284 my $metarecord = $cgi->param('metarecord');
286 my $tag_circs = $self->tag_circed_items;
288 $ctx->{page_size} = $limit;
289 $ctx->{search_page} = $page;
291 # fetch the first hit from the next page
293 $limit = $all_recs_limit;
297 my ($query, $site, $depth) = _prepare_biblio_search($cgi, $ctx);
299 $self->get_staff_search_settings;
301 if ($ctx->{staff_saved_search_size}) {
302 my ($key, $list) = $self->staff_save_search($query);
304 $self->apache->headers_out->add(
305 "Set-Cookie" => $self->cgi->cookie(
306 -name => (ref $self)->COOKIE_ANON_CACHE,
308 -value => ($key || ''),
309 -expires => ($key ? undef : "-1h")
312 $ctx->{saved_searches} = $list;
316 if ($metarecord and !$internal) {
318 # TODO: other limits, like SVF/format, etc.
319 $results = $U->simplereq(
321 'open-ils.search.biblio.metarecord_to_records',
322 $metarecord, {org => $ctx->{search_ou}, depth => $depth}
325 # force the metarecord result blob to match the format of regular search results
326 $results->{ids} = [map { [$_] } @{$results->{ids}}];
331 return Apache2::Const::OK if $internal;
332 return $self->generic_redirect;
335 # Limit and offset will stay here. Everything else should be part of
336 # the query string, not special args.
337 my $args = {'limit' => $limit, 'offset' => $offset};
340 $args->{tag_circulated_records} = 1;
341 $args->{authtoken} = $self->editor->authtoken;
344 # Stuff these into the TT context so that templates can use them in redrawing forms
345 $ctx->{processed_search_query} = $query;
347 $query .= " $_" for @facets;
349 $logger->activity("EGWeb: [search] $query");
353 my $method = 'open-ils.search.biblio.multiclass.query';
354 $method .= '.staff' if $ctx->{is_staff};
355 $results = $U->simplereq('open-ils.search', $method, $args, $query, 1);
359 $logger->error("multiclass search error: $err");
360 $results = {count => 0, ids => []};
364 my $rec_ids = [map { $_->[0] } @{$results->{ids}}];
366 $ctx->{ids} = $rec_ids;
367 $ctx->{hit_count} = $results->{count};
368 $ctx->{parsed_query} = $results->{parsed_query};
370 return Apache2::Const::OK if @$rec_ids == 0 or $internal;
372 $self->load_rresults_bookbag_item_notes($rec_ids) if $ctx->{bookbag};
374 my ($facets, @data) = $self->get_records_and_facets(
375 $rec_ids, $results->{facet_key},
377 flesh => '{holdings_xml,mra,acp,acnp,acns,bmp}',
380 pref_lib => $ctx->{pref_ou},
385 my $stat = $self->check_1hit_redirect($rec_ids);
386 return $stat if $stat;
389 # shove recs into context in search results order
390 for my $rec_id (@$rec_ids) {
393 grep { $_->{id} == $rec_id } @data
398 for my $rec (@{$ctx->{records}}) {
399 my ($res_rec) = grep { $_->[0] == $rec->{id} } @{$results->{ids}};
400 # index 1 in the per-record result array is a boolean which
401 # indicates whether the record in question is in the users
402 # accessible circ history list
403 $rec->{user_circulated} = 1 if $res_rec->[1];
407 $ctx->{search_facets} = $facets;
409 return Apache2::Const::OK;
412 # If the calling search results in 1 record and the client
413 # is configured to do so, redirect the search results to
414 # the record details page.
415 sub check_1hit_redirect {
416 my ($self, $rec_ids) = @_;
417 my $ctx = $self->ctx;
419 return undef unless $rec_ids and @$rec_ids == 1;
423 if ($ctx->{is_staff}) {
424 $sname = 'opac.staff.jump_to_details_on_single_hit';
425 $org = $ctx->{user}->ws_ou;
428 $sname = 'opac.patron.jump_to_details_on_single_hit';
429 $org = $self->_get_search_lib();
433 $self->ctx->{get_org_setting}->($org, $sname);
435 my $base_url = sprintf(
436 '%s://%s%s/record/%s',
438 $self->apache->hostname,
439 $self->ctx->{opac_root},
443 # If we get here from the same record detail page to which we
444 # now wish to redirect, do not perform the redirect. This
445 # approach seems to work well, with the rare exception of
446 # performing a new serach directly from the detail page that
447 # happens to result in the same single hit. In this case, the
448 # user will be left on the search results page. This could be
449 # overcome w/ additional CGI, etc., but I'm not sure it's necessary.
450 if (my $referer = $ctx->{referer}) {
451 $referer =~ s/([^?]*).*/$1/g;
452 return undef if $base_url eq $referer;
455 return $self->generic_redirect($base_url . '?' . $self->cgi->query_string);
458 # Searching by barcode is a special search that does /not/ respect any other
459 # of the usual search parameters, not even the ones for sorting and paging!
460 sub item_barcode_shortcut {
463 my $method = "open-ils.search.multi_home.bib_ids.by_barcode";
464 if (my $search = create OpenSRF::AppSession("open-ils.search")) {
465 my $rec_ids = $search->request(
466 $method, $self->cgi->param("query")
470 if (ref $rec_ids ne 'ARRAY') {
472 if($U->event_equals($rec_ids, 'ASSET_COPY_NOT_FOUND')) {
476 if (defined $U->event_code($rec_ids)) {
477 $self->apache->log->warn(
478 "$method returned event: " . $U->event_code($rec_ids)
481 $self->apache->log->warn(
482 "$method returned something unexpected: $rec_ids"
485 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
489 my ($facets, @data) = $self->get_records_and_facets(
490 $rec_ids, undef, {flesh => "{holdings_xml,mra,acnp,acns,bmp}"}
493 $self->ctx->{records} = [@data];
494 $self->ctx->{search_facets} = {};
495 $self->ctx->{hit_count} = scalar @data;
496 $self->ctx->{page_size} = $self->ctx->{hit_count};
498 return Apache2::Const::OK;
500 $self->apache->log->warn("couldn't connect to open-ils.search");
501 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
505 # like item_barcode_search, this can't take all the usual search params, but
506 # this one will at least do site, limit and page
507 sub marc_expert_search {
508 my ($self, %args) = @_;
510 my @tags = $self->cgi->param("tag");
511 my @subfields = $self->cgi->param("subfield");
512 my @terms = $self->cgi->param("term");
515 for (my $i = 0; $i < scalar @tags; $i++) {
516 next if ($tags[$i] eq "" || $terms[$i] eq "");
517 $subfields[$i] = '_' unless $subfields[$i];
519 "term" => $terms[$i],
520 "restrict" => [{"tag" => $tags[$i], "subfield" => $subfields[$i]}]
524 $logger->info("query for expert search: " . Dumper($query));
526 # loc, limit and offset
527 my $page = $self->cgi->param("page") || 0;
528 my $limit = $self->_get_search_limit;
529 $self->ctx->{search_ou} = $self->_get_search_lib();
530 $self->ctx->{pref_ou} = $self->_get_pref_lib();
531 my $offset = $page * $limit;
533 $self->ctx->{records} = [];
534 $self->ctx->{search_facets} = {};
535 $self->ctx->{page_size} = $limit;
536 $self->ctx->{hit_count} = 0;
537 $self->ctx->{ids} = [];
538 $self->ctx->{search_page} = $page;
541 return Apache2::Const::OK if @$query == 0;
543 if ($args{internal}) {
544 $limit = $all_recs_limit;
549 my $ses = OpenSRF::AppSession->create('open-ils.search');
550 my $req = $ses->request(
551 'open-ils.search.biblio.marc',
552 {searches => $query, org_unit => $self->ctx->{search_ou}},
553 $limit, $offset, $timeout);
555 my $resp = $req->recv($timeout);
556 my $results = $resp ? $resp->content : undef;
559 if (defined $U->event_code($results)) {
560 $self->apache->log->warn(
561 "open-ils.search.biblio.marc returned event: " .
562 $U->event_code($results)
564 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
567 $self->ctx->{ids} = [ grep { $_ } @{$results->{ids}} ];
568 $self->ctx->{hit_count} = $results->{count};
570 return Apache2::Const::OK if @{$self->ctx->{ids}} == 0 or $args{internal};
573 my $stat = $self->check_1hit_redirect($self->ctx->{ids});
574 return $stat if $stat;
577 my ($facets, @data) = $self->get_records_and_facets(
578 $self->ctx->{ids}, undef, {
579 flesh => "{holdings_xml,mra,acnp,acns}",
580 pref_lib => $self->ctx->{pref_ou},
584 $self->ctx->{records} = [@data];
586 return Apache2::Const::OK;
589 sub call_number_browse_standalone {
592 if (my $cnfrag = $self->cgi->param("query")) {
594 'http%s://%s%s/cnbrowse?cn=%s',
595 $self->cgi->https ? "s" : "",
596 $self->apache->hostname,
597 $self->ctx->{opac_root},
598 $cnfrag # XXX some kind of escaping needed here?
600 return $self->generic_redirect($url);
602 return $self->generic_redirect; # return to search page
609 $self->prepare_browse_call_numbers();
611 return Apache2::Const::OK;
614 sub get_staff_search_settings {
617 unless ($self->ctx->{is_staff}) {
618 $self->ctx->{staff_saved_search_size} = 0;
622 my $sss_size = $self->ctx->{get_org_setting}->(
623 $self->ctx->{physical_loc} || $self->ctx->{aou_tree}->()->id,
624 "opac.staff_saved_search.size",
627 # Sic: 0 is 0 (off), but undefined is 10.
628 $sss_size = 10 unless defined $sss_size;
630 $self->ctx->{staff_saved_search_size} = $sss_size;
633 sub staff_load_searches {
636 my $cache_key = $self->cgi->cookie((ref $self)->COOKIE_ANON_CACHE);
640 $list = $U->simplereq(
642 "open-ils.actor.anon_cache.get_value",
643 $cache_key, (ref $self)->ANON_CACHE_STAFF_SEARCH
652 return ($cache_key, $list);
655 sub staff_save_search {
656 my ($self, $query) = @_;
658 my $sss_size = $self->ctx->{staff_saved_search_size};
659 return unless $sss_size > 0;
661 my ($cache_key, $list) = $self->staff_load_searches;
662 my %already = ( map { $_ => 1 } @$list );
664 unshift @$list, $query unless $already{$query};
666 splice @$list, $sss_size if scalar @$list > $sss_size;
668 $cache_key = $U->simplereq(
670 "open-ils.actor.anon_cache.set_value",
671 $cache_key, (ref $self)->ANON_CACHE_STAFF_SEARCH, $list
674 return ($cache_key, $list);