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
29 if ($qtype eq 'jtitle') {
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 . '$';
46 } elsif ($contains eq 'starts') {
48 $query =~ s/[\^\$]//g;
49 $query = '^' . $query;
50 $query = ('"' . $query . '"') if index $query, ' ';
52 $query = "$qtype:$query" unless $qtype eq 'keyword' and $i == 0;
54 $bool = ($bool and $bool eq 'or') ? '||' : '&&';
55 $full_query = $full_query ? "($full_query $bool $query)" : $query;
61 sub _prepare_biblio_search {
64 my $query = _prepare_biblio_search_basics($cgi) || '';
66 $query .= ' ' . $ctx->{global_search_filter} if $ctx->{global_search_filter};
68 foreach ($cgi->param('modifier')) {
69 # The unless bit is to avoid stacking modifiers.
70 $query = ('#' . $_ . ' ' . $query) unless $query =~ qr/\#\Q$_/;
74 foreach (grep /^fi:/, $cgi->param) {
76 my $term = join(",", $cgi->param($_));
77 $query .= " $1($term)" if length $term;
80 # filter group entries. Entries from like filters are grouped into a single
81 # filter_group_entry() filter (ORed). Each collection is ANDed together.
82 # fg:foo_group=foo_entry_id
83 foreach (grep /^fg:/, $cgi->param) {
85 my $term = join(",", $cgi->param($_));
86 $query .= " filter_group_entry($term)" if length $term;
89 if ($cgi->param("bookbag")) {
90 $query .= " container(bre,bookbag," . int($cgi->param("bookbag")) . ")";
93 # Journal title hackery complete
94 if ($cgi->param("qtype") && $cgi->param("qtype") eq "jtitle") {
95 $query .= " bib_level(s)";
98 if ($cgi->param('pubdate') && $cgi->param('date1')) {
99 if ($cgi->param('pubdate') eq 'between') {
100 $query .= ' between(' . $cgi->param('date1');
101 $query .= ',' . $cgi->param('date2') if $cgi->param('date2');
103 } elsif ($cgi->param('pubdate') eq 'is') {
104 $query .= ' between(' . $cgi->param('date1') .
105 ',' . $cgi->param('date1') . ')'; # sic, date1 twice
107 $query .= ' ' . $cgi->param('pubdate') .
108 '(' . $cgi->param('date1') . ')';
112 # ---------------------------------------------------------------------
113 # Nothing below here constitutes a query by itself. If the query value
114 # is still empty up to this point, there is no query. abandon ship.
115 return () unless $query;
117 # sort is treated specially, even though it's actually a filter
118 if ($cgi->param('sort')) {
119 $query =~ s/sort\([^\)]*\)//g; # override existing sort(). no stacking.
120 my ($axis, $desc) = split /\./, $cgi->param('sort');
121 $query .= " sort($axis)";
122 if ($desc and not $query =~ /\#descending/) {
123 $query .= '#descending';
124 } elsif (not $desc) {
125 $query =~ s/\#descending//;
129 my (@naive_query_re, $site);
131 my $org = $ctx->{search_ou};
132 if (defined($org) and $org ne '' and ($org ne $ctx->{aou_tree}->()->id) and not $query =~ /site\(\S+\)/) {
133 my $thing = " site(" . $ctx->{get_aou}->($org)->shortname . ")";
136 push @naive_query_re, $thing;
139 my $pref_ou = $ctx->{pref_ou};
140 if (defined($pref_ou) and $pref_ou ne '' and $pref_ou != $org and ($pref_ou ne $ctx->{aou_tree}->()->id)) {
141 my $plib = $ctx->{get_aou}->($pref_ou)->shortname;
142 $query .= " pref_ou($plib)";
145 if (my $grp = $ctx->{copy_location_group}) {
146 $query .= " location_groups($grp)";
150 ($site) = ($query =~ /site\(([^\)]+)\)/);
151 $site ||= $ctx->{aou_tree}->()->shortname;
155 if ($query =~ /depth\(\d+\)/) {
157 # depth is encoded in the search query
158 ($depth) = ($query =~ /depth\((\d+)\)/);
162 if (defined $cgi->param('depth')) {
163 $depth = $cgi->param('depth');
165 # no depth specified. match the depth to the search org
166 my ($org) = grep { $_->shortname eq $site } @{$ctx->{aou_list}->()};
167 $depth = $org->ou_type->depth;
169 my $thing = " depth($depth)";
172 push @naive_query_re, $thing;
175 # This gives templates a way to take site() and depth() back out of
176 # query strings when they shouldn't be there (because they're controllable
177 # with other widgets).
178 $ctx->{naive_query_scrub} = sub {
180 $query =~ s/\Q$_\E// foreach (@naive_query_re);
184 $logger->info("tpac: site=$site, depth=$depth, query=$query");
186 return ($query, $site, $depth);
189 sub _get_search_limit {
192 # param takes precedence
193 my $limit = $self->cgi->param('limit');
194 return $limit if $limit;
196 if($self->editor->requestor) {
197 $self->timelog("Checking for opac.hits_per_page preference");
198 # See if the user has a hit count preference
199 my $lset = $self->editor->search_actor_user_setting({
200 usr => $self->editor->requestor->id,
201 name => 'opac.hits_per_page'
203 $self->timelog("Got opac.hits_per_page preference");
204 return OpenSRF::Utils::JSON->JSON2perl($lset->value) if $lset;
210 sub tag_circed_items {
212 my $e = $self->editor;
214 $self->timelog("Tag circed items?");
215 return 0 unless $e->requestor;
216 $self->timelog("Checking for opac.search.tag_circulated_items");
217 return 0 unless $self->ctx->{get_org_setting}->(
218 $e->requestor->home_ou,
219 'opac.search.tag_circulated_items');
221 # user has to be opted-in to circ history in some capacity
222 $self->timelog("Checking for history.circ.retention_*");
223 my $sets = $e->search_actor_user_setting({
224 usr => $e->requestor->id,
226 'history.circ.retention_age',
227 'history.circ.retention_start'
231 $self->timelog("Return from checking for history.circ.retention_*");
233 return 0 unless @$sets;
238 # This only loads the bookbag itself (in support of a record results page)
239 # if a "bookbag" CGI parameter is specified and if the bookbag is public
240 # or owned by the logged-in user (if any). Bookbag notes are fetched
241 # later if applicable.
242 sub load_rresults_bookbag {
245 my $bookbag_id = int($self->cgi->param("bookbag") || 0);
246 return if $bookbag_id < 1;
248 my %authz = $self->ctx->{"user"} ?
249 ("-or" => {"pub" => "t", "owner" => $self->ctx->{"user"}->id}) :
252 $self->timelog("Load results bookbag");
253 my $bbag = $self->editor->search_container_biblio_record_entry_bucket(
254 {"id" => $bookbag_id, "btype" => "bookbag", %authz}
256 $self->timelog("Got results bookbag");
259 $self->apache->log->warn(
260 "error from cstore retrieving bookbag $bookbag_id!"
262 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
264 $self->ctx->{"bookbag"} = shift @$bbag;
270 # assumes context has a bookbag we're already authorized to look at, and
271 # a list of rec_ids, reasonably sized (from paged search).
272 sub load_rresults_bookbag_item_notes {
273 my ($self, $rec_ids) = @_;
275 $self->timelog("Load results bookbag item notes");
276 my $items_with_notes =
277 $self->editor->search_container_biblio_record_entry_bucket_item([
278 {"target_biblio_record_entry" => $rec_ids,
279 "bucket" => $self->ctx->{"bookbag"}->id},
280 {"flesh" => 1, "flesh_fields" => {"cbrebi" => ["notes"]},
281 "order_by" => {"cbrebi" => ["id"]}}
283 $self->timelog("Got results bookbag item notes");
285 if (!$items_with_notes) {
286 $self->apache->log->warn("error from cstore retrieving cbrebi objects");
287 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
290 $self->ctx->{"bookbag_items_by_bre_id"} = +{
291 map { $_->target_biblio_record_entry => $_ } @$items_with_notes
300 # records : list of bre's and copy-count objects
304 my $internal = $args{internal};
305 my $cgi = $self->cgi;
306 my $ctx = $self->ctx;
307 my $e = $self->editor;
309 # find the last record in the set, then redirect
310 my $find_last = $cgi->param('find_last');
312 $self->timelog("Loading results");
313 # load bookbag metadata, if requested.
314 if (my $bbag_err = $self->load_rresults_bookbag) {
318 $ctx->{page} = 'rresult' unless $internal;
320 $ctx->{records} = [];
321 $ctx->{search_facets} = {};
322 $ctx->{hit_count} = 0;
324 # Special alternative searches here. This could all stand to be cleaner.
325 if ($cgi->param("_special")) {
326 $self->timelog("Calling MARC expert search");
327 return $self->marc_expert_search(%args) if scalar($cgi->param("tag"));
328 $self->timelog("Calling item barcode search");
329 return $self->item_barcode_shortcut if (
330 $cgi->param("qtype") and ($cgi->param("qtype") eq "item_barcode")
332 $self->timelog("Calling call number browse");
333 return $self->call_number_browse_standalone if (
334 $cgi->param("qtype") and ($cgi->param("qtype") eq "cnbrowse")
338 $self->timelog("Getting search parameters");
339 my $page = $cgi->param('page') || 0;
340 my @facets = $cgi->param('facet');
341 my $limit = $self->_get_search_limit;
342 $ctx->{search_ou} = $self->_get_search_lib();
343 $ctx->{pref_ou} = $self->_get_pref_lib() || $ctx->{search_ou};
344 my $offset = $page * $limit;
345 my $metarecord = $cgi->param('metarecord');
347 my $tag_circs = $self->tag_circed_items;
348 $self->timelog("Got search parameters");
350 $ctx->{page_size} = $limit;
351 $ctx->{search_page} = $page;
353 # fetch this page plus the first hit from the next page
355 $limit = $offset + $limit + 1;
359 my ($query, $site, $depth) = _prepare_biblio_search($cgi, $ctx);
361 $self->get_staff_search_settings;
363 if (!$find_last and $ctx->{staff_saved_search_size}) {
364 my ($key, $list) = $self->staff_save_search($query);
366 $self->apache->headers_out->add(
367 "Set-Cookie" => $self->cgi->cookie(
368 -name => (ref $self)->COOKIE_ANON_CACHE,
370 -value => ($key || ''),
371 -expires => ($key ? undef : "-1h")
374 $ctx->{saved_searches} = $list;
378 if ($metarecord and !$internal) {
380 # TODO: other limits, like SVF/format, etc.
381 $self->timelog("Getting metarecords to records");
382 $results = $U->simplereq(
384 'open-ils.search.biblio.metarecord_to_records',
385 $metarecord, {org => $ctx->{search_ou}, depth => $depth}
387 $self->timelog("Got metarecords to records");
389 # force the metarecord result blob to match the format of regular search results
390 $results->{ids} = [map { [$_] } @{$results->{ids}}];
395 return Apache2::Const::OK if $internal;
396 return $self->generic_redirect;
399 # Limit and offset will stay here. Everything else should be part of
400 # the query string, not special args.
401 my $args = {'limit' => $limit, 'offset' => $offset};
404 $args->{tag_circulated_records} = 1;
405 $args->{authtoken} = $self->editor->authtoken;
408 # Stuff these into the TT context so that templates can use them in redrawing forms
409 $ctx->{processed_search_query} = $query;
411 $query .= " $_" for @facets;
413 $logger->activity("EGWeb: [search] $query");
417 my $method = 'open-ils.search.biblio.multiclass.query';
418 $method .= '.staff' if $ctx->{is_staff};
420 $self->timelog("Firing off the multiclass query");
421 $results = $U->simplereq('open-ils.search', $method, $args, $query, 1);
422 $self->timelog("Returned from the multiclass query");
426 $logger->error("multiclass search error: $err");
427 $results = {count => 0, ids => []};
431 my $rec_ids = [map { $_->[0] } @{$results->{ids}}];
433 $ctx->{ids} = $rec_ids;
434 $ctx->{hit_count} = $results->{count};
435 $ctx->{parsed_query} = $results->{parsed_query};
438 # redirect to the record detail page for the last record in the results
439 my $rec_id = pop @$rec_ids;
440 $cgi->delete('find_last');
441 my $url = $cgi->url(-full => 1, -path => 1, -query => 1);
442 $url =~ s|/results|/record/$rec_id|;
443 return $self->generic_redirect($url);
446 return Apache2::Const::OK if @$rec_ids == 0 or $internal;
448 $self->load_rresults_bookbag_item_notes($rec_ids) if $ctx->{bookbag};
450 $self->timelog("Calling get_records_and_facets()");
451 my ($facets, @data) = $self->get_records_and_facets(
452 $rec_ids, $results->{facet_key},
454 flesh => '{holdings_xml,mra,acp,acnp,acns,bmp}',
457 pref_lib => $ctx->{pref_ou},
460 $self->timelog("Returned from get_records_and_facets()");
463 my $stat = $self->check_1hit_redirect($rec_ids);
464 return $stat if $stat;
467 # load temporary_list settings for user and ou:
468 $self->_load_lists_and_settings if ($ctx->{user});
470 # shove recs into context in search results order
471 for my $rec_id (@$rec_ids) {
474 grep { $_->{id} == $rec_id } @data
479 for my $rec (@{$ctx->{records}}) {
480 my ($res_rec) = grep { $_->[0] == $rec->{id} } @{$results->{ids}};
481 # index 1 in the per-record result array is a boolean which
482 # indicates whether the record in question is in the users
483 # accessible circ history list
484 $rec->{user_circulated} = 1 if $res_rec->[1];
488 $ctx->{search_facets} = $facets;
490 return Apache2::Const::OK;
493 # If the calling search results in 1 record and the client
494 # is configured to do so, redirect the search results to
495 # the record details page.
496 sub check_1hit_redirect {
497 my ($self, $rec_ids) = @_;
498 my $ctx = $self->ctx;
500 return undef unless $rec_ids and @$rec_ids == 1;
504 $self->timelog("Checking whether to jump to details on a single hit");
505 if ($ctx->{is_staff}) {
506 $sname = 'opac.staff.jump_to_details_on_single_hit';
507 $org = $ctx->{user}->ws_ou;
510 $sname = 'opac.patron.jump_to_details_on_single_hit';
511 $org = $self->_get_search_lib();
514 $self->timelog("Return from checking whether to jump to details on a single hit");
517 $self->ctx->{get_org_setting}->($org, $sname);
519 my $base_url = sprintf(
520 '%s://%s%s/record/%s',
522 $self->ctx->{hostname},
523 $self->ctx->{opac_root},
527 # If we get here from the same record detail page to which we
528 # now wish to redirect, do not perform the redirect. This
529 # approach seems to work well, with the rare exception of
530 # performing a new search directly from the detail page that
531 # happens to result in the same single hit. In this case, the
532 # user will be left on the search results page. This could be
533 # overcome w/ additional CGI, etc., but I'm not sure it's necessary.
534 if (my $referer = $ctx->{referer}) {
535 $referer =~ s/([^?]*).*/$1/g;
536 return undef if $base_url eq $referer;
539 return $self->generic_redirect($base_url . '?' . $self->cgi->query_string);
542 # Searching by barcode is a special search that does /not/ respect any other
543 # of the usual search parameters, not even the ones for sorting and paging!
544 sub item_barcode_shortcut {
547 $self->timelog("Searching for item_barcode");
548 my $method = "open-ils.search.multi_home.bib_ids.by_barcode";
549 if (my $search = create OpenSRF::AppSession("open-ils.search")) {
550 my $rec_ids = $search->request(
551 $method, $self->cgi->param("query")
554 $self->timelog("Finished searching for item_barcode");
556 if (ref $rec_ids ne 'ARRAY') {
558 if($U->event_equals($rec_ids, 'ASSET_COPY_NOT_FOUND')) {
562 if (defined $U->event_code($rec_ids)) {
563 $self->apache->log->warn(
564 "$method returned event: " . $U->event_code($rec_ids)
567 $self->apache->log->warn(
568 "$method returned something unexpected: $rec_ids"
571 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
575 $self->timelog("Calling get_records_and_facets() for item_barcode");
576 my ($facets, @data) = $self->get_records_and_facets(
577 $rec_ids, undef, {flesh => "{holdings_xml,mra,acnp,acns,bmp}"}
579 $self->timelog("Returned from calling get_records_and_facets() for item_barcode");
581 $self->ctx->{records} = [@data];
582 $self->ctx->{search_facets} = {};
583 $self->ctx->{hit_count} = scalar @data;
584 $self->ctx->{page_size} = $self->ctx->{hit_count};
585 # load temporary_list settings for user and ou:
586 $self->_load_lists_and_settings if ($self->ctx->{user});
588 return Apache2::Const::OK;
590 $self->apache->log->warn("couldn't connect to open-ils.search");
591 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
595 # like item_barcode_search, this can't take all the usual search params, but
596 # this one will at least do site, limit and page
597 sub marc_expert_search {
598 my ($self, %args) = @_;
600 my @tags = $self->cgi->param("tag");
601 my @subfields = $self->cgi->param("subfield");
602 my @terms = $self->cgi->param("term");
605 for (my $i = 0; $i < scalar @tags; $i++) {
606 next if ($tags[$i] eq "" || $terms[$i] eq "");
607 $subfields[$i] = '_' unless $subfields[$i];
609 "term" => $terms[$i],
610 "restrict" => [{"tag" => $tags[$i], "subfield" => $subfields[$i]}]
614 $logger->info("query for expert search: " . Dumper($query));
616 $self->timelog("Getting search parameters");
617 # loc, limit and offset
618 my $page = $self->cgi->param("page") || 0;
619 my $limit = $self->_get_search_limit;
620 $self->ctx->{search_ou} = $self->_get_search_lib();
621 $self->ctx->{pref_ou} = $self->_get_pref_lib();
622 my $offset = $page * $limit;
623 $self->timelog("Got search parameters");
625 $self->ctx->{records} = [];
626 $self->ctx->{search_facets} = {};
627 $self->ctx->{page_size} = $limit;
628 $self->ctx->{hit_count} = 0;
629 $self->ctx->{ids} = [];
630 $self->ctx->{search_page} = $page;
633 return Apache2::Const::OK if @$query == 0;
635 if ($args{internal}) {
636 $limit = $offset + $limit + 1;
640 $self->timelog("Searching for MARC expert");
641 my $method = 'open-ils.search.biblio.marc';
642 $method .= '.staff' if $self->ctx->{is_staff};
644 my $ses = OpenSRF::AppSession->create('open-ils.search');
645 my $req = $ses->request(
647 {searches => $query, org_unit => $self->ctx->{search_ou}},
648 $limit, $offset, $timeout);
650 my $resp = $req->recv($timeout);
651 my $results = $resp ? $resp->content : undef;
653 $self->timelog("Got our MARC expert results");
655 if (defined $U->event_code($results)) {
656 $self->apache->log->warn(
657 "open-ils.search.biblio.marc returned event: " .
658 $U->event_code($results)
660 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
663 $self->ctx->{ids} = [ grep { $_ } @{$results->{ids}} ];
664 $self->ctx->{hit_count} = $results->{count};
666 return Apache2::Const::OK if @{$self->ctx->{ids}} == 0 or $args{internal};
669 my $stat = $self->check_1hit_redirect($self->ctx->{ids});
670 return $stat if $stat;
673 $self->timelog("Calling get_records_and_facets() for MARC expert");
674 my ($facets, @data) = $self->get_records_and_facets(
675 $self->ctx->{ids}, undef, {
676 flesh => "{holdings_xml,mra,acnp,acns}",
677 pref_lib => $self->ctx->{pref_ou},
680 $self->timelog("Returned from calling get_records_and_facets() for MARC expert");
682 # load temporary_list settings for user and ou:
683 $self->_load_lists_and_settings if ($self->ctx->{user});
685 $self->ctx->{records} = [@data];
687 return Apache2::Const::OK;
690 sub call_number_browse_standalone {
693 if (my $cnfrag = $self->cgi->param("query")) {
695 '%s://%s%s/cnbrowse?cn=%s',
697 $self->ctx->{hostname},
698 $self->ctx->{opac_root},
699 $cnfrag # XXX some kind of escaping needed here?
701 $url .= '&locg=' . $self->_get_search_lib() if ($self->_get_search_lib());
702 return $self->generic_redirect($url);
704 return $self->generic_redirect; # return to search page
711 $self->prepare_browse_call_numbers();
713 return Apache2::Const::OK;
716 sub get_staff_search_settings {
719 unless ($self->ctx->{is_staff}) {
720 $self->ctx->{staff_saved_search_size} = 0;
724 $self->timelog("Getting staff search size");
725 my $sss_size = $self->ctx->{get_org_setting}->(
726 $self->ctx->{physical_loc} || $self->ctx->{aou_tree}->()->id,
727 "opac.staff_saved_search.size",
729 $self->timelog("Got staff search size");
731 # Sic: 0 is 0 (off), but undefined is 10.
732 $sss_size = 10 unless defined $sss_size;
734 $self->ctx->{staff_saved_search_size} = $sss_size;
737 sub staff_load_searches {
740 my $cache_key = $self->cgi->cookie((ref $self)->COOKIE_ANON_CACHE);
744 $self->timelog("Getting anon_cache value");
745 $list = $U->simplereq(
747 "open-ils.actor.anon_cache.get_value",
748 $cache_key, (ref $self)->ANON_CACHE_STAFF_SEARCH
750 $self->timelog("Got anon_cache value");
758 return ($cache_key, $list);
761 sub staff_save_search {
762 my ($self, $query) = @_;
764 my $sss_size = $self->ctx->{staff_saved_search_size};
765 return unless $sss_size > 0;
767 my ($cache_key, $list) = $self->staff_load_searches;
768 my %already = ( map { $_ => 1 } @$list );
770 unshift @$list, $query unless $already{$query};
772 splice @$list, $sss_size if scalar @$list > $sss_size;
774 $self->timelog("Setting anon_cache value");
775 $cache_key = $U->simplereq(
777 "open-ils.actor.anon_cache.set_value",
778 $cache_key, (ref $self)->ANON_CACHE_STAFF_SEARCH, $list
780 $self->timelog("Set anon_cache value");
782 return ($cache_key, $list);