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 sub _prepare_biblio_search_basics {
16 return $cgi->param('query') unless $cgi->param('qtype');
19 my @part_names = qw/qtype contains query bool/;
20 $parts{$_} = [ $cgi->param($_) ] for (@part_names);
23 for (my $i = 0; $i < scalar @{$parts{'qtype'}}; $i++) {
24 my ($qtype, $contains, $query, $bool) = map { $parts{$_}->[$i] } @part_names;
26 next unless $query =~ /\S/;
28 # Hack for journal title
34 # This stuff probably will need refined or rethought to better handle
35 # the weird things Real Users will surely type in.
36 $contains = "" unless defined $contains; # silence warning
37 if ($contains eq 'nocontains') {
39 $query = ('"' . $query . '"') if index $query, ' ';
40 $query = '-' . $query;
41 } elsif ($contains eq 'phrase') {
43 $query = ('"' . $query . '"') if index $query, ' ';
44 } elsif ($contains eq 'exact') {
45 $query =~ s/[\^\$]//g;
46 $query = '^' . $query . '$';
48 $query = "$qtype:$query" unless $qtype eq 'keyword' and $i == 0;
50 # Hack for journal title - completed!
52 $query = "bib_level:s $query";
55 $bool = ($bool and $bool eq 'or') ? '||' : '&&';
56 $full_query = $full_query ? "($full_query $bool $query)" : $query;
62 sub _prepare_biblio_search {
65 my $query = _prepare_biblio_search_basics($cgi) || '';
67 foreach ($cgi->param('modifier')) {
68 # The unless bit is to avoid stacking modifiers.
69 $query = ('#' . $_ . ' ' . $query) unless $query =~ qr/\#\Q$_/;
73 foreach (grep /^fi:/, $cgi->param) {
75 my $term = join(",", $cgi->param($_));
76 $query .= " $1($term)" if length $term;
79 # filter group entries. Entries from like filters are grouped into a single
80 # filter_group_entry() filter (ORed). Each collection is ANDed together.
81 # fg:foo_group=foo_entry_id
82 foreach (grep /^fg:/, $cgi->param) {
84 my $term = join(",", $cgi->param($_));
85 $query .= " filter_group_entry($term)" if length $term;
88 if ($cgi->param("bookbag")) {
89 $query .= " container(bre,bookbag," . int($cgi->param("bookbag")) . ")";
92 if ($cgi->param('pubdate') && $cgi->param('date1')) {
93 if ($cgi->param('pubdate') eq 'between') {
94 $query .= ' between(' . $cgi->param('date1');
95 $query .= ',' . $cgi->param('date2') if $cgi->param('date2');
97 } elsif ($cgi->param('pubdate') eq 'is') {
98 $query .= ' between(' . $cgi->param('date1') .
99 ',' . $cgi->param('date1') . ')'; # sic, date1 twice
101 $query .= ' ' . $cgi->param('pubdate') .
102 '(' . $cgi->param('date1') . ')';
106 # ---------------------------------------------------------------------
107 # Nothing below here constitutes a query by itself. If the query value
108 # is still empty up to this point, there is no query. abandon ship.
109 return () unless $query;
111 # sort is treated specially, even though it's actually a filter
112 if ($cgi->param('sort')) {
113 $query =~ s/sort\([^\)]*\)//g; # override existing sort(). no stacking.
114 my ($axis, $desc) = split /\./, $cgi->param('sort');
115 $query .= " sort($axis)";
116 if ($desc and not $query =~ /\#descending/) {
117 $query .= '#descending';
118 } elsif (not $desc) {
119 $query =~ s/\#descending//;
123 my (@naive_query_re, $site);
125 my $org = $ctx->{search_ou};
126 if (defined($org) and $org ne '' and ($org ne $ctx->{aou_tree}->()->id) and not $query =~ /site\(\S+\)/) {
127 my $thing = " site(" . $ctx->{get_aou}->($org)->shortname . ")";
130 push @naive_query_re, $thing;
133 my $pref_ou = $ctx->{pref_ou};
134 if (defined($pref_ou) and $pref_ou ne '' and $pref_ou != $org and ($pref_ou ne $ctx->{aou_tree}->()->id)) {
135 my $plib = $ctx->{get_aou}->($pref_ou)->shortname;
136 $query .= " pref_ou($plib)";
139 if (my $grp = $ctx->{copy_location_group}) {
140 $query .= " location_groups($grp)";
144 ($site) = ($query =~ /site\(([^\)]+)\)/);
145 $site ||= $ctx->{aou_tree}->()->shortname;
149 if ($query =~ /depth\(\d+\)/) {
151 # depth is encoded in the search query
152 ($depth) = ($query =~ /depth\((\d+)\)/);
156 if (defined $cgi->param('depth')) {
157 $depth = $cgi->param('depth');
159 # no depth specified. match the depth to the search org
160 my ($org) = grep { $_->shortname eq $site } @{$ctx->{aou_list}->()};
161 $depth = $org->ou_type->depth;
163 my $thing = " depth($depth)";
166 push @naive_query_re, $thing;
169 # This gives templates a way to take site() and depth() back out of
170 # query strings when they shouldn't be there (because they're controllable
171 # with other widgets).
172 $ctx->{naive_query_scrub} = sub {
174 $query =~ s/\Q$_\E// foreach (@naive_query_re);
178 $logger->info("tpac: site=$site, depth=$depth, query=$query");
180 return ($query, $site, $depth);
183 sub _get_search_limit {
186 # param takes precedence
187 my $limit = $self->cgi->param('limit');
188 return $limit if $limit;
190 if($self->editor->requestor) {
191 $self->timelog("Checking for opac.hits_per_page preference");
192 # See if the user has a hit count preference
193 my $lset = $self->editor->search_actor_user_setting({
194 usr => $self->editor->requestor->id,
195 name => 'opac.hits_per_page'
197 $self->timelog("Got opac.hits_per_page preference");
198 return OpenSRF::Utils::JSON->JSON2perl($lset->value) if $lset;
204 sub tag_circed_items {
206 my $e = $self->editor;
208 $self->timelog("Tag circed items?");
209 return 0 unless $e->requestor;
210 $self->timelog("Checking for opac.search.tag_circulated_items");
211 return 0 unless $self->ctx->{get_org_setting}->(
212 $e->requestor->home_ou,
213 'opac.search.tag_circulated_items');
215 # user has to be opted-in to circ history in some capacity
216 $self->timelog("Checking for history.circ.retention_*");
217 my $sets = $e->search_actor_user_setting({
218 usr => $e->requestor->id,
220 'history.circ.retention_age',
221 'history.circ.retention_start'
225 $self->timelog("Return from checking for history.circ.retention_*");
227 return 0 unless @$sets;
232 # This only loads the bookbag itself (in support of a record results page)
233 # if a "bookbag" CGI parameter is specified and if the bookbag is public
234 # or owned by the logged-in user (if any). Bookbag notes are fetched
235 # later if applicable.
236 sub load_rresults_bookbag {
239 my $bookbag_id = int($self->cgi->param("bookbag") || 0);
240 return if $bookbag_id < 1;
242 my %authz = $self->ctx->{"user"} ?
243 ("-or" => {"pub" => "t", "owner" => $self->ctx->{"user"}->id}) :
246 $self->timelog("Load results bookbag");
247 my $bbag = $self->editor->search_container_biblio_record_entry_bucket(
248 {"id" => $bookbag_id, "btype" => "bookbag", %authz}
250 $self->timelog("Got results bookbag");
253 $self->apache->log->warn(
254 "error from cstore retrieving bookbag $bookbag_id!"
256 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
258 $self->ctx->{"bookbag"} = shift @$bbag;
264 # assumes context has a bookbag we're already authorized to look at, and
265 # a list of rec_ids, reasonably sized (from paged search).
266 sub load_rresults_bookbag_item_notes {
267 my ($self, $rec_ids) = @_;
269 $self->timelog("Load results bookbag item notes");
270 my $items_with_notes =
271 $self->editor->search_container_biblio_record_entry_bucket_item([
272 {"target_biblio_record_entry" => $rec_ids,
273 "bucket" => $self->ctx->{"bookbag"}->id},
274 {"flesh" => 1, "flesh_fields" => {"cbrebi" => ["notes"]},
275 "order_by" => {"cbrebi" => ["id"]}}
277 $self->timelog("Got results bookbag item notes");
279 if (!$items_with_notes) {
280 $self->apache->log->warn("error from cstore retrieving cbrebi objects");
281 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
284 $self->ctx->{"bookbag_items_by_bre_id"} = +{
285 map { $_->target_biblio_record_entry => $_ } @$items_with_notes
294 # records : list of bre's and copy-count objects
298 my $internal = $args{internal};
299 my $cgi = $self->cgi;
300 my $ctx = $self->ctx;
301 my $e = $self->editor;
303 # find the last record in the set, then redirect
304 my $find_last = $cgi->param('find_last');
306 $self->timelog("Loading results");
307 # load bookbag metadata, if requested.
308 if (my $bbag_err = $self->load_rresults_bookbag) {
312 $ctx->{page} = 'rresult' unless $internal;
314 $ctx->{records} = [];
315 $ctx->{search_facets} = {};
316 $ctx->{hit_count} = 0;
318 # Special alternative searches here. This could all stand to be cleaner.
319 if ($cgi->param("_special")) {
320 $self->timelog("Calling MARC expert search");
321 return $self->marc_expert_search(%args) if scalar($cgi->param("tag"));
322 $self->timelog("Calling item barcode search");
323 return $self->item_barcode_shortcut if (
324 $cgi->param("qtype") and ($cgi->param("qtype") eq "item_barcode")
326 $self->timelog("Calling call number browse");
327 return $self->call_number_browse_standalone if (
328 $cgi->param("qtype") and ($cgi->param("qtype") eq "cnbrowse")
332 $self->timelog("Getting search parameters");
333 my $page = $cgi->param('page') || 0;
334 my @facets = $cgi->param('facet');
335 my $limit = $self->_get_search_limit;
336 $ctx->{search_ou} = $self->_get_search_lib();
337 $ctx->{pref_ou} = $self->_get_pref_lib() || $ctx->{search_ou};
338 my $offset = $page * $limit;
339 my $metarecord = $cgi->param('metarecord');
341 my $tag_circs = $self->tag_circed_items;
342 $self->timelog("Got search parameters");
344 $ctx->{page_size} = $limit;
345 $ctx->{search_page} = $page;
347 # fetch this page plus the first hit from the next page
349 $limit = $offset + $limit + 1;
353 my ($query, $site, $depth) = _prepare_biblio_search($cgi, $ctx);
355 $self->get_staff_search_settings;
357 if (!$find_last and $ctx->{staff_saved_search_size}) {
358 my ($key, $list) = $self->staff_save_search($query);
360 $self->apache->headers_out->add(
361 "Set-Cookie" => $self->cgi->cookie(
362 -name => (ref $self)->COOKIE_ANON_CACHE,
364 -value => ($key || ''),
365 -expires => ($key ? undef : "-1h")
368 $ctx->{saved_searches} = $list;
372 if ($metarecord and !$internal) {
374 # TODO: other limits, like SVF/format, etc.
375 $self->timelog("Getting metarecords to records");
376 $results = $U->simplereq(
378 'open-ils.search.biblio.metarecord_to_records',
379 $metarecord, {org => $ctx->{search_ou}, depth => $depth}
381 $self->timelog("Got metarecords to records");
383 # force the metarecord result blob to match the format of regular search results
384 $results->{ids} = [map { [$_] } @{$results->{ids}}];
389 return Apache2::Const::OK if $internal;
390 return $self->generic_redirect;
393 # Limit and offset will stay here. Everything else should be part of
394 # the query string, not special args.
395 my $args = {'limit' => $limit, 'offset' => $offset};
398 $args->{tag_circulated_records} = 1;
399 $args->{authtoken} = $self->editor->authtoken;
402 # Stuff these into the TT context so that templates can use them in redrawing forms
403 $ctx->{processed_search_query} = $query;
405 $query .= " $_" for @facets;
407 $logger->activity("EGWeb: [search] $query");
411 my $method = 'open-ils.search.biblio.multiclass.query';
412 $method .= '.staff' if $ctx->{is_staff};
414 $self->timelog("Firing off the multiclass query");
415 $results = $U->simplereq('open-ils.search', $method, $args, $query, 1);
416 $self->timelog("Returned from the multiclass query");
420 $logger->error("multiclass search error: $err");
421 $results = {count => 0, ids => []};
425 my $rec_ids = [map { $_->[0] } @{$results->{ids}}];
427 $ctx->{ids} = $rec_ids;
428 $ctx->{hit_count} = $results->{count};
429 $ctx->{parsed_query} = $results->{parsed_query};
432 # redirect to the record detail page for the last record in the results
433 my $rec_id = pop @$rec_ids;
434 $cgi->delete('find_last');
435 my $url = $cgi->url(-full => 1, -path => 1, -query => 1);
436 $url =~ s|/results|/record/$rec_id|;
437 return $self->generic_redirect($url);
440 return Apache2::Const::OK if @$rec_ids == 0 or $internal;
442 $self->load_rresults_bookbag_item_notes($rec_ids) if $ctx->{bookbag};
444 $self->timelog("Calling get_records_and_facets()");
445 my ($facets, @data) = $self->get_records_and_facets(
446 $rec_ids, $results->{facet_key},
448 flesh => '{holdings_xml,mra,acp,acnp,acns,bmp}',
451 pref_lib => $ctx->{pref_ou},
454 $self->timelog("Returned from get_records_and_facets()");
457 my $stat = $self->check_1hit_redirect($rec_ids);
458 return $stat if $stat;
461 # shove recs into context in search results order
462 for my $rec_id (@$rec_ids) {
465 grep { $_->{id} == $rec_id } @data
470 for my $rec (@{$ctx->{records}}) {
471 my ($res_rec) = grep { $_->[0] == $rec->{id} } @{$results->{ids}};
472 # index 1 in the per-record result array is a boolean which
473 # indicates whether the record in question is in the users
474 # accessible circ history list
475 $rec->{user_circulated} = 1 if $res_rec->[1];
479 $ctx->{search_facets} = $facets;
481 return Apache2::Const::OK;
484 # If the calling search results in 1 record and the client
485 # is configured to do so, redirect the search results to
486 # the record details page.
487 sub check_1hit_redirect {
488 my ($self, $rec_ids) = @_;
489 my $ctx = $self->ctx;
491 return undef unless $rec_ids and @$rec_ids == 1;
495 $self->timelog("Checking whether to jump to details on a single hit");
496 if ($ctx->{is_staff}) {
497 $sname = 'opac.staff.jump_to_details_on_single_hit';
498 $org = $ctx->{user}->ws_ou;
501 $sname = 'opac.patron.jump_to_details_on_single_hit';
502 $org = $self->_get_search_lib();
505 $self->timelog("Return from checking whether to jump to details on a single hit");
508 $self->ctx->{get_org_setting}->($org, $sname);
510 my $base_url = sprintf(
511 '%s://%s%s/record/%s',
513 $self->apache->hostname,
514 $self->ctx->{opac_root},
518 # If we get here from the same record detail page to which we
519 # now wish to redirect, do not perform the redirect. This
520 # approach seems to work well, with the rare exception of
521 # performing a new serach directly from the detail page that
522 # happens to result in the same single hit. In this case, the
523 # user will be left on the search results page. This could be
524 # overcome w/ additional CGI, etc., but I'm not sure it's necessary.
525 if (my $referer = $ctx->{referer}) {
526 $referer =~ s/([^?]*).*/$1/g;
527 return undef if $base_url eq $referer;
530 return $self->generic_redirect($base_url . '?' . $self->cgi->query_string);
533 # Searching by barcode is a special search that does /not/ respect any other
534 # of the usual search parameters, not even the ones for sorting and paging!
535 sub item_barcode_shortcut {
538 $self->timelog("Searching for item_barcode");
539 my $method = "open-ils.search.multi_home.bib_ids.by_barcode";
540 if (my $search = create OpenSRF::AppSession("open-ils.search")) {
541 my $rec_ids = $search->request(
542 $method, $self->cgi->param("query")
545 $self->timelog("Finished searching for item_barcode");
547 if (ref $rec_ids ne 'ARRAY') {
549 if($U->event_equals($rec_ids, 'ASSET_COPY_NOT_FOUND')) {
553 if (defined $U->event_code($rec_ids)) {
554 $self->apache->log->warn(
555 "$method returned event: " . $U->event_code($rec_ids)
558 $self->apache->log->warn(
559 "$method returned something unexpected: $rec_ids"
562 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
566 $self->timelog("Calling get_records_and_facets() for item_barcode");
567 my ($facets, @data) = $self->get_records_and_facets(
568 $rec_ids, undef, {flesh => "{holdings_xml,mra,acnp,acns,bmp}"}
570 $self->timelog("Returned from calling get_records_and_facets() for item_barcode");
572 $self->ctx->{records} = [@data];
573 $self->ctx->{search_facets} = {};
574 $self->ctx->{hit_count} = scalar @data;
575 $self->ctx->{page_size} = $self->ctx->{hit_count};
577 return Apache2::Const::OK;
579 $self->apache->log->warn("couldn't connect to open-ils.search");
580 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
584 # like item_barcode_search, this can't take all the usual search params, but
585 # this one will at least do site, limit and page
586 sub marc_expert_search {
587 my ($self, %args) = @_;
589 my @tags = $self->cgi->param("tag");
590 my @subfields = $self->cgi->param("subfield");
591 my @terms = $self->cgi->param("term");
594 for (my $i = 0; $i < scalar @tags; $i++) {
595 next if ($tags[$i] eq "" || $terms[$i] eq "");
596 $subfields[$i] = '_' unless $subfields[$i];
598 "term" => $terms[$i],
599 "restrict" => [{"tag" => $tags[$i], "subfield" => $subfields[$i]}]
603 $logger->info("query for expert search: " . Dumper($query));
605 $self->timelog("Getting search parameters");
606 # loc, limit and offset
607 my $page = $self->cgi->param("page") || 0;
608 my $limit = $self->_get_search_limit;
609 $self->ctx->{search_ou} = $self->_get_search_lib();
610 $self->ctx->{pref_ou} = $self->_get_pref_lib();
611 my $offset = $page * $limit;
612 $self->timelog("Got search parameters");
614 $self->ctx->{records} = [];
615 $self->ctx->{search_facets} = {};
616 $self->ctx->{page_size} = $limit;
617 $self->ctx->{hit_count} = 0;
618 $self->ctx->{ids} = [];
619 $self->ctx->{search_page} = $page;
622 return Apache2::Const::OK if @$query == 0;
624 if ($args{internal}) {
625 $limit = $offset + $limit + 1;
629 $self->timelog("Searching for MARC expert");
630 my $method = 'open-ils.search.biblio.marc';
631 $method .= '.staff' if $self->ctx->{is_staff};
633 my $ses = OpenSRF::AppSession->create('open-ils.search');
634 my $req = $ses->request(
636 {searches => $query, org_unit => $self->ctx->{search_ou}},
637 $limit, $offset, $timeout);
639 my $resp = $req->recv($timeout);
640 my $results = $resp ? $resp->content : undef;
642 $self->timelog("Got our MARC expert results");
644 if (defined $U->event_code($results)) {
645 $self->apache->log->warn(
646 "open-ils.search.biblio.marc returned event: " .
647 $U->event_code($results)
649 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
652 $self->ctx->{ids} = [ grep { $_ } @{$results->{ids}} ];
653 $self->ctx->{hit_count} = $results->{count};
655 return Apache2::Const::OK if @{$self->ctx->{ids}} == 0 or $args{internal};
658 my $stat = $self->check_1hit_redirect($self->ctx->{ids});
659 return $stat if $stat;
662 $self->timelog("Calling get_records_and_facets() for MARC expert");
663 my ($facets, @data) = $self->get_records_and_facets(
664 $self->ctx->{ids}, undef, {
665 flesh => "{holdings_xml,mra,acnp,acns}",
666 pref_lib => $self->ctx->{pref_ou},
669 $self->timelog("Returned from calling get_records_and_facets() for MARC expert");
671 $self->ctx->{records} = [@data];
673 return Apache2::Const::OK;
676 sub call_number_browse_standalone {
679 if (my $cnfrag = $self->cgi->param("query")) {
681 'http%s://%s%s/cnbrowse?cn=%s',
682 $self->cgi->https ? "s" : "",
683 $self->apache->hostname,
684 $self->ctx->{opac_root},
685 $cnfrag # XXX some kind of escaping needed here?
687 return $self->generic_redirect($url);
689 return $self->generic_redirect; # return to search page
696 $self->prepare_browse_call_numbers();
698 return Apache2::Const::OK;
701 sub get_staff_search_settings {
704 unless ($self->ctx->{is_staff}) {
705 $self->ctx->{staff_saved_search_size} = 0;
709 $self->timelog("Getting staff search size");
710 my $sss_size = $self->ctx->{get_org_setting}->(
711 $self->ctx->{physical_loc} || $self->ctx->{aou_tree}->()->id,
712 "opac.staff_saved_search.size",
714 $self->timelog("Got staff search size");
716 # Sic: 0 is 0 (off), but undefined is 10.
717 $sss_size = 10 unless defined $sss_size;
719 $self->ctx->{staff_saved_search_size} = $sss_size;
722 sub staff_load_searches {
725 my $cache_key = $self->cgi->cookie((ref $self)->COOKIE_ANON_CACHE);
729 $self->timelog("Getting anon_cache value");
730 $list = $U->simplereq(
732 "open-ils.actor.anon_cache.get_value",
733 $cache_key, (ref $self)->ANON_CACHE_STAFF_SEARCH
735 $self->timelog("Got anon_cache value");
743 return ($cache_key, $list);
746 sub staff_save_search {
747 my ($self, $query) = @_;
749 my $sss_size = $self->ctx->{staff_saved_search_size};
750 return unless $sss_size > 0;
752 my ($cache_key, $list) = $self->staff_load_searches;
753 my %already = ( map { $_ => 1 } @$list );
755 unshift @$list, $query unless $already{$query};
757 splice @$list, $sss_size if scalar @$list > $sss_size;
759 $self->timelog("Setting anon_cache value");
760 $cache_key = $U->simplereq(
762 "open-ils.actor.anon_cache.set_value",
763 $cache_key, (ref $self)->ANON_CACHE_STAFF_SEARCH, $list
765 $self->timelog("Set anon_cache value");
767 return ($cache_key, $list);