4 package OpenILS::Application::Storage::Driver::Pg::QueryParser;
5 use OpenILS::Application::Storage::QueryParser;
6 use base 'QueryParser';
7 use OpenSRF::Utils::JSON;
8 use OpenILS::Application::AppUtils;
9 use OpenILS::Utils::CStoreEditor;
10 my $U = 'OpenILS::Application::AppUtils';
13 sub subquery_callback {
14 my ($invocant, $self, $struct, $filter, $params, $negate) = @_;
21 OpenILS::Utils::CStoreEditor
23 ->search_actor_search_query({ id => $params })
28 sub filter_group_entry_callback {
29 my ($invocant, $self, $struct, $filter, $params, $negate) = @_;
31 return sprintf(' saved_query(%s)',
37 OpenILS::Utils::CStoreEditor
39 ->search_actor_search_filter_group_entry({ id => $params })
49 if ($value =~ /^\d/) { # may have to use non-$ quoting
51 $value =~ s/\\/\\\\/g;
54 return "\$_$$\$$value\$_$$\$";
57 sub quote_phrase_value {
61 my $left_anchored = $value =~ m/^\^/;
62 my $right_anchored = $value =~ m/\$$/;
63 $value =~ s/\^// if $left_anchored;
64 $value =~ s/\$$// if $right_anchored;
65 $value = quotemeta($value);
66 $value = '^' . $value if $left_anchored;
67 $value = "$value\$" if $right_anchored;
68 return $self->quote_value($value);
75 sub default_preferred_language {
79 $self->custom_data->{default_preferred_language} = $lang if ($lang);
80 return $self->custom_data->{default_preferred_language};
83 sub default_preferred_language_multiplier {
87 $self->custom_data->{default_preferred_language_multiplier} = $lang if ($lang);
88 return $self->custom_data->{default_preferred_language_multiplier};
94 return 0 unless $self->parse_tree;
95 return 0 if @{$self->parse_tree->filters};
96 return 0 if @{$self->parse_tree->modifiers};
97 for my $node ( @{ $self->parse_tree->query_nodes } ) {
98 return 0 if (!ref($node) && $node eq '|');
99 next unless (ref($node));
100 return 0 if ($node->isa('QueryParser::query_plan'));
108 return $self->parse_tree->toSQL;
111 sub dynamic_filters {
115 $self->custom_data->{dynamic_filters} ||= [];
116 push(@{$self->custom_data->{dynamic_filters}}, $new) if ($new);
117 return $self->custom_data->{dynamic_filters};
120 sub dynamic_sorters {
124 $self->custom_data->{dynamic_sorters} ||= [];
125 push(@{$self->custom_data->{dynamic_sorters}}, $new) if ($new);
126 return $self->custom_data->{dynamic_sorters};
129 sub facet_field_id_map {
133 $self->custom_data->{facet_field_id_map} ||= {};
134 $self->custom_data->{facet_field_id_map} = $map if ($map);
135 return $self->custom_data->{facet_field_id_map};
138 sub add_facet_field_id_map {
145 $self->add_facet_field( $class => $field );
146 $self->facet_field_id_map->{by_id}{$id} = { classname => $class, field => $field, weight => $weight };
147 $self->facet_field_id_map->{by_class}{$class}{$field} = $id;
150 by_id => { $id => { classname => $class, field => $field, weight => $weight } },
151 by_class => { $class => { $field => $id } }
155 sub facet_field_class_by_id {
159 return $self->facet_field_id_map->{by_id}{$id};
162 sub facet_field_ids_by_class {
167 return undef unless ($class);
170 return [$self->facet_field_id_map->{by_class}{$class}{$field}];
173 return [values( %{ $self->facet_field_id_map->{by_class}{$class} } )];
176 sub search_field_id_map {
180 $self->custom_data->{search_field_id_map} ||= {};
181 $self->custom_data->{search_field_id_map} = $map if ($map);
182 return $self->custom_data->{search_field_id_map};
185 sub add_search_field_id_map {
192 $self->add_search_field( $class => $field );
193 $self->search_field_id_map->{by_id}{$id} = { classname => $class, field => $field, weight => $weight };
194 $self->search_field_id_map->{by_class}{$class}{$field} = $id;
197 by_id => { $id => { classname => $class, field => $field, weight => $weight } },
198 by_class => { $class => { $field => $id } }
202 sub search_field_class_by_id {
206 return $self->search_field_id_map->{by_id}{$id};
209 sub search_field_ids_by_class {
214 return undef unless ($class);
217 return [$self->search_field_id_map->{by_class}{$class}{$field}];
220 return [values( %{ $self->search_field_id_map->{by_class}{$class} } )];
223 sub relevance_bumps {
227 $self->custom_data->{rel_bumps} ||= {};
228 $self->custom_data->{rel_bumps} = $bumps if ($bumps);
229 return $self->custom_data->{rel_bumps};
232 sub find_relevance_bumps {
237 return $self->relevance_bumps->{$class}{$field};
240 sub add_relevance_bump {
245 my $multiplier = shift;
248 if (defined($active) and $active eq 'f') {
254 $self->relevance_bumps->{$class}{$field}{$type} = { multiplier => $multiplier, active => $active };
256 return { $class => { $field => { $type => { multiplier => $multiplier, active => $active } } } };
260 sub initialize_search_field_id_map {
262 my $cmf_list = shift;
264 for my $cmf (@$cmf_list) {
265 __PACKAGE__->add_search_field_id_map( $cmf->field_class, $cmf->name, $cmf->id, $cmf->weight ) if ($U->is_true($cmf->search_field));
266 __PACKAGE__->add_facet_field_id_map( $cmf->field_class, $cmf->name, $cmf->id, $cmf->weight ) if ($U->is_true($cmf->facet_field));
269 return $self->search_field_id_map;
272 sub initialize_aliases {
274 my $cmsa_list = shift;
276 for my $cmsa (@$cmsa_list) {
278 __PACKAGE__->add_search_class_alias( $cmsa->field_class, $cmsa->alias );
280 my $c = $self->search_field_class_by_id( $cmsa->field );
281 __PACKAGE__->add_search_field_alias( $cmsa->field_class, $c->{field}, $cmsa->alias );
286 sub initialize_relevance_bumps {
288 my $sra_list = shift;
290 for my $sra (@$sra_list) {
291 my $c = $self->search_field_class_by_id( $sra->field );
292 __PACKAGE__->add_relevance_bump( $c->{classname}, $c->{field}, $sra->bump_type, $sra->multiplier, $sra->active );
295 return $self->relevance_bumps;
298 sub initialize_query_normalizers {
300 my $tree = shift; # open-ils.cstore.direct.config.metabib_field_index_norm_map.search.atomic { "id" : { "!=" : null } }, { "flesh" : 1, "flesh_fields" : { "cmfinm" : ["norm"] }, "order_by" : [{ "class" : "cmfinm", "field" : "pos" }] }
302 for my $cmfinm ( @$tree ) {
303 my $field_info = $self->search_field_class_by_id( $cmfinm->field );
304 __PACKAGE__->add_query_normalizer( $field_info->{classname}, $field_info->{field}, $cmfinm->norm->func, OpenSRF::Utils::JSON->JSON2perl($cmfinm->params) );
308 sub initialize_dynamic_filters {
310 my $list = shift; # open-ils.cstore.direct.config.record_attr_definition.search.atomic { "id" : { "!=" : null } }
312 for my $crad ( @$list ) {
313 __PACKAGE__->dynamic_filters( __PACKAGE__->add_search_filter( $crad->name ) ) if ($U->is_true($crad->filter));
314 __PACKAGE__->dynamic_sorters( $crad->name ) if ($U->is_true($crad->sorter));
318 sub initialize_filter_normalizers {
320 my $tree = shift; # open-ils.cstore.direct.config.record_attr_index_norm_map.search.atomic { "id" : { "!=" : null } }, { "flesh" : 1, "flesh_fields" : { "crainm" : ["norm"] }, "order_by" : [{ "class" : "crainm", "field" : "pos" }] }
322 for my $crainm ( @$tree ) {
323 __PACKAGE__->add_filter_normalizer( $crainm->attr, $crainm->norm->func, OpenSRF::Utils::JSON->JSON2perl($crainm->params) );
328 sub initialization_complete {
336 return $_complete if ($_complete);
338 # tsearch rank normalization adjustments. see http://www.postgresql.org/docs/9.0/interactive/textsearch-controls.html#TEXTSEARCH-RANKING for details
339 $self->custom_data->{rank_cd_weight_map} = {
340 CD_logDocumentLength => 1,
341 CD_documentLength => 2,
342 CD_meanHarmonic => 4,
344 CD_logUniqueWords => 16,
348 $self->add_search_modifier( $_ ) for (keys %{ $self->custom_data->{rank_cd_weight_map} });
350 $self->initialize_search_field_id_map( $args{config_metabib_field} )
351 if ($args{config_metabib_field});
353 $self->initialize_aliases( $args{config_metabib_search_alias} )
354 if ($args{config_metabib_search_alias});
356 $self->initialize_relevance_bumps( $args{search_relevance_adjustment} )
357 if ($args{search_relevance_adjustment});
359 $self->initialize_query_normalizers( $args{config_metabib_field_index_norm_map} )
360 if ($args{config_metabib_field_index_norm_map});
362 $self->initialize_dynamic_filters( $args{config_record_attr_definition} )
363 if ($args{config_record_attr_definition});
365 $self->initialize_filter_normalizers( $args{config_record_attr_index_norm_map} )
366 if ($args{config_record_attr_index_norm_map});
369 $args{config_metabib_field_index_norm_map} &&
370 $args{search_relevance_adjustment} &&
371 $args{config_metabib_search_alias} &&
372 $args{config_metabib_field} &&
373 $args{config_record_attr_definition}
381 __PACKAGE__->add_search_field_id_map( series => seriestitle => 1 => 1 );
383 __PACKAGE__->add_search_field_id_map( series => seriestitle => 1 => 1 );
384 __PACKAGE__->add_relevance_bump( series => seriestitle => first_word => 1.5 );
385 __PACKAGE__->add_relevance_bump( series => seriestitle => full_match => 20 );
387 __PACKAGE__->add_search_field_id_map( title => abbreviated => 2 => 1 );
388 __PACKAGE__->add_relevance_bump( title => abbreviated => first_word => 1.5 );
389 __PACKAGE__->add_relevance_bump( title => abbreviated => full_match => 20 );
391 __PACKAGE__->add_search_field_id_map( title => translated => 3 => 1 );
392 __PACKAGE__->add_relevance_bump( title => translated => first_word => 1.5 );
393 __PACKAGE__->add_relevance_bump( title => translated => full_match => 20 );
395 __PACKAGE__->add_search_field_id_map( title => proper => 6 => 1 );
396 __PACKAGE__->add_query_normalizer( title => proper => 'search_normalize' );
397 __PACKAGE__->add_relevance_bump( title => proper => first_word => 1.5 );
398 __PACKAGE__->add_relevance_bump( title => proper => full_match => 20 );
399 __PACKAGE__->add_relevance_bump( title => proper => word_order => 10 );
401 __PACKAGE__->add_search_field_id_map( author => corporate => 7 => 1 );
402 __PACKAGE__->add_relevance_bump( author => corporate => first_word => 1.5 );
403 __PACKAGE__->add_relevance_bump( author => corporate => full_match => 20 );
405 __PACKAGE__->add_facet_field_id_map( author => personal => 8 => 1 );
407 __PACKAGE__->add_search_field_id_map( author => personal => 8 => 1 );
408 __PACKAGE__->add_relevance_bump( author => personal => first_word => 1.5 );
409 __PACKAGE__->add_relevance_bump( author => personal => full_match => 20 );
410 __PACKAGE__->add_query_normalizer( author => personal => 'search_normalize' );
411 __PACKAGE__->add_query_normalizer( author => personal => 'split_date_range' );
413 __PACKAGE__->add_facet_field_id_map( subject => topic => 14 => 1 );
415 __PACKAGE__->add_search_field_id_map( subject => topic => 14 => 1 );
416 __PACKAGE__->add_relevance_bump( subject => topic => first_word => 1 );
417 __PACKAGE__->add_relevance_bump( subject => topic => full_match => 1 );
419 __PACKAGE__->add_search_field_id_map( subject => complete => 16 => 1 );
420 __PACKAGE__->add_relevance_bump( subject => complete => first_word => 1 );
421 __PACKAGE__->add_relevance_bump( subject => complete => full_match => 1 );
423 __PACKAGE__->add_search_field_id_map( keyword => keyword => 15 => 1 );
424 __PACKAGE__->add_relevance_bump( keyword => keyword => first_word => 1 );
425 __PACKAGE__->add_relevance_bump( keyword => keyword => full_match => 1 );
428 __PACKAGE__->add_search_class_alias( keyword => 'kw' );
429 __PACKAGE__->add_search_class_alias( title => 'ti' );
430 __PACKAGE__->add_search_class_alias( author => 'au' );
431 __PACKAGE__->add_search_class_alias( author => 'name' );
432 __PACKAGE__->add_search_class_alias( author => 'dc.contributor' );
433 __PACKAGE__->add_search_class_alias( subject => 'su' );
434 __PACKAGE__->add_search_class_alias( subject => 'bib.subject(?:Title|Place|Occupation)' );
435 __PACKAGE__->add_search_class_alias( series => 'se' );
436 __PACKAGE__->add_search_class_alias( keyword => 'dc.identifier' );
438 __PACKAGE__->add_query_normalizer( author => corporate => 'search_normalize' );
439 __PACKAGE__->add_query_normalizer( keyword => keyword => 'search_normalize' );
441 __PACKAGE__->add_search_field_alias( subject => name => 'bib.subjectName' );
445 __PACKAGE__->default_search_class( 'keyword' );
447 # implements EG-specific stored subqueries
448 __PACKAGE__->add_search_filter( 'saved_query', sub { return __PACKAGE__->subquery_callback(@_) } );
449 __PACKAGE__->add_search_filter( 'filter_group_entry', sub { return __PACKAGE__->filter_group_entry_callback(@_) } );
451 # will be retained simply for back-compat
452 __PACKAGE__->add_search_filter( 'format' );
454 # grumble grumble, special cases against date1 and date2
455 __PACKAGE__->add_search_filter( 'before' );
456 __PACKAGE__->add_search_filter( 'after' );
457 __PACKAGE__->add_search_filter( 'between' );
458 __PACKAGE__->add_search_filter( 'during' );
460 # used by layers above this
461 __PACKAGE__->add_search_filter( 'statuses' );
462 __PACKAGE__->add_search_filter( 'locations' );
463 __PACKAGE__->add_search_filter( 'location_groups' );
464 __PACKAGE__->add_search_filter( 'site' );
465 __PACKAGE__->add_search_filter( 'pref_ou' );
466 __PACKAGE__->add_search_filter( 'lasso' );
467 __PACKAGE__->add_search_filter( 'my_lasso' );
468 __PACKAGE__->add_search_filter( 'depth' );
469 __PACKAGE__->add_search_filter( 'language' );
470 __PACKAGE__->add_search_filter( 'offset' );
471 __PACKAGE__->add_search_filter( 'limit' );
472 __PACKAGE__->add_search_filter( 'check_limit' );
473 __PACKAGE__->add_search_filter( 'skip_check' );
474 __PACKAGE__->add_search_filter( 'superpage' );
475 __PACKAGE__->add_search_filter( 'superpage_size' );
476 __PACKAGE__->add_search_filter( 'estimation_strategy' );
477 __PACKAGE__->add_search_modifier( 'available' );
478 __PACKAGE__->add_search_modifier( 'staff' );
480 # Start from container data (bre, acn, acp): container(bre,bookbag,123,deadb33fdeadb33fdeadb33fdeadb33f)
481 __PACKAGE__->add_search_filter( 'container' );
483 # Start from a list of record ids, either bre or metarecords, depending on the #metabib modifier
484 __PACKAGE__->add_search_filter( 'record_list' );
486 # used internally, but generally not user-settable
487 __PACKAGE__->add_search_filter( 'preferred_language' );
488 __PACKAGE__->add_search_filter( 'preferred_language_weight' );
489 __PACKAGE__->add_search_filter( 'preferred_language_multiplier' );
490 __PACKAGE__->add_search_filter( 'core_limit' );
492 # XXX Valid values to be supplied by SVF
493 __PACKAGE__->add_search_filter( 'sort' );
495 # modifies core query, not configurable
496 __PACKAGE__->add_search_modifier( 'descending' );
497 __PACKAGE__->add_search_modifier( 'ascending' );
498 __PACKAGE__->add_search_modifier( 'nullsfirst' );
499 __PACKAGE__->add_search_modifier( 'nullslast' );
500 __PACKAGE__->add_search_modifier( 'metarecord' );
501 __PACKAGE__->add_search_modifier( 'metabib' );
504 #-------------------------------
505 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan;
506 use base 'QueryParser::query_plan';
507 use OpenSRF::Utils::Logger qw($logger);
509 use OpenILS::Application::AppUtils;
510 my $apputils = "OpenILS::Application::AppUtils";
517 my ($format) = $self->find_filter('format');
519 my ($t,$f) = split('-', $format->args->[0]);
520 $self->new_filter( item_type => [ split '', $t ] ) if ($t);
521 $self->new_filter( item_form => [ split '', $f ] ) if ($f);
524 for my $f ( qw/preferred_language preferred_language_multiplier preferred_language_weight core_limit check_limit skip_check superpage superpage_size/ ) {
526 $col = 'preferred_language_multiplier' if ($f eq 'preferred_language_weight');
527 my ($filter) = $self->find_filter($f);
528 if ($filter and @{$filter->args}) {
529 $filters{$col} = $filter->args->[0];
533 $self->QueryParser->superpage($filters{superpage}) if ($filters{superpage});
534 $self->QueryParser->superpage_size($filters{superpage_size}) if ($filters{superpage_size});
535 $self->QueryParser->core_limit($filters{core_limit}) if ($filters{core_limit});
537 $logger->debug("Query plan:\n".Dumper($self));
539 my $flat_plan = $self->flatten;
541 # generate the relevance ranking
542 my $rel = "AVG(\n${spc}${spc}(" . join(")+\n${spc}${spc}(", @{$$flat_plan{rank_list}}) . ")\n${spc})+1";
544 # find any supplied sort option
545 my ($sort_filter) = $self->find_filter('sort');
547 $sort_filter = $sort_filter->args->[0];
549 $sort_filter = 'rel';
552 if (($filters{preferred_language} || $self->QueryParser->default_preferred_language) && ($filters{preferred_language_multiplier} || $self->QueryParser->default_preferred_language_multiplier)) {
553 my $pl = $self->QueryParser->quote_value( $filters{preferred_language} ? $filters{preferred_language} : $self->QueryParser->default_preferred_language );
554 my $plw = $filters{preferred_language_multiplier} ? $filters{preferred_language_multiplier} : $self->QueryParser->default_preferred_language_multiplier;
555 $rel = "($rel * COALESCE( NULLIF( FIRST(mrd.attrs \@> hstore('item_lang', $pl)), FALSE )::INT * $plw, 1))";
557 $rel = "1.0/($rel)::NUMERIC";
559 my $mra_join = 'INNER JOIN metabib.record_attr mrd ON (m.source = mrd.id';
560 $mra_join .= ' AND '. $flat_plan->{fwhere} if $flat_plan->{fwhere};
566 $desc = 'DESC' if ($self->find_modifier('descending'));
568 my $nullpos = 'NULLS LAST';
569 $nullpos = 'NULLS FIRST' if ($self->find_modifier('nullsfirst'));
571 if (grep {$_ eq $sort_filter} @{$self->QueryParser->dynamic_sorters}) {
572 $rank = "FIRST(mrd.attrs->'$sort_filter')"
573 } elsif ($sort_filter eq 'create_date') {
574 $rank = "FIRST((SELECT create_date FROM biblio.record_entry rbr WHERE rbr.id = m.source))";
575 } elsif ($sort_filter eq 'edit_date') {
576 $rank = "FIRST((SELECT edit_date FROM biblio.record_entry rbr WHERE rbr.id = m.source))";
578 # default to rel ranking
582 my $key = 'm.source';
583 $key = 'm.metarecord' if (grep {$_->name eq 'metarecord' or $_->name eq 'metabib'} @{$self->modifiers});
585 my ($before) = $self->find_filter('before');
586 my ($after) = $self->find_filter('after');
587 my ($during) = $self->find_filter('during');
588 my ($between) = $self->find_filter('between');
589 my ($container) = $self->find_filter('container');
590 my ($record_list) = $self->find_filter('record_list');
592 if ($before and @{$before->args} == 1) {
593 $before = "AND (mrd.attrs->'date1') <= " . $self->QueryParser->quote_value($before->args->[0]);
598 if ($after and @{$after->args} == 1) {
599 $after = "AND (mrd.attrs->'date1') >= " . $self->QueryParser->quote_value($after->args->[0]);
604 if ($during and @{$during->args} == 1) {
605 $during = "AND " . $self->QueryParser->quote_value($during->args->[0]) . " BETWEEN (mrd.attrs->'date1') AND (mrd.attrs->'date2')";
610 if ($between and @{$between->args} == 2) {
611 $between = "AND (mrd.attrs->'date1') BETWEEN " . $self->QueryParser->quote_value($between->args->[0]) . " AND " . $self->QueryParser->quote_value($between->args->[1]);
616 if ($container and @{$container->args} >= 3) {
617 my ($class, $ctype, $cid, $token) = @{ $container->args };
621 my $rec_field = 'ci.target_biblio_record_entry';
623 if ($class eq 'bre') {
624 $class = 'biblio_record_entry';
625 } elsif ($class eq 'acn') {
626 $class = 'call_number';
627 $rec_field = 'cn.record';
628 $rec_join = 'JOIN asset.call_number cn ON (ci.target_call_number = cn.id)';
629 } elsif ($class eq 'acp') {
631 $rec_field = 'cn.record';
632 $rec_join = 'JOIN asset.copy cp ON (ci.target_copy = cp.id) JOIN asset.call_number cn ON (cp.call_number = cn.id)';
633 # } elsif ($class eq 'au') {
635 # $rec_field = 'cn.record';
636 # $rec_join = 'JOIN asset.call_number cn ON ci.target_call_number = cn.id';
637 } else { $class = undef };
640 my ($u,$e) = $apputils->checksesperm($token) if ($token);
641 $perm_join = 'OR c.owner = ' . $u->id if ($u && !$e);
644 JOIN ( SELECT $rec_field AS container_item
645 FROM container.${class}_bucket_item ci
646 JOIN container.${class}_bucket c ON (c.id = ci.bucket)
648 WHERE c.btype = > . $self->QueryParser->quote_value($ctype) .
649 qq< AND c.id = > . $self->QueryParser->quote_value($cid) .
650 qq< AND (c.pub IS TRUE $perm_join)) container ON (container.container_item = m.source) >;
651 } else {$container = ''};
656 if ($record_list and @{$record_list->args} > 0) {
657 $record_list = 'JOIN (VALUES (' . join('),(', map { $self->QueryParser->quote_value($_) } @{ $record_list->args}) . ")) record_list(id) ON (record_list.id::BIGINT = $key)"
662 my $core_limit = $self->QueryParser->core_limit || 25000;
664 my $flat_where = $$flat_plan{where};
665 if ($flat_where eq '()') {
668 $flat_where = "AND $flat_where";
670 my $with = $$flat_plan{with};
671 $with= "\nWITH $with" if $with;
673 # Need an array for query parser db function; this gives a better plan
674 # than the ARRAY_AGG(DISTINCT m.source) option as of PostgreSQL 9.1
675 my $agg_records = 'ARRAY[m.source] AS records';
676 if ($key =~ /metarecord/) {
677 # metarecord searches still require the ARRAY_AGG approach
678 $agg_records = 'ARRAY_AGG(DISTINCT m.source) AS records';
687 FIRST(mrd.attrs->'date1') AS tie_break
688 FROM metabib.metarecord_source_map m
700 ORDER BY 4 $desc $nullpos, 5 DESC $nullpos, 3 DESC
704 warn $sql if $self->QueryParser->debug;
714 my $multiplier = shift;
716 my $only_atoms = $node->only_atoms;
717 return '' if (!@$only_atoms);
719 if ($bump eq 'first_word') {
720 return " /* first_word */ COALESCE(NULLIF( (search_normalize(".$node->table_alias.".value) ~ ('^'||search_normalize(".$self->QueryParser->quote_phrase_value($only_atoms->[0]->content)."))), FALSE )::INT * $multiplier, 1)";
721 } elsif ($bump eq 'full_match') {
722 return " /* full_match */ COALESCE(NULLIF( (search_normalize(".$node->table_alias.".value) ~ ('^'||".
723 join( "||' '||", map { "search_normalize(".$self->QueryParser->quote_phrase_value($_->content).")" } @$only_atoms )."||'\$')), FALSE )::INT * $multiplier, 1)";
724 } elsif ($bump eq 'word_order') {
725 return " /* word_order */ COALESCE(NULLIF( (search_normalize(".$node->table_alias.".value) ~ (".
726 join( "||'.*'||", map { "search_normalize(".$self->QueryParser->quote_phrase_value($_->content).")" } @$only_atoms ).")), FALSE )::INT * $multiplier, 1)";
735 my $from = shift || '';
736 my $where = shift || '(';
738 my $fwhere = shift || ''; # for joining dynamic filters (mra)
741 for my $filter (@{$self->filters}) {
742 push(@dyn_filters, $filter) if
743 grep { $_ eq $filter->name }
744 @{ $self->QueryParser->dynamic_filters };
748 for my $node ( @{$self->query_nodes} ) {
751 if ($node->isa( 'QueryParser::query_plan::node' )) {
753 unless (@{$node->only_atoms}) {
754 push @rank_list, '1';
759 my $table = $node->table;
760 my $talias = $node->table_alias;
762 my $node_rank = 'COALESCE(' . $node->rank . " * ${talias}.weight, 0.0)";
764 my $core_limit = $self->QueryParser->core_limit || 25000;
765 $from .= "\n${spc}LEFT JOIN (\n${spc}${spc}SELECT fe.*, fe_weight.weight, ${talias}_xq.tsq /* search */\n${spc}${spc} FROM $table AS fe";
766 $from .= "\n${spc}${spc}${spc}JOIN config.metabib_field AS fe_weight ON (fe_weight.id = fe.field)";
768 if ($node->dummy_count < @{$node->only_atoms} ) {
769 $with .= ",\n" if $with;
770 $with .= "${talias}_xq AS (SELECT ". $node->tsquery ." AS tsq )";
771 $from .= "\n${spc}${spc}${spc}JOIN ${talias}_xq ON (fe.index_vector @@ ${talias}_xq.tsq)";
773 $from .= "\n${spc}${spc}${spc}, (SELECT NULL::tsquery AS tsq ) AS x";
777 if (@{$node->fields} > 0) {
778 @bump_fields = @{$node->fields};
780 my @field_ids = grep defined, (
782 $self->QueryParser->search_field_ids_by_class(
788 $from .= "\n${spc}${spc}${spc}WHERE fe_weight.id IN (" .
789 join(',', @field_ids) . ")";
793 @bump_fields = @{$self->QueryParser->search_fields->{$node->classname}};
796 ###$from .= "\n${spc}${spc}LIMIT $core_limit";
797 $from .= "\n${spc}) AS $talias ON (m.source = ${talias}.source)";
801 for my $field ( @bump_fields ) {
802 my $bumps = $self->QueryParser->find_relevance_bumps( $node->classname => $field );
803 for my $b (keys %$bumps) {
804 next if (!$$bumps{$b}{active});
805 next if ($used_bumps{$b});
808 next if ($$bumps{$b}{multiplier} == 1); # optimization to remove unneeded bumps
810 my $bump_case = $self->rel_bump( $node, $b, $$bumps{$b}{multiplier} );
811 $node_rank .= "\n${spc}${spc}${spc}${spc} * " . $bump_case if ($bump_case);
816 my $twhere .= '(' . $talias . ".id IS NOT NULL";
817 $twhere .= ' AND ' . join(' AND ', map {"${talias}.value ~* ".$self->QueryParser->quote_phrase_value($_)} @{$node->phrases}) if (@{$node->phrases});
818 $twhere .= ' AND ' . join(' AND ', map {"${talias}.value !~* ".$self->QueryParser->quote_phrase_value($_)} @{$node->unphrases}) if (@{$node->unphrases});
821 if (@dyn_filters or !$self->top_plan) {
822 # if this WHERE is represented within the dynamic
823 # filter's ON clause, it's not also needed in the main WHERE.
829 push @rank_list, $node_rank;
831 } elsif ($node->isa( 'QueryParser::query_plan::facet' )) {
833 my $table = $node->table;
834 my $talias = $node->table_alias;
837 if (@{$node->fields} > 0) {
838 push(@field_ids, $self->QueryParser->facet_field_ids_by_class( $node->classname, $_ )->[0]) for (@{$node->fields});
840 @field_ids = @{ $self->QueryParser->facet_field_ids_by_class( $node->classname ) };
843 my $join_type = ($node->negate or @dyn_filters or !$self->top_plan) ? 'LEFT' : 'INNER';
844 $from .= "\n${spc}$join_type JOIN /* facet */ metabib.facet_entry $talias ON (\n${spc}${spc}m.source = ${talias}.source\n${spc}${spc}".
845 "AND SUBSTRING(${talias}.value,1,1024) IN (" . join(",", map { $self->QueryParser->quote_value($_) } @{$node->values}) . ")\n${spc}${spc}".
846 "AND ${talias}.field IN (". join(',', @field_ids) . ")\n${spc})";
848 if (@dyn_filters or !$self->top_plan) {
849 my $NOT = $node->negate ? '' : ' NOT';
850 $fwhere .= "${talias}.id IS$NOT NULL";
852 $where .= $node->negate ? "${talias}.id IS NULL" : 'TRUE';
856 my $subnode = $node->flatten;
858 # strip the trailing bool from the previous loop if there is
859 # nothing to add to the where/fwhere within this loop.
860 if ($$subnode{where} eq '()') {
861 $where =~ s/\s(AND|OR)\s$//;
863 } elsif ($$subnode{fwhere} eq '') {
864 $fwhere =~ s/\s(AND|OR)\s$//;
867 push(@rank_list, @{$$subnode{rank_list}});
868 $from .= $$subnode{from};
870 $where .= "($$subnode{where})" unless $$subnode{where} eq '()';
871 $fwhere .= "($$subnode{fwhere})" if $$subnode{fwhere};
873 if ($$subnode{with}) {
874 $with .= ', ' if $with;
875 $with .= " " . $$subnode{with};
880 warn "flatten(): appending WHERE bool to: $where\n" if $self->QueryParser->debug;
883 # bool joiner for inter-plan filters
884 $fwhere .= ' AND ' if ($node eq '&');
885 $fwhere .= ' OR ' if ($node eq '|');
887 } elsif ($where ne '(') {
889 $where .= ' AND ' if ($node eq '&');
890 $where .= ' OR ' if ($node eq '|');
895 # for each dynamic filter, build the ON clause for the JOIN
896 for my $filter (@dyn_filters) {
898 warn "flatten(): processing dynamic filter ". $filter->name ."\n"
899 if $self->QueryParser->debug;
901 # bool joiner for intra-plan nodes/filters
902 $fwhere .= sprintf(" %s ", ($self->joiner eq '&' ? 'AND' : 'OR')) if $fwhere;
904 my @fargs = @{$filter->args};
905 my $NOT = $filter->negate ? ' NOT' : '';
906 my $fname = $filter->name;
907 $fname = 'item_lang' if $fname eq 'language'; #XXX filter aliases
910 "attrs->'%s'$NOT IN (%s)", $fname,
911 join(',', map { $self->QueryParser->quote_value($_) } @fargs)
914 warn "flatten(): filter where => $fwhere\n"
915 if $self->QueryParser->debug;
917 warn "flatten(): full filter where => $fwhere\n" if $self->QueryParser->debug;
919 return { rank_list => \@rank_list, from => $from, where => $where.')', with => $with, fwhere => $fwhere };
923 #-------------------------------
924 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::filter;
925 use base 'QueryParser::query_plan::filter';
927 #-------------------------------
928 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::facet;
929 use base 'QueryParser::query_plan::facet';
933 my ($classname) = split '\|', $self->name;
939 return 'metabib.' . $self->classname . '_field_entry';
944 my ($classname,@fields) = split '\|', $self->name;
951 my $table_alias = "$self";
952 $table_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
953 $table_alias .= '_' . $self->name;
954 $table_alias =~ s/\|/_/go;
960 #-------------------------------
961 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::modifier;
962 use base 'QueryParser::query_plan::modifier';
964 #-------------------------------
965 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::node::atom;
966 use base 'QueryParser::query_plan::node::atom';
972 $self->{sql} = $sql if ($sql);
974 return $self->{sql} if ($self->{sql});
975 return $self->buildSQL;
981 my $classname = $self->node->classname;
983 return $self->sql("to_tsquery('$classname','')") if $self->{dummy};
985 my $normalizers = $self->node->plan->QueryParser->query_normalizers( $classname );
986 my $fields = $self->node->fields;
988 $fields = $self->node->plan->QueryParser->search_fields->{$classname} if (!@$fields);
992 for my $field (@$fields) {
993 for my $nfield (keys %$normalizers) {
994 for my $nizer ( @{$$normalizers{$nfield}} ) {
995 if ($field eq $nfield) {
996 my $param_string = OpenSRF::Utils::JSON->perl2JSON($nizer->{params});
997 if (!exists($norms{$nizer->{function}.$param_string})) {
998 $norms{$nizer->{function}.$param_string} = {p=>$pos++,n=>$nizer};
1005 my $sql = $self->node->plan->QueryParser->quote_value($self->content);
1007 for my $n ( map { $$_{n} } sort { $$a{p} <=> $$b{p} } values %norms ) {
1008 $sql = join(', ', $sql, map { $self->node->plan->QueryParser->quote_value($_) } @{ $n->{params} });
1009 $sql = $n->{function}."($sql)";
1012 my $prefix = $self->prefix || '';
1013 my $suffix = $self->suffix || '';
1015 $prefix = "'$prefix' ||" if $prefix;
1017 my $suffix_after = '';
1019 $suffix_op = ":$suffix" if $suffix;
1020 $suffix_after = "|| '$suffix_op'" if $suffix;
1022 $sql = "to_tsquery('$classname', COALESCE(NULLIF($prefix '(' || btrim(regexp_replace($sql,E'(?:\\\\s+|:)','$suffix_op&','g'),'&|') $suffix_after || ')', '()'), ''))";
1024 return $self->sql($sql);
1027 #-------------------------------
1028 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::node;
1029 use base 'QueryParser::query_plan::node';
1034 $self->{dummy_count} = 0;
1036 my $atoms = $self->query_atoms;
1038 for my $a (@$atoms) {
1039 push(@only_atoms, $a) if (ref($a) && $a->isa('QueryParser::query_plan::node::atom'));
1040 $self->{dummy_count}++ if (ref($a) && $a->{dummy});
1043 return \@only_atoms;
1048 return $self->{dummy_count};
1054 $self->{table} = $table if ($table);
1055 return $self->{table} if $self->{table};
1056 return $self->table( 'metabib.' . $self->classname . '_field_entry' );
1061 my $table_alias = shift;
1062 $self->{table_alias} = $table_alias if ($table_alias);
1063 return $self->{table_alias} if ($self->{table_alias});
1065 $table_alias = "$self";
1066 $table_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
1067 $table_alias .= '_' . $self->requested_class;
1068 $table_alias =~ s/\|/_/go;
1070 return $self->table_alias( $table_alias );
1075 return $self->{tsquery} if ($self->{tsquery});
1077 for my $atom (@{$self->query_atoms}) {
1079 $self->{tsquery} .= "\n${spc}${spc}${spc}" .$atom->sql;
1081 $self->{tsquery} .= $atom x 2;
1085 return $self->{tsquery};
1091 my $rank_norm_map = $self->plan->QueryParser->custom_data->{rank_cd_weight_map};
1093 my $cover_density = 0;
1094 for my $norm ( keys %$rank_norm_map) {
1095 $cover_density += $$rank_norm_map{$norm} if ($self->plan->find_modifier($norm));
1098 return $self->{rank} if ($self->{rank});
1099 return $self->{rank} = 'ts_rank_cd(' . $self->table_alias . '.index_vector, ' . $self->table_alias . ".tsq, $cover_density)";