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 # This stuff probably will need refined or rethought to better handle
29 # the weird things Real Users will surely type in.
30 $contains = "" unless defined $contains; # silence warning
31 if ($contains eq 'nocontains') {
33 $query = ('"' . $query . '"') if index $query, ' ';
34 $query = '-' . $query;
35 } elsif ($contains eq 'phrase') {
37 $query = ('"' . $query . '"') if index $query, ' ';
38 } elsif ($contains eq 'exact') {
39 $query =~ s/[\^\$]//g;
40 $query = '^' . $query . '$';
42 $query = "$qtype:$query" unless $qtype eq 'keyword' and $i == 0;
44 $bool = ($bool and $bool eq 'or') ? '||' : '&&';
45 $full_query = $full_query ? "($full_query $bool $query)" : $query;
51 sub _prepare_biblio_search {
54 my $query = _prepare_biblio_search_basics($cgi) || '';
56 foreach ($cgi->param('modifier')) {
57 # The unless bit is to avoid stacking modifiers.
58 $query = ('#' . $_ . ' ' . $query) unless $query =~ qr/\#\Q$_/;
62 foreach (grep /^fi:/, $cgi->param) {
64 my $term = join(",", $cgi->param($_));
65 $query .= " $1($term)" if length $term;
68 if ($cgi->param("bookbag")) {
69 $query .= " container(bre,bookbag," . int($cgi->param("bookbag")) . ")";
72 if ($cgi->param('pubdate') && $cgi->param('date1')) {
73 if ($cgi->param('pubdate') eq 'between') {
74 $query .= ' between(' . $cgi->param('date1');
75 $query .= ',' . $cgi->param('date2') if $cgi->param('date2');
77 } elsif ($cgi->param('pubdate') eq 'is') {
78 $query .= ' between(' . $cgi->param('date1') .
79 ',' . $cgi->param('date1') . ')'; # sic, date1 twice
81 $query .= ' ' . $cgi->param('pubdate') .
82 '(' . $cgi->param('date1') . ')';
86 # ---------------------------------------------------------------------
87 # Nothing below here constitutes a query by itself. If the query value
88 # is still empty up to this point, there is no query. abandon ship.
89 return () unless $query;
91 # sort is treated specially, even though it's actually a filter
92 if ($cgi->param('sort')) {
93 $query =~ s/sort\([^\)]*\)//g; # override existing sort(). no stacking.
94 my ($axis, $desc) = split /\./, $cgi->param('sort');
95 $query .= " sort($axis)";
96 if ($desc and not $query =~ /\#descending/) {
97 $query .= '#descending';
99 $query =~ s/\#descending//;
104 my $org = $ctx->{search_ou};
105 if (defined($org) and $org ne '' and ($org ne $ctx->{aou_tree}->()->id) and not $query =~ /site\(\S+\)/) {
106 $site = $ctx->{get_aou}->($org)->shortname;
107 $query .= " site($site)";
110 my $pref_ou = $ctx->{pref_ou};
111 if (defined($pref_ou) and $pref_ou ne '' and $pref_ou != $org and ($pref_ou ne $ctx->{aou_tree}->()->id)) {
112 my $plib = $ctx->{get_aou}->($pref_ou)->shortname;
113 $query .= " pref_ou($plib)";
116 if (my $grp = $ctx->{copy_location_group}) {
117 $query .= " location_groups($grp)";
121 ($site) = ($query =~ /site\(([^\)]+)\)/);
122 $site ||= $ctx->{aou_tree}->()->shortname;
126 if ($query =~ /depth\(\d+\)/) {
128 # depth is encoded in the search query
129 ($depth) = ($query =~ /depth\((\d+)\)/);
133 if (defined $cgi->param('depth')) {
134 $depth = $cgi->param('depth');
136 # no depth specified. match the depth to the search org
137 my ($org) = grep { $_->shortname eq $site } @{$ctx->{aou_list}->()};
138 $depth = $org->ou_type->depth;
140 $query .= " depth($depth)";
143 $logger->info("tpac: site=$site, depth=$depth, query=$query");
145 return ($query, $site, $depth);
148 sub _get_search_limit {
151 # param takes precedence
152 my $limit = $self->cgi->param('limit');
153 return $limit if $limit;
155 if($self->editor->requestor) {
156 $self->timelog("Checking for opac.hits_per_page preference");
157 # See if the user has a hit count preference
158 my $lset = $self->editor->search_actor_user_setting({
159 usr => $self->editor->requestor->id,
160 name => 'opac.hits_per_page'
162 $self->timelog("Got opac.hits_per_page preference");
163 return OpenSRF::Utils::JSON->JSON2perl($lset->value) if $lset;
169 sub tag_circed_items {
171 my $e = $self->editor;
173 $self->timelog("Tag circed items?");
174 return 0 unless $e->requestor;
175 $self->timelog("Checking for opac.search.tag_circulated_items");
176 return 0 unless $self->ctx->{get_org_setting}->(
177 $e->requestor->home_ou,
178 'opac.search.tag_circulated_items');
180 # user has to be opted-in to circ history in some capacity
181 $self->timelog("Checking for history.circ.retention_*");
182 my $sets = $e->search_actor_user_setting({
183 usr => $e->requestor->id,
185 'history.circ.retention_age',
186 'history.circ.retention_start'
190 $self->timelog("Return from checking for history.circ.retention_*");
192 return 0 unless @$sets;
197 # This only loads the bookbag itself (in support of a record results page)
198 # if a "bookbag" CGI parameter is specified and if the bookbag is public
199 # or owned by the logged-in user (if any). Bookbag notes are fetched
200 # later if applicable.
201 sub load_rresults_bookbag {
204 my $bookbag_id = int($self->cgi->param("bookbag") || 0);
205 return if $bookbag_id < 1;
207 my %authz = $self->ctx->{"user"} ?
208 ("-or" => {"pub" => "t", "owner" => $self->ctx->{"user"}->id}) :
211 $self->timelog("Load results bookbag");
212 my $bbag = $self->editor->search_container_biblio_record_entry_bucket(
213 {"id" => $bookbag_id, "btype" => "bookbag", %authz}
215 $self->timelog("Got results bookbag");
218 $self->apache->log->warn(
219 "error from cstore retrieving bookbag $bookbag_id!"
221 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
223 $self->ctx->{"bookbag"} = shift @$bbag;
229 # assumes context has a bookbag we're already authorized to look at, and
230 # a list of rec_ids, reasonably sized (from paged search).
231 sub load_rresults_bookbag_item_notes {
232 my ($self, $rec_ids) = @_;
234 $self->timelog("Load results bookbag item notes");
235 my $items_with_notes =
236 $self->editor->search_container_biblio_record_entry_bucket_item([
237 {"target_biblio_record_entry" => $rec_ids,
238 "bucket" => $self->ctx->{"bookbag"}->id},
239 {"flesh" => 1, "flesh_fields" => {"cbrebi" => ["notes"]},
240 "order_by" => {"cbrebi" => ["id"]}}
242 $self->timelog("Got results bookbag item notes");
244 if (!$items_with_notes) {
245 $self->apache->log->warn("error from cstore retrieving cbrebi objects");
246 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
249 $self->ctx->{"bookbag_items_by_bre_id"} = +{
250 map { $_->target_biblio_record_entry => $_ } @$items_with_notes
259 # records : list of bre's and copy-count objects
263 my $internal = $args{internal};
264 my $cgi = $self->cgi;
265 my $ctx = $self->ctx;
266 my $e = $self->editor;
268 $self->timelog("Loading results");
269 # load bookbag metadata, if requested.
270 if (my $bbag_err = $self->load_rresults_bookbag) {
274 $ctx->{page} = 'rresult' unless $internal;
276 $ctx->{records} = [];
277 $ctx->{search_facets} = {};
278 $ctx->{hit_count} = 0;
280 # Special alternative searches here. This could all stand to be cleaner.
281 if ($cgi->param("_special")) {
282 $self->timelog("Calling MARC expert search");
283 return $self->marc_expert_search(%args) if scalar($cgi->param("tag"));
284 $self->timelog("Calling item barcode search");
285 return $self->item_barcode_shortcut if (
286 $cgi->param("qtype") and ($cgi->param("qtype") eq "item_barcode")
288 $self->timelog("Calling call number browse");
289 return $self->call_number_browse_standalone if (
290 $cgi->param("qtype") and ($cgi->param("qtype") eq "cnbrowse")
294 $self->timelog("Getting search parameters");
295 my $page = $cgi->param('page') || 0;
296 my @facets = $cgi->param('facet');
297 my $limit = $self->_get_search_limit;
298 $ctx->{search_ou} = $self->_get_search_lib();
299 $ctx->{pref_ou} = $self->_get_pref_lib() || $ctx->{search_ou};
300 my $offset = $page * $limit;
301 my $metarecord = $cgi->param('metarecord');
303 my $tag_circs = $self->tag_circed_items;
304 $self->timelog("Got search parameters");
306 $ctx->{page_size} = $limit;
307 $ctx->{search_page} = $page;
309 # fetch this page plus the first hit from the next page
311 $limit = $offset + $limit + 1;
315 my ($query, $site, $depth) = _prepare_biblio_search($cgi, $ctx);
317 $self->get_staff_search_settings;
319 if ($ctx->{staff_saved_search_size}) {
320 my ($key, $list) = $self->staff_save_search($query);
322 $self->apache->headers_out->add(
323 "Set-Cookie" => $self->cgi->cookie(
324 -name => (ref $self)->COOKIE_ANON_CACHE,
326 -value => ($key || ''),
327 -expires => ($key ? undef : "-1h")
330 $ctx->{saved_searches} = $list;
334 if ($metarecord and !$internal) {
336 # TODO: other limits, like SVF/format, etc.
337 $self->timelog("Getting metarecords to records");
338 $results = $U->simplereq(
340 'open-ils.search.biblio.metarecord_to_records',
341 $metarecord, {org => $ctx->{search_ou}, depth => $depth}
343 $self->timelog("Got metarecords to records");
345 # force the metarecord result blob to match the format of regular search results
346 $results->{ids} = [map { [$_] } @{$results->{ids}}];
351 return Apache2::Const::OK if $internal;
352 return $self->generic_redirect;
355 # Limit and offset will stay here. Everything else should be part of
356 # the query string, not special args.
357 my $args = {'limit' => $limit, 'offset' => $offset};
360 $args->{tag_circulated_records} = 1;
361 $args->{authtoken} = $self->editor->authtoken;
364 # Stuff these into the TT context so that templates can use them in redrawing forms
365 $ctx->{processed_search_query} = $query;
367 $query .= " $_" for @facets;
369 $logger->activity("EGWeb: [search] $query");
373 my $method = 'open-ils.search.biblio.multiclass.query';
374 $method .= '.staff' if $ctx->{is_staff};
376 $self->timelog("Firing off the multiclass query");
377 $results = $U->simplereq('open-ils.search', $method, $args, $query, 1);
378 $self->timelog("Returned from the multiclass query");
382 $logger->error("multiclass search error: $err");
383 $results = {count => 0, ids => []};
387 my $rec_ids = [map { $_->[0] } @{$results->{ids}}];
389 $ctx->{ids} = $rec_ids;
390 $ctx->{hit_count} = $results->{count};
391 $ctx->{parsed_query} = $results->{parsed_query};
393 return Apache2::Const::OK if @$rec_ids == 0 or $internal;
395 $self->load_rresults_bookbag_item_notes($rec_ids) if $ctx->{bookbag};
397 $self->timelog("Calling get_records_and_facets()");
398 my ($facets, @data) = $self->get_records_and_facets(
399 $rec_ids, $results->{facet_key},
401 flesh => '{holdings_xml,mra,acp,acnp,acns,bmp}',
404 pref_lib => $ctx->{pref_ou},
407 $self->timelog("Returned from get_records_and_facets()");
410 my $stat = $self->check_1hit_redirect($rec_ids);
411 return $stat if $stat;
414 # shove recs into context in search results order
415 for my $rec_id (@$rec_ids) {
418 grep { $_->{id} == $rec_id } @data
423 for my $rec (@{$ctx->{records}}) {
424 my ($res_rec) = grep { $_->[0] == $rec->{id} } @{$results->{ids}};
425 # index 1 in the per-record result array is a boolean which
426 # indicates whether the record in question is in the users
427 # accessible circ history list
428 $rec->{user_circulated} = 1 if $res_rec->[1];
432 $ctx->{search_facets} = $facets;
434 return Apache2::Const::OK;
437 # If the calling search results in 1 record and the client
438 # is configured to do so, redirect the search results to
439 # the record details page.
440 sub check_1hit_redirect {
441 my ($self, $rec_ids) = @_;
442 my $ctx = $self->ctx;
444 return undef unless $rec_ids and @$rec_ids == 1;
448 $self->timelog("Checking whether to jump to details on a single hit");
449 if ($ctx->{is_staff}) {
450 $sname = 'opac.staff.jump_to_details_on_single_hit';
451 $org = $ctx->{user}->ws_ou;
454 $sname = 'opac.patron.jump_to_details_on_single_hit';
455 $org = $self->_get_search_lib();
458 $self->timelog("Return from checking whether to jump to details on a single hit");
461 $self->ctx->{get_org_setting}->($org, $sname);
463 my $base_url = sprintf(
464 '%s://%s%s/record/%s',
466 $self->apache->hostname,
467 $self->ctx->{opac_root},
471 # If we get here from the same record detail page to which we
472 # now wish to redirect, do not perform the redirect. This
473 # approach seems to work well, with the rare exception of
474 # performing a new serach directly from the detail page that
475 # happens to result in the same single hit. In this case, the
476 # user will be left on the search results page. This could be
477 # overcome w/ additional CGI, etc., but I'm not sure it's necessary.
478 if (my $referer = $ctx->{referer}) {
479 $referer =~ s/([^?]*).*/$1/g;
480 return undef if $base_url eq $referer;
483 return $self->generic_redirect($base_url . '?' . $self->cgi->query_string);
486 # Searching by barcode is a special search that does /not/ respect any other
487 # of the usual search parameters, not even the ones for sorting and paging!
488 sub item_barcode_shortcut {
491 $self->timelog("Searching for item_barcode");
492 my $method = "open-ils.search.multi_home.bib_ids.by_barcode";
493 if (my $search = create OpenSRF::AppSession("open-ils.search")) {
494 my $rec_ids = $search->request(
495 $method, $self->cgi->param("query")
498 $self->timelog("Finished searching for item_barcode");
500 if (ref $rec_ids ne 'ARRAY') {
502 if($U->event_equals($rec_ids, 'ASSET_COPY_NOT_FOUND')) {
506 if (defined $U->event_code($rec_ids)) {
507 $self->apache->log->warn(
508 "$method returned event: " . $U->event_code($rec_ids)
511 $self->apache->log->warn(
512 "$method returned something unexpected: $rec_ids"
515 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
519 $self->timelog("Calling get_records_and_facets() for item_barcode");
520 my ($facets, @data) = $self->get_records_and_facets(
521 $rec_ids, undef, {flesh => "{holdings_xml,mra,acnp,acns,bmp}"}
523 $self->timelog("Returned from calling get_records_and_facets() for item_barcode");
525 $self->ctx->{records} = [@data];
526 $self->ctx->{search_facets} = {};
527 $self->ctx->{hit_count} = scalar @data;
528 $self->ctx->{page_size} = $self->ctx->{hit_count};
530 return Apache2::Const::OK;
532 $self->apache->log->warn("couldn't connect to open-ils.search");
533 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
537 # like item_barcode_search, this can't take all the usual search params, but
538 # this one will at least do site, limit and page
539 sub marc_expert_search {
540 my ($self, %args) = @_;
542 my @tags = $self->cgi->param("tag");
543 my @subfields = $self->cgi->param("subfield");
544 my @terms = $self->cgi->param("term");
547 for (my $i = 0; $i < scalar @tags; $i++) {
548 next if ($tags[$i] eq "" || $terms[$i] eq "");
549 $subfields[$i] = '_' unless $subfields[$i];
551 "term" => $terms[$i],
552 "restrict" => [{"tag" => $tags[$i], "subfield" => $subfields[$i]}]
556 $logger->info("query for expert search: " . Dumper($query));
558 $self->timelog("Getting search parameters");
559 # loc, limit and offset
560 my $page = $self->cgi->param("page") || 0;
561 my $limit = $self->_get_search_limit;
562 $self->ctx->{search_ou} = $self->_get_search_lib();
563 $self->ctx->{pref_ou} = $self->_get_pref_lib();
564 my $offset = $page * $limit;
565 $self->timelog("Got search parameters");
567 $self->ctx->{records} = [];
568 $self->ctx->{search_facets} = {};
569 $self->ctx->{page_size} = $limit;
570 $self->ctx->{hit_count} = 0;
571 $self->ctx->{ids} = [];
572 $self->ctx->{search_page} = $page;
575 return Apache2::Const::OK if @$query == 0;
577 if ($args{internal}) {
578 $limit = $offset + $limit + 1;
582 $self->timelog("Searching for MARC expert");
584 my $ses = OpenSRF::AppSession->create('open-ils.search');
585 my $req = $ses->request(
586 'open-ils.search.biblio.marc',
587 {searches => $query, org_unit => $self->ctx->{search_ou}},
588 $limit, $offset, $timeout);
590 my $resp = $req->recv($timeout);
591 my $results = $resp ? $resp->content : undef;
593 $self->timelog("Got our MARC expert results");
595 if (defined $U->event_code($results)) {
596 $self->apache->log->warn(
597 "open-ils.search.biblio.marc returned event: " .
598 $U->event_code($results)
600 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
603 $self->ctx->{ids} = [ grep { $_ } @{$results->{ids}} ];
604 $self->ctx->{hit_count} = $results->{count};
606 return Apache2::Const::OK if @{$self->ctx->{ids}} == 0 or $args{internal};
609 my $stat = $self->check_1hit_redirect($self->ctx->{ids});
610 return $stat if $stat;
613 $self->timelog("Calling get_records_and_facets() for MARC expert");
614 my ($facets, @data) = $self->get_records_and_facets(
615 $self->ctx->{ids}, undef, {
616 flesh => "{holdings_xml,mra,acnp,acns}",
617 pref_lib => $self->ctx->{pref_ou},
620 $self->timelog("Returned from calling get_records_and_facets() for MARC expert");
622 $self->ctx->{records} = [@data];
624 return Apache2::Const::OK;
627 sub call_number_browse_standalone {
630 if (my $cnfrag = $self->cgi->param("query")) {
632 'http%s://%s%s/cnbrowse?cn=%s',
633 $self->cgi->https ? "s" : "",
634 $self->apache->hostname,
635 $self->ctx->{opac_root},
636 $cnfrag # XXX some kind of escaping needed here?
638 return $self->generic_redirect($url);
640 return $self->generic_redirect; # return to search page
647 $self->prepare_browse_call_numbers();
649 return Apache2::Const::OK;
652 sub get_staff_search_settings {
655 unless ($self->ctx->{is_staff}) {
656 $self->ctx->{staff_saved_search_size} = 0;
660 $self->timelog("Getting staff search size");
661 my $sss_size = $self->ctx->{get_org_setting}->(
662 $self->ctx->{physical_loc} || $self->ctx->{aou_tree}->()->id,
663 "opac.staff_saved_search.size",
665 $self->timelog("Got staff search size");
667 # Sic: 0 is 0 (off), but undefined is 10.
668 $sss_size = 10 unless defined $sss_size;
670 $self->ctx->{staff_saved_search_size} = $sss_size;
673 sub staff_load_searches {
676 my $cache_key = $self->cgi->cookie((ref $self)->COOKIE_ANON_CACHE);
680 $self->timelog("Getting anon_cache value");
681 $list = $U->simplereq(
683 "open-ils.actor.anon_cache.get_value",
684 $cache_key, (ref $self)->ANON_CACHE_STAFF_SEARCH
686 $self->timelog("Got anon_cache value");
694 return ($cache_key, $list);
697 sub staff_save_search {
698 my ($self, $query) = @_;
700 my $sss_size = $self->ctx->{staff_saved_search_size};
701 return unless $sss_size > 0;
703 my ($cache_key, $list) = $self->staff_load_searches;
704 my %already = ( map { $_ => 1 } @$list );
706 unshift @$list, $query unless $already{$query};
708 splice @$list, $sss_size if scalar @$list > $sss_size;
710 $self->timelog("Setting anon_cache value");
711 $cache_key = $U->simplereq(
713 "open-ils.actor.anon_cache.set_value",
714 $cache_key, (ref $self)->ANON_CACHE_STAFF_SEARCH, $list
716 $self->timelog("Set anon_cache value");
718 return ($cache_key, $list);