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) $query" if length $term;
89 if ($cgi->param("bookbag")) {
90 $query = "container(bre,bookbag," . int($cgi->param("bookbag")) . ") $query";
93 # Journal title hackery complete
94 if ($cgi->param("qtype") && $cgi->param("qtype") eq "jtitle") {
95 $query = "bib_level(s) $query";
98 if ($cgi->param('pubdate') && $cgi->param('date1')) {
99 if ($cgi->param('pubdate') eq 'between') {
100 my $btw = 'between(' . $cgi->param('date1');
101 $btw .= ',' . $cgi->param('date2') if $cgi->param('date2');
103 $query = "$btw $query";
104 } elsif ($cgi->param('pubdate') eq 'is') {
105 $query = 'between(' . $cgi->param('date1') .
106 ',' . $cgi->param('date1') . ") $query"; # sic, date1 twice
108 $query = $cgi->param('pubdate') .
109 '(' . $cgi->param('date1') . ") $query";
113 # ---------------------------------------------------------------------
114 # Nothing below here constitutes a query by itself. If the query value
115 # is still empty up to this point, there is no query. abandon ship.
116 return () unless $query;
118 # sort is treated specially, even though it's actually a filter
119 if ($cgi->param('sort')) {
120 $query =~ s/sort\([^\)]*\)//g; # override existing sort(). no stacking.
121 my ($axis, $desc) = split /\./, $cgi->param('sort');
122 $query = "sort($axis) $query";
123 if ($desc and not $query =~ /\#descending/) {
124 $query = "#descending $query";
125 } elsif (not $desc) {
126 $query =~ s/\#descending//;
130 my (@naive_query_re, $site);
132 my $org = $ctx->{search_ou};
133 if (defined($org) and $org ne '' and ($org ne $ctx->{aou_tree}->()->id) and not $query =~ /site\(\S+\)/) {
134 my $thing = " site(" . $ctx->{get_aou}->($org)->shortname . ")";
137 push @naive_query_re, $thing;
140 my $pref_ou = $ctx->{pref_ou};
141 if (defined($pref_ou) and $pref_ou ne '' and $pref_ou != $org and ($pref_ou ne $ctx->{aou_tree}->()->id) and not $query =~ / pref_ou\(\S+\)/) {
142 my $plib = $ctx->{get_aou}->($pref_ou)->shortname;
143 $query = "pref_ou($plib) $query";
146 if (my $grp = $ctx->{copy_location_group}) {
147 $query = "location_groups($grp) $query";
151 ($site) = ($query =~ /site\(([^\)]+)\)/);
152 $site ||= $ctx->{aou_tree}->()->shortname;
156 if ($query =~ /depth\(\d+\)/) {
158 # depth is encoded in the search query
159 ($depth) = ($query =~ /depth\((\d+)\)/);
163 if (defined $cgi->param('depth')) {
164 $depth = $cgi->param('depth');
166 # no depth specified. match the depth to the search org
167 my ($org) = grep { $_->shortname eq $site } @{$ctx->{aou_list}->()};
168 $depth = $org->ou_type->depth;
170 my $thing = " depth($depth)";
173 push @naive_query_re, $thing;
176 # This gives templates a way to take site() and depth() back out of
177 # query strings when they shouldn't be there (because they're controllable
178 # with other widgets).
179 $ctx->{naive_query_scrub} = sub {
181 $query =~ s/\Q$_\E// foreach (@naive_query_re);
185 $logger->info("tpac: site=$site, depth=$depth, query=$query");
187 return ($query, $site, $depth);
190 sub _get_search_limit {
193 # param takes precedence
194 my $limit = $self->cgi->param('limit');
195 return $limit if $limit;
197 if($self->editor->requestor) {
198 $self->timelog("Checking for opac.hits_per_page preference");
199 # See if the user has a hit count preference
200 my $lset = $self->editor->search_actor_user_setting({
201 usr => $self->editor->requestor->id,
202 name => 'opac.hits_per_page'
204 $self->timelog("Got opac.hits_per_page preference");
205 return OpenSRF::Utils::JSON->JSON2perl($lset->value) if $lset;
211 sub tag_circed_items {
213 my $e = $self->editor;
215 $self->timelog("Tag circed items?");
216 return 0 unless $e->requestor;
217 $self->timelog("Checking for opac.search.tag_circulated_items");
218 return 0 unless $self->ctx->{get_org_setting}->(
219 $e->requestor->home_ou,
220 'opac.search.tag_circulated_items');
222 # user has to be opted-in to circ history in some capacity
223 $self->timelog("Checking for history.circ.retention_*");
224 my $sets = $e->search_actor_user_setting({
225 usr => $e->requestor->id,
227 'history.circ.retention_age',
228 'history.circ.retention_start'
232 $self->timelog("Return from checking for history.circ.retention_*");
234 return 0 unless @$sets;
239 # This only loads the bookbag itself (in support of a record results page)
240 # if a "bookbag" CGI parameter is specified and if the bookbag is public
241 # or owned by the logged-in user (if any). Bookbag notes are fetched
242 # later if applicable.
243 sub load_rresults_bookbag {
246 my $bookbag_id = int($self->cgi->param("bookbag") || 0);
247 return if $bookbag_id < 1;
249 my %authz = $self->ctx->{"user"} ?
250 ("-or" => {"pub" => "t", "owner" => $self->ctx->{"user"}->id}) :
253 $self->timelog("Load results bookbag");
254 my $bbag = $self->editor->search_container_biblio_record_entry_bucket(
255 {"id" => $bookbag_id, "btype" => "bookbag", %authz}
257 $self->timelog("Got results bookbag");
260 $self->apache->log->warn(
261 "error from cstore retrieving bookbag $bookbag_id!"
263 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
265 $self->ctx->{"bookbag"} = shift @$bbag;
271 # assumes context has a bookbag we're already authorized to look at, and
272 # a list of rec_ids, reasonably sized (from paged search).
273 sub load_rresults_bookbag_item_notes {
274 my ($self, $rec_ids) = @_;
276 $self->timelog("Load results bookbag item notes");
277 my $items_with_notes =
278 $self->editor->search_container_biblio_record_entry_bucket_item([
279 {"target_biblio_record_entry" => $rec_ids,
280 "bucket" => $self->ctx->{"bookbag"}->id},
281 {"flesh" => 1, "flesh_fields" => {"cbrebi" => ["notes"]},
282 "order_by" => {"cbrebi" => ["id"]}}
284 $self->timelog("Got results bookbag item notes");
286 if (!$items_with_notes) {
287 $self->apache->log->warn("error from cstore retrieving cbrebi objects");
288 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
291 $self->ctx->{"bookbag_items_by_bre_id"} = +{
292 map { $_->target_biblio_record_entry => $_ } @$items_with_notes
301 # records : list of bre's and copy-count objects
305 my $internal = $args{internal};
306 my $cgi = $self->cgi;
307 my $ctx = $self->ctx;
308 my $e = $self->editor;
310 # find the last record in the set, then redirect
311 my $find_last = $cgi->param('find_last');
313 $self->timelog("Loading results");
314 # load bookbag metadata, if requested.
315 if (my $bbag_err = $self->load_rresults_bookbag) {
319 $ctx->{page} = 'rresult' unless $internal;
321 $ctx->{records} = [];
322 $ctx->{search_facets} = {};
323 $ctx->{hit_count} = 0;
325 # Special alternative searches here. This could all stand to be cleaner.
326 if ($cgi->param("_special")) {
327 $self->timelog("Calling MARC expert search");
328 return $self->marc_expert_search(%args) if scalar($cgi->param("tag"));
329 $self->timelog("Calling item barcode search");
330 return $self->item_barcode_shortcut if (
331 $cgi->param("qtype") and ($cgi->param("qtype") eq "item_barcode") and not $internal
333 $self->timelog("Calling call number browse");
334 return $self->call_number_browse_standalone if (
335 $cgi->param("qtype") and ($cgi->param("qtype") eq "cnbrowse")
339 $self->timelog("Getting search parameters");
340 my $page = $cgi->param('page') || 0;
341 my @facets = $cgi->param('facet');
342 my $limit = $self->_get_search_limit;
343 $ctx->{search_ou} = $self->_get_search_lib();
344 $ctx->{pref_ou} = $self->_get_pref_lib() || $ctx->{search_ou};
345 my $offset = $page * $limit;
346 my $metarecord = $cgi->param('metarecord');
348 my $tag_circs = $self->tag_circed_items;
349 $self->timelog("Got search parameters");
351 $ctx->{page_size} = $limit;
352 $ctx->{search_page} = $page;
354 # fetch this page plus the first hit from the next page
356 $limit = $offset + $limit + 1;
360 my ($query, $site, $depth) = _prepare_biblio_search($cgi, $ctx);
362 $self->get_staff_search_settings;
364 if (!$find_last and $ctx->{staff_saved_search_size}) {
365 my ($key, $list) = $self->staff_save_search($query);
367 $self->apache->headers_out->add(
368 "Set-Cookie" => $self->cgi->cookie(
369 -name => (ref $self)->COOKIE_ANON_CACHE,
371 -value => ($key || ''),
372 -expires => ($key ? undef : "-1h")
375 $ctx->{saved_searches} = $list;
379 if ($metarecord and !$internal) {
381 # TODO: other limits, like SVF/format, etc.
382 $self->timelog("Getting metarecords to records");
383 $results = $U->simplereq(
385 'open-ils.search.biblio.metarecord_to_records',
386 $metarecord, {org => $ctx->{search_ou}, depth => $depth}
388 $self->timelog("Got metarecords to records");
390 # force the metarecord result blob to match the format of regular search results
391 $results->{ids} = [map { [$_] } @{$results->{ids}}];
395 return Apache2::Const::OK unless $query;
397 # Limit and offset will stay here. Everything else should be part of
398 # the query string, not special args.
399 my $args = {'limit' => $limit, 'offset' => $offset};
402 $args->{tag_circulated_records} = 1;
403 $args->{authtoken} = $self->editor->authtoken;
406 # Stuff these into the TT context so that templates can use them in redrawing forms
407 $ctx->{processed_search_query} = $query;
409 $query = "$_ $query" for @facets;
411 $logger->activity("EGWeb: [search] $query");
415 my $method = 'open-ils.search.biblio.multiclass.query';
416 $method .= '.staff' if $ctx->{is_staff};
418 my $ses = OpenSRF::AppSession->create('open-ils.search');
420 $self->timelog("Firing off the multiclass query");
421 my $req = $ses->request($method, $args, $query, 1);
422 $results = $req->gather(1);
423 $self->timelog("Returned from the multiclass query");
427 $logger->error("multiclass search error: $err");
428 $results = {count => 0, ids => []};
432 my $rec_ids = [map { $_->[0] } @{$results->{ids}}];
434 $ctx->{ids} = $rec_ids;
435 $ctx->{hit_count} = $results->{count};
436 $ctx->{parsed_query} = $results->{parsed_query};
439 # redirect to the record detail page for the last record in the results
440 my $rec_id = pop @$rec_ids;
441 $cgi->delete('find_last');
442 my $url = $cgi->url(-full => 1, -path => 1, -query => 1);
443 $url =~ s|/results|/record/$rec_id|;
444 return $self->generic_redirect($url);
447 return Apache2::Const::OK if @$rec_ids == 0 or $internal;
449 $self->load_rresults_bookbag_item_notes($rec_ids) if $ctx->{bookbag};
451 $self->timelog("Calling get_records_and_facets()");
452 my ($facets, @data) = $self->get_records_and_facets(
453 $rec_ids, $results->{facet_key},
455 flesh => '{holdings_xml,mra,acp,acnp,acns,bmp}',
458 pref_lib => $ctx->{pref_ou},
461 $self->timelog("Returned from get_records_and_facets()");
464 my $stat = $self->check_1hit_redirect($rec_ids);
465 return $stat if $stat;
468 # load temporary_list settings for user and ou:
469 $self->_load_lists_and_settings if ($ctx->{user});
471 # shove recs into context in search results order
472 for my $rec_id (@$rec_ids) {
475 grep { $_->{id} == $rec_id } @data
480 for my $rec (@{$ctx->{records}}) {
481 my ($res_rec) = grep { $_->[0] == $rec->{id} } @{$results->{ids}};
482 # index 1 in the per-record result array is a boolean which
483 # indicates whether the record in question is in the users
484 # accessible circ history list
485 $rec->{user_circulated} = 1 if $res_rec->[1];
489 $ctx->{search_facets} = $facets;
491 return Apache2::Const::OK;
494 # If the calling search results in 1 record and the client
495 # is configured to do so, redirect the search results to
496 # the record details page.
497 sub check_1hit_redirect {
498 my ($self, $rec_ids) = @_;
499 my $ctx = $self->ctx;
501 return undef unless $rec_ids and @$rec_ids == 1;
505 $self->timelog("Checking whether to jump to details on a single hit");
506 if ($ctx->{is_staff}) {
507 $sname = 'opac.staff.jump_to_details_on_single_hit';
508 $org = $ctx->{user}->ws_ou;
511 $sname = 'opac.patron.jump_to_details_on_single_hit';
512 $org = $self->_get_search_lib();
515 $self->timelog("Return from checking whether to jump to details on a single hit");
518 $self->ctx->{get_org_setting}->($org, $sname);
520 my $base_url = sprintf(
521 '%s://%s%s/record/%s',
523 $self->ctx->{hostname},
524 $self->ctx->{opac_root},
528 # If we get here from the same record detail page to which we
529 # now wish to redirect, do not perform the redirect. This
530 # approach seems to work well, with the rare exception of
531 # performing a new search directly from the detail page that
532 # happens to result in the same single hit. In this case, the
533 # user will be left on the search results page. This could be
534 # overcome w/ additional CGI, etc., but I'm not sure it's necessary.
535 if (my $referer = $ctx->{referer}) {
536 $referer =~ s/([^?]*).*/$1/g;
537 return undef if $base_url eq $referer;
540 return $self->generic_redirect($base_url . '?' . $self->cgi->query_string);
543 # Searching by barcode is a special search that does /not/ respect any other
544 # of the usual search parameters, not even the ones for sorting and paging!
545 sub item_barcode_shortcut {
548 $self->timelog("Searching for item_barcode");
549 my $method = "open-ils.search.multi_home.bib_ids.by_barcode";
550 if (my $search = create OpenSRF::AppSession("open-ils.search")) {
551 my $rec_ids = $search->request(
552 $method, $self->cgi->param("query")
555 $self->timelog("Finished searching for item_barcode");
557 if (ref $rec_ids ne 'ARRAY') {
559 if($U->event_equals($rec_ids, 'ASSET_COPY_NOT_FOUND')) {
563 if (defined $U->event_code($rec_ids)) {
564 $self->apache->log->warn(
565 "$method returned event: " . $U->event_code($rec_ids)
568 $self->apache->log->warn(
569 "$method returned something unexpected: $rec_ids"
572 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
576 $self->timelog("Calling get_records_and_facets() for item_barcode");
577 my ($facets, @data) = $self->get_records_and_facets(
578 $rec_ids, undef, {flesh => "{holdings_xml,mra,acnp,acns,bmp}"}
580 $self->timelog("Returned from calling get_records_and_facets() for item_barcode");
582 my $stat = $self->check_1hit_redirect($rec_ids);
583 return $stat if $stat;
585 $self->ctx->{records} = [@data];
586 $self->ctx->{search_facets} = {};
587 $self->ctx->{hit_count} = scalar @data;
588 $self->ctx->{page_size} = $self->ctx->{hit_count};
589 # load temporary_list settings for user and ou:
590 $self->_load_lists_and_settings if ($self->ctx->{user});
592 return Apache2::Const::OK;
594 $self->apache->log->warn("couldn't connect to open-ils.search");
595 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
599 # like item_barcode_search, this can't take all the usual search params, but
600 # this one will at least do site, limit and page
601 sub marc_expert_search {
602 my ($self, %args) = @_;
604 my @tags = $self->cgi->param("tag");
605 my @subfields = $self->cgi->param("subfield");
606 my @terms = $self->cgi->param("term");
609 for (my $i = 0; $i < scalar @tags; $i++) {
610 next if ($tags[$i] eq "" || $terms[$i] eq "");
611 $subfields[$i] = '_' unless $subfields[$i];
613 "term" => $terms[$i],
614 "restrict" => [{"tag" => $tags[$i], "subfield" => $subfields[$i]}]
618 $logger->info("query for expert search: " . Dumper($query));
620 $self->timelog("Getting search parameters");
621 # loc, limit and offset
622 my $page = $self->cgi->param("page") || 0;
623 my $limit = $self->_get_search_limit;
624 $self->ctx->{search_ou} = $self->_get_search_lib();
625 $self->ctx->{pref_ou} = $self->_get_pref_lib();
626 my $offset = $page * $limit;
627 $self->timelog("Got search parameters");
629 $self->ctx->{records} = [];
630 $self->ctx->{search_facets} = {};
631 $self->ctx->{page_size} = $limit;
632 $self->ctx->{hit_count} = 0;
633 $self->ctx->{ids} = [];
634 $self->ctx->{search_page} = $page;
637 return Apache2::Const::OK if @$query == 0;
639 if ($args{internal}) {
640 $limit = $offset + $limit + 1;
644 $self->timelog("Searching for MARC expert");
645 my $method = 'open-ils.search.biblio.marc';
646 $method .= '.staff' if $self->ctx->{is_staff};
648 my $ses = OpenSRF::AppSession->create('open-ils.search');
649 my $req = $ses->request(
651 {searches => $query, org_unit => $self->ctx->{search_ou}},
652 $limit, $offset, $timeout);
654 my $resp = $req->recv($timeout);
655 my $results = $resp ? $resp->content : undef;
657 $self->timelog("Got our MARC expert results");
659 if (defined $U->event_code($results)) {
660 $self->apache->log->warn(
661 "open-ils.search.biblio.marc returned event: " .
662 $U->event_code($results)
664 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
667 $self->ctx->{ids} = [ grep { $_ } @{$results->{ids}} ];
668 $self->ctx->{hit_count} = $results->{count};
670 return Apache2::Const::OK if @{$self->ctx->{ids}} == 0 or $args{internal};
673 my $stat = $self->check_1hit_redirect($self->ctx->{ids});
674 return $stat if $stat;
677 $self->timelog("Calling get_records_and_facets() for MARC expert");
678 my ($facets, @data) = $self->get_records_and_facets(
679 $self->ctx->{ids}, undef, {
680 flesh => "{holdings_xml,mra,acnp,acns}",
681 pref_lib => $self->ctx->{pref_ou},
684 $self->timelog("Returned from calling get_records_and_facets() for MARC expert");
686 # load temporary_list settings for user and ou:
687 $self->_load_lists_and_settings if ($self->ctx->{user});
689 $self->ctx->{records} = [@data];
691 return Apache2::Const::OK;
694 sub call_number_browse_standalone {
697 if (my $cnfrag = $self->cgi->param("query")) {
699 '%s://%s%s/cnbrowse?cn=%s',
701 $self->ctx->{hostname},
702 $self->ctx->{opac_root},
703 $cnfrag # XXX some kind of escaping needed here?
705 $url .= '&locg=' . $self->_get_search_lib() if ($self->_get_search_lib());
706 return $self->generic_redirect($url);
708 return $self->generic_redirect; # return to search page
715 $self->prepare_browse_call_numbers();
717 return Apache2::Const::OK;
720 sub get_staff_search_settings {
723 unless ($self->ctx->{is_staff}) {
724 $self->ctx->{staff_saved_search_size} = 0;
728 $self->timelog("Getting staff search size");
729 my $sss_size = $self->ctx->{get_org_setting}->(
730 $self->ctx->{physical_loc} || $self->ctx->{aou_tree}->()->id,
731 "opac.staff_saved_search.size",
733 $self->timelog("Got staff search size");
735 # Sic: 0 is 0 (off), but undefined is 10.
736 $sss_size = 10 unless defined $sss_size;
738 $self->ctx->{staff_saved_search_size} = $sss_size;
741 sub staff_load_searches {
744 my $cache_key = $self->cgi->cookie((ref $self)->COOKIE_ANON_CACHE);
748 $self->timelog("Getting anon_cache value");
749 $list = $U->simplereq(
751 "open-ils.actor.anon_cache.get_value",
752 $cache_key, (ref $self)->ANON_CACHE_STAFF_SEARCH
754 $self->timelog("Got anon_cache value");
762 return ($cache_key, $list);
765 sub staff_save_search {
766 my ($self, $query) = @_;
768 my $sss_size = $self->ctx->{staff_saved_search_size};
769 return unless $sss_size > 0;
771 my ($cache_key, $list) = $self->staff_load_searches;
772 my %already = ( map { $_ => 1 } @$list );
774 unshift @$list, $query unless $already{$query};
776 splice @$list, $sss_size if scalar @$list > $sss_size;
778 $self->timelog("Setting anon_cache value");
779 $cache_key = $U->simplereq(
781 "open-ils.actor.anon_cache.set_value",
782 $cache_key, (ref $self)->ANON_CACHE_STAFF_SEARCH, $list
784 $self->timelog("Set anon_cache value");
786 return ($cache_key, $list);