4 package OpenILS::Application::Storage::Driver::Pg::QueryParser;
5 use OpenILS::Application::Storage::QueryParser;
6 use base 'QueryParser';
7 use OpenSRF::Utils qw/:datetime/;
8 use OpenSRF::Utils::JSON;
9 use OpenILS::Application::AppUtils;
10 use OpenILS::Utils::CStoreEditor;
11 my $U = 'OpenILS::Application::AppUtils';
14 sub subquery_callback {
15 my ($invocant, $self, $struct, $filter, $params, $negate) = @_;
17 return sprintf(' ((%s)) ',
23 OpenILS::Utils::CStoreEditor
25 ->search_actor_search_query({ id => $params })
31 sub filter_group_entry_callback {
32 my ($invocant, $self, $struct, $filter, $params, $negate) = @_;
34 return sprintf(' saved_query(%s)',
40 OpenILS::Utils::CStoreEditor
42 ->search_actor_search_filter_group_entry({ id => $params })
49 my ($invocant, $self, $struct, $filter, $params, $negate) = @_;
52 my $negate_flag = ($negate ? '-' : '');
54 for my $param (@$params) {
55 my ($t,$f) = split('-', $param);
57 $treturn .= 'item_type(' . join(',',split('', $t)) . ')' if ($t);
58 $treturn .= ' ' if ($t and $f);
59 $treturn .= 'item_form(' . join(',',split('', $f)) . ')' if ($f);
60 $treturn = '(' . $treturn . ')' if ($t and $f);
61 push(@returns, $treturn) if $treturn;
63 $return = join(' || ', @returns);
64 $return = '(' . $return . ')' if(@returns > 1);
65 $return = $negate_flag.$return if($return);
73 if ($value =~ /^\d/) { # may have to use non-$ quoting
75 $value =~ s/\\/\\\\/g;
78 return "\$_$$\$$value\$_$$\$";
81 sub quote_phrase_value {
86 my $left_anchored = '';
87 my $right_anchored = '';
88 $left_anchored = $1 if $value =~ m/^([*\^])/;
89 $right_anchored = $1 if $value =~ m/([*\$])$/;
90 $value =~ s/^[*\^]// if $left_anchored;
91 $value =~ s/[*\$]$// if $right_anchored;
92 $value = quotemeta($value);
93 $value = '^' . $value if $left_anchored eq '^';
94 $value = "$value\$" if $right_anchored eq '$';
95 $value = '[[:<:]]' . $value if $wb && !$left_anchored;
96 $value .= '[[:>:]]' if $wb && !$right_anchored;
97 return $self->quote_value($value);
104 sub default_preferred_language {
108 $self->custom_data->{default_preferred_language} = $lang if ($lang);
109 return $self->custom_data->{default_preferred_language};
112 sub default_preferred_language_multiplier {
116 $self->custom_data->{default_preferred_language_multiplier} = $lang if ($lang);
117 return $self->custom_data->{default_preferred_language_multiplier};
123 return 0 unless $self->parse_tree;
124 return 0 if @{$self->parse_tree->filters};
125 return 0 if @{$self->parse_tree->modifiers};
126 for my $node ( @{ $self->parse_tree->query_nodes } ) {
127 return 0 if (!ref($node) && $node eq '|');
128 next unless (ref($node));
129 return 0 if ($node->isa('QueryParser::query_plan'));
137 return $self->parse_tree->toSQL;
140 sub dynamic_filters {
144 $self->custom_data->{dynamic_filters} ||= [];
145 push(@{$self->custom_data->{dynamic_filters}}, $new) if ($new);
146 return $self->custom_data->{dynamic_filters};
149 sub dynamic_sorters {
153 $self->custom_data->{dynamic_sorters} ||= [];
154 push(@{$self->custom_data->{dynamic_sorters}}, $new) if ($new);
155 return $self->custom_data->{dynamic_sorters};
158 sub facet_field_id_map {
162 $self->custom_data->{facet_field_id_map} ||= {};
163 $self->custom_data->{facet_field_id_map} = $map if ($map);
164 return $self->custom_data->{facet_field_id_map};
167 sub add_facet_field_id_map {
174 $self->add_facet_field( $class => $field );
175 $self->facet_field_id_map->{by_id}{$id} = { classname => $class, field => $field, weight => $weight };
176 $self->facet_field_id_map->{by_class}{$class}{$field} = $id;
179 by_id => { $id => { classname => $class, field => $field, weight => $weight } },
180 by_class => { $class => { $field => $id } }
184 sub facet_field_class_by_id {
188 return $self->facet_field_id_map->{by_id}{$id};
191 sub facet_field_ids_by_class {
196 return undef unless ($class);
199 return [$self->facet_field_id_map->{by_class}{$class}{$field}];
202 return [values( %{ $self->facet_field_id_map->{by_class}{$class} } )];
205 sub search_field_id_map {
209 $self->custom_data->{search_field_id_map} ||= {};
210 $self->custom_data->{search_field_id_map} = $map if ($map);
211 return $self->custom_data->{search_field_id_map};
214 sub add_search_field_id_map {
220 my $combined = shift;
222 $self->add_search_field( $class => $field );
223 $self->search_field_id_map->{by_id}{$id} = { classname => $class, field => $field, weight => $weight };
224 $self->search_field_id_map->{by_class}{$class}{$field} = $id;
227 by_id => { $id => { classname => $class, field => $field, weight => $weight } },
228 by_class => { $class => { $field => $id } }
232 sub search_field_class_by_id {
236 return $self->search_field_id_map->{by_id}{$id};
239 sub search_field_ids_by_class {
244 return undef unless ($class);
247 return [$self->search_field_id_map->{by_class}{$class}{$field}];
250 return [values( %{ $self->search_field_id_map->{by_class}{$class} } )];
253 sub relevance_bumps {
257 $self->custom_data->{rel_bumps} ||= {};
258 $self->custom_data->{rel_bumps} = $bumps if ($bumps);
259 return $self->custom_data->{rel_bumps};
262 sub find_relevance_bumps {
267 return $self->relevance_bumps->{$class}{$field};
270 sub add_relevance_bump {
275 my $multiplier = shift;
278 if (defined($active) and $active eq 'f') {
284 $self->relevance_bumps->{$class}{$field}{$type} = { multiplier => $multiplier, active => $active };
286 return { $class => { $field => { $type => { multiplier => $multiplier, active => $active } } } };
289 sub search_class_weights {
292 my $a_weight = shift;
293 my $b_weight = shift;
294 my $c_weight = shift;
295 my $d_weight = shift;
297 $self->custom_data->{class_weights} ||= {};
298 # Note: This reverses the A-D order, putting D first, because that is how the call actually works in PG
299 $self->custom_data->{class_weights}->{$class} ||= [0.1, 0.2, 0.4, 1.0];
300 $self->custom_data->{class_weights}->{$class} = [$d_weight, $c_weight, $b_weight, $a_weight] if $a_weight;
301 return $self->custom_data->{class_weights}->{$class};
304 sub search_class_combined {
309 $self->custom_data->{class_combined} ||= {};
310 # Note: This reverses the A-D order, putting D first, because that is how the call actually works in PG
311 $self->custom_data->{class_combined}->{$class} ||= 0;
312 $self->custom_data->{class_combined}->{$class} = 1 if $c && $c =~ /^(?:t|y|1)/i;
313 return $self->custom_data->{class_combined}->{$class};
316 sub class_ts_config {
319 my $lang = shift || 'DEFAULT';
321 my $ts_config = shift;
323 $self->custom_data->{class_ts_config} ||= {};
324 $self->custom_data->{class_ts_config}->{$class} ||= {};
325 $self->custom_data->{class_ts_config}->{$class}->{$lang} ||= {};
326 $self->custom_data->{class_ts_config}->{$class}->{$lang}->{normal} ||= [];
327 $self->custom_data->{class_ts_config}->{$class}->{$lang}->{always} ||= [];
328 $self->custom_data->{class_ts_config}->{$class}->{'DEFAULT'} ||= {};
329 $self->custom_data->{class_ts_config}->{$class}->{'DEFAULT'}->{normal} ||= [];
330 $self->custom_data->{class_ts_config}->{$class}->{'DEFAULT'}->{always} ||= [];
333 push @{$self->custom_data->{class_ts_config}->{$class}->{$lang}->{normal}}, $ts_config unless $always;
334 push @{$self->custom_data->{class_ts_config}->{$class}->{$lang}->{always}}, $ts_config if $always;
338 push @$return, @{$self->custom_data->{class_ts_config}->{$class}->{$lang}->{always}};
339 push @$return, @{$self->custom_data->{class_ts_config}->{$class}->{$lang}->{normal}} unless $always;
340 if($lang ne 'DEFAULT') {
341 push @$return, @{$self->custom_data->{class_ts_config}->{$class}->{'DEFAULT'}->{always}};
342 push @$return, @{$self->custom_data->{class_ts_config}->{$class}->{'DEFAULT'}->{normal}} unless $always;
347 sub field_ts_config {
351 my $lang = shift || 'DEFAULT';
352 my $ts_config = shift;
354 $self->custom_data->{field_ts_config} ||= {};
355 $self->custom_data->{field_ts_config}->{$class} ||= {};
356 $self->custom_data->{field_ts_config}->{$class}->{$field} ||= {};
357 $self->custom_data->{field_ts_config}->{$class}->{$field}->{$lang} ||= [];
358 $self->custom_data->{field_ts_config}->{$class}->{$field}->{'DEFAULT'} ||= [];
361 push @{$self->custom_data->{field_ts_config}->{$class}->{$field}->{$lang}}, $ts_config;
365 push @$return, @{$self->custom_data->{field_ts_config}->{$class}->{$field}->{$lang}};
366 if($lang ne 'DEFAULT') {
367 push @$return, @{$self->custom_data->{field_ts_config}->{$class}->{$field}->{'DEFAULT'}};
369 # Make it easy on us: Grab any "always" for the class here. If we have none we grab them all.
370 push @$return, @{$self->class_ts_config($class, $lang, scalar(@$return))};
374 sub initialize_search_field_id_map {
376 my $cmf_list = shift;
378 for my $cmf (@$cmf_list) {
379 __PACKAGE__->add_search_field_id_map( $cmf->field_class, $cmf->name, $cmf->id, $cmf->weight ) if ($U->is_true($cmf->search_field));
380 __PACKAGE__->add_facet_field_id_map( $cmf->field_class, $cmf->name, $cmf->id, $cmf->weight ) if ($U->is_true($cmf->facet_field));
383 return $self->search_field_id_map;
386 sub initialize_aliases {
388 my $cmsa_list = shift;
390 for my $cmsa (@$cmsa_list) {
392 __PACKAGE__->add_search_class_alias( $cmsa->field_class, $cmsa->alias );
394 my $c = $self->search_field_class_by_id( $cmsa->field );
395 __PACKAGE__->add_search_field_alias( $cmsa->field_class, $c->{field}, $cmsa->alias );
400 sub initialize_relevance_bumps {
402 my $sra_list = shift;
404 for my $sra (@$sra_list) {
405 my $c = $self->search_field_class_by_id( $sra->field );
406 __PACKAGE__->add_relevance_bump( $c->{classname}, $c->{field}, $sra->bump_type, $sra->multiplier, $sra->active );
409 return $self->relevance_bumps;
412 sub initialize_query_normalizers {
414 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" }] }
416 for my $cmfinm ( @$tree ) {
417 my $field_info = $self->search_field_class_by_id( $cmfinm->field );
418 next unless $field_info;
419 __PACKAGE__->add_query_normalizer( $field_info->{classname}, $field_info->{field}, $cmfinm->norm->func, OpenSRF::Utils::JSON->JSON2perl($cmfinm->params) );
423 sub initialize_dynamic_filters {
425 my $list = shift; # open-ils.cstore.direct.config.record_attr_definition.search.atomic { "id" : { "!=" : null } }
427 for my $crad ( @$list ) {
428 __PACKAGE__->dynamic_filters( __PACKAGE__->add_search_filter( $crad->name ) ) if ($U->is_true($crad->filter));
429 __PACKAGE__->dynamic_sorters( $crad->name ) if ($U->is_true($crad->sorter));
433 sub initialize_filter_normalizers {
435 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" }] }
437 for my $crainm ( @$tree ) {
438 __PACKAGE__->add_filter_normalizer( $crainm->attr, $crainm->norm->func, OpenSRF::Utils::JSON->JSON2perl($crainm->params) );
442 sub initialize_search_class_weights {
446 for my $search_class (@$classes) {
447 __PACKAGE__->search_class_weights( $search_class->name, $search_class->a_weight, $search_class->b_weight, $search_class->c_weight, $search_class->d_weight );
448 __PACKAGE__->search_class_combined( $search_class->name, $search_class->combined );
452 sub initialize_class_ts_config {
454 my $class_entries = shift;
456 for my $search_class_entry (@$class_entries) {
457 __PACKAGE__->class_ts_config($search_class_entry->field_class,$search_class_entry->search_lang,$U->is_true($search_class_entry->always),$search_class_entry->ts_config);
461 sub initialize_field_ts_config {
463 my $field_entries = shift;
464 my $field_objects = shift;
465 my %field_hash = map { $_->id => $_ } @$field_objects;
467 for my $search_field_entry (@$field_entries) {
468 my $field_object = $field_hash{$search_field_entry->metabib_field};
469 __PACKAGE__->field_ts_config($field_object->field_class,$field_object->name,$search_field_entry->search_lang,$search_field_entry->ts_config);
474 sub initialization_complete {
482 return $_complete if ($_complete);
484 # tsearch rank normalization adjustments. see http://www.postgresql.org/docs/9.0/interactive/textsearch-controls.html#TEXTSEARCH-RANKING for details
485 $self->custom_data->{rank_cd_weight_map} = {
486 CD_logDocumentLength => 1,
487 CD_documentLength => 2,
488 CD_meanHarmonic => 4,
490 CD_logUniqueWords => 16,
494 $self->add_search_modifier( $_ ) for (keys %{ $self->custom_data->{rank_cd_weight_map} });
496 $self->initialize_search_field_id_map( $args{config_metabib_field} )
497 if ($args{config_metabib_field});
499 $self->initialize_aliases( $args{config_metabib_search_alias} )
500 if ($args{config_metabib_search_alias});
502 $self->initialize_relevance_bumps( $args{search_relevance_adjustment} )
503 if ($args{search_relevance_adjustment});
505 $self->initialize_query_normalizers( $args{config_metabib_field_index_norm_map} )
506 if ($args{config_metabib_field_index_norm_map});
508 $self->initialize_dynamic_filters( $args{config_record_attr_definition} )
509 if ($args{config_record_attr_definition});
511 $self->initialize_filter_normalizers( $args{config_record_attr_index_norm_map} )
512 if ($args{config_record_attr_index_norm_map});
514 $self->initialize_search_class_weights( $args{config_metabib_class} )
515 if ($args{config_metabib_class});
517 $self->initialize_class_ts_config( $args{config_metabib_class_ts_map} )
518 if ($args{config_metabib_class_ts_map});
520 $self->initialize_field_ts_config( $args{config_metabib_field_ts_map}, $args{config_metabib_field} )
521 if ($args{config_metabib_field_ts_map} && $args{config_metabib_field});
524 $args{config_metabib_field_index_norm_map} &&
525 $args{search_relevance_adjustment} &&
526 $args{config_metabib_search_alias} &&
527 $args{config_metabib_field} &&
528 $args{config_record_attr_definition}
536 __PACKAGE__->allow_nested_modifiers(1);
538 __PACKAGE__->add_search_field_id_map( series => seriestitle => 1 => 1 );
540 __PACKAGE__->add_search_field_id_map( series => seriestitle => 1 => 1 );
541 __PACKAGE__->add_relevance_bump( series => seriestitle => first_word => 1.5 );
542 __PACKAGE__->add_relevance_bump( series => seriestitle => full_match => 20 );
544 __PACKAGE__->add_search_field_id_map( title => abbreviated => 2 => 1 );
545 __PACKAGE__->add_relevance_bump( title => abbreviated => first_word => 1.5 );
546 __PACKAGE__->add_relevance_bump( title => abbreviated => full_match => 20 );
548 __PACKAGE__->add_search_field_id_map( title => translated => 3 => 1 );
549 __PACKAGE__->add_relevance_bump( title => translated => first_word => 1.5 );
550 __PACKAGE__->add_relevance_bump( title => translated => full_match => 20 );
552 __PACKAGE__->add_search_field_id_map( title => proper => 6 => 1 );
553 __PACKAGE__->add_query_normalizer( title => proper => 'search_normalize' );
554 __PACKAGE__->add_relevance_bump( title => proper => first_word => 1.5 );
555 __PACKAGE__->add_relevance_bump( title => proper => full_match => 20 );
556 __PACKAGE__->add_relevance_bump( title => proper => word_order => 10 );
558 __PACKAGE__->add_search_field_id_map( author => corporate => 7 => 1 );
559 __PACKAGE__->add_relevance_bump( author => corporate => first_word => 1.5 );
560 __PACKAGE__->add_relevance_bump( author => corporate => full_match => 20 );
562 __PACKAGE__->add_facet_field_id_map( author => personal => 8 => 1 );
564 __PACKAGE__->add_search_field_id_map( author => personal => 8 => 1 );
565 __PACKAGE__->add_relevance_bump( author => personal => first_word => 1.5 );
566 __PACKAGE__->add_relevance_bump( author => personal => full_match => 20 );
567 __PACKAGE__->add_query_normalizer( author => personal => 'search_normalize' );
568 __PACKAGE__->add_query_normalizer( author => personal => 'split_date_range' );
570 __PACKAGE__->add_facet_field_id_map( subject => topic => 14 => 1 );
572 __PACKAGE__->add_search_field_id_map( subject => topic => 14 => 1 );
573 __PACKAGE__->add_relevance_bump( subject => topic => first_word => 1 );
574 __PACKAGE__->add_relevance_bump( subject => topic => full_match => 1 );
576 __PACKAGE__->add_search_field_id_map( subject => complete => 16 => 1 );
577 __PACKAGE__->add_relevance_bump( subject => complete => first_word => 1 );
578 __PACKAGE__->add_relevance_bump( subject => complete => full_match => 1 );
580 __PACKAGE__->add_search_field_id_map( keyword => keyword => 15 => 1 );
581 __PACKAGE__->add_relevance_bump( keyword => keyword => first_word => 1 );
582 __PACKAGE__->add_relevance_bump( keyword => keyword => full_match => 1 );
584 __PACKAGE__->class_ts_config( 'series', undef, 1, 'english_nostop' );
585 __PACKAGE__->class_ts_config( 'title', undef, 1, 'english_nostop' );
586 __PACKAGE__->class_ts_config( 'author', undef, 1, 'english_nostop' );
587 __PACKAGE__->class_ts_config( 'subject', undef, 1, 'english_nostop' );
588 __PACKAGE__->class_ts_config( 'keyword', undef, 1, 'english_nostop' );
589 __PACKAGE__->class_ts_config( 'series', undef, 1, 'simple' );
590 __PACKAGE__->class_ts_config( 'title', undef, 1, 'simple' );
591 __PACKAGE__->class_ts_config( 'author', undef, 1, 'simple' );
592 __PACKAGE__->class_ts_config( 'subject', undef, 1, 'simple' );
593 __PACKAGE__->class_ts_config( 'keyword', undef, 1, 'simple' );
595 # French! To test language limiters
596 __PACKAGE__->class_ts_config( 'series', 'fre', 1, 'french_nostop' );
597 __PACKAGE__->class_ts_config( 'title', 'fre', 1, 'french_nostop' );
598 __PACKAGE__->class_ts_config( 'author', 'fre', 1, 'french_nostop' );
599 __PACKAGE__->class_ts_config( 'subject', 'fre', 1, 'french_nostop' );
600 __PACKAGE__->class_ts_config( 'keyword', 'fre', 1, 'french_nostop' );
602 # Not a default config by any means, but good for some testing
603 __PACKAGE__->field_ts_config( 'author', 'personal', 'eng', 'english' );
604 __PACKAGE__->field_ts_config( 'author', 'personal', 'fre', 'french' );
606 __PACKAGE__->add_search_class_alias( keyword => 'kw' );
607 __PACKAGE__->add_search_class_alias( title => 'ti' );
608 __PACKAGE__->add_search_class_alias( author => 'au' );
609 __PACKAGE__->add_search_class_alias( author => 'name' );
610 __PACKAGE__->add_search_class_alias( author => 'dc.contributor' );
611 __PACKAGE__->add_search_class_alias( subject => 'su' );
612 __PACKAGE__->add_search_class_alias( subject => 'bib.subject(?:Title|Place|Occupation)' );
613 __PACKAGE__->add_search_class_alias( series => 'se' );
614 __PACKAGE__->add_search_class_alias( keyword => 'dc.identifier' );
616 __PACKAGE__->add_query_normalizer( author => corporate => 'search_normalize' );
617 __PACKAGE__->add_query_normalizer( keyword => keyword => 'search_normalize' );
619 __PACKAGE__->add_search_field_alias( subject => name => 'bib.subjectName' );
623 __PACKAGE__->default_search_class( 'keyword' );
625 # implements EG-specific stored subqueries
626 __PACKAGE__->add_search_filter( 'saved_query', sub { return __PACKAGE__->subquery_callback(@_) } );
627 __PACKAGE__->add_search_filter( 'filter_group_entry', sub { return __PACKAGE__->filter_group_entry_callback(@_) } );
629 # will be retained simply for back-compat
630 __PACKAGE__->add_search_filter( 'format', sub { return __PACKAGE__->format_callback(@_) } );
632 # grumble grumble, special cases against date1 and date2
633 __PACKAGE__->add_search_filter( 'before' );
634 __PACKAGE__->add_search_filter( 'after' );
635 __PACKAGE__->add_search_filter( 'between' );
636 __PACKAGE__->add_search_filter( 'during' );
638 # various filters for limiting in various ways
639 __PACKAGE__->add_search_filter( 'edit_date' );
640 __PACKAGE__->add_search_filter( 'create_date' );
641 __PACKAGE__->add_search_filter( 'statuses' );
642 __PACKAGE__->add_search_filter( 'locations' );
643 __PACKAGE__->add_search_filter( 'location_groups' );
644 __PACKAGE__->add_search_filter( 'bib_source' );
645 __PACKAGE__->add_search_filter( 'site' );
646 __PACKAGE__->add_search_filter( 'pref_ou' );
647 __PACKAGE__->add_search_filter( 'lasso' );
648 __PACKAGE__->add_search_filter( 'my_lasso' );
649 __PACKAGE__->add_search_filter( 'depth' );
650 __PACKAGE__->add_search_filter( 'language' );
651 __PACKAGE__->add_search_filter( 'offset' );
652 __PACKAGE__->add_search_filter( 'limit' );
653 __PACKAGE__->add_search_filter( 'check_limit' );
654 __PACKAGE__->add_search_filter( 'skip_check' );
655 __PACKAGE__->add_search_filter( 'superpage' );
656 __PACKAGE__->add_search_filter( 'superpage_size' );
657 __PACKAGE__->add_search_filter( 'estimation_strategy' );
658 __PACKAGE__->add_search_modifier( 'available' );
659 __PACKAGE__->add_search_modifier( 'staff' );
660 __PACKAGE__->add_search_modifier( 'deleted' );
661 __PACKAGE__->add_search_modifier( 'lucky' );
663 # Start from container data (bre, acn, acp): container(bre,bookbag,123,deadb33fdeadb33fdeadb33fdeadb33f)
664 __PACKAGE__->add_search_filter( 'container' );
666 # Start from a list of record ids, either bre or metarecords, depending on the #metabib modifier
667 __PACKAGE__->add_search_filter( 'record_list' );
669 __PACKAGE__->add_search_filter( 'has_browse_entry' );
671 # used internally, but generally not user-settable
672 __PACKAGE__->add_search_filter( 'preferred_language' );
673 __PACKAGE__->add_search_filter( 'preferred_language_weight' );
674 __PACKAGE__->add_search_filter( 'preferred_language_multiplier' );
675 __PACKAGE__->add_search_filter( 'core_limit' );
677 # XXX Valid values to be supplied by SVF
678 __PACKAGE__->add_search_filter( 'sort' );
680 # modifies core query, not configurable
681 __PACKAGE__->add_search_modifier( 'descending' );
682 __PACKAGE__->add_search_modifier( 'ascending' );
683 __PACKAGE__->add_search_modifier( 'nullsfirst' );
684 __PACKAGE__->add_search_modifier( 'nullslast' );
685 __PACKAGE__->add_search_modifier( 'metarecord' );
686 __PACKAGE__->add_search_modifier( 'metabib' );
689 #-------------------------------
690 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan;
691 use base 'QueryParser::query_plan';
692 use OpenSRF::Utils::Logger qw($logger);
693 use OpenSRF::Utils qw/:datetime/;
695 use OpenILS::Application::AppUtils;
696 my $apputils = "OpenILS::Application::AppUtils";
698 our %_dfilter_controlled_cache = ();
699 our %_dfilter_stats_cache = ();
700 our $_pg_version = 0;
702 sub dynamic_filter_compile {
703 my ($self, $filter, $params, $negate) = @_;
704 my $e = OpenILS::Utils::CStoreEditor->new;
706 $negate = $negate ? '!' : '';
709 ($_pg_version = $e->json_query({from => ['version']})->[0]->{version}) =~ s/^.+?(\d\.\d).+$/$1/;
713 if ($_pg_version >= 9.2) {
714 if (!scalar keys %_dfilter_stats_cache) {
715 my $data = $e->json_query({from => ['evergreen.pg_statistics', 'record_attr_vector_list', 'vlist']});
716 %_dfilter_stats_cache = map {
717 ( $_->{element}, $_->{frequency} )
718 } grep { $_->{frequency} > 5 } @$data; # Pin floor to 5% of the table
721 $common = 1; # Assume it's expensive
724 if (!exists($_dfilter_controlled_cache{$filter})) {
725 my $crad = $e->retrieve_config_record_attr_definition($filter);
726 my $ccvm_list = $e->search_config_coded_value_map({ctype =>$filter});
728 $_dfilter_controlled_cache{$filter} = $crad->to_bare_hash;
729 $_dfilter_controlled_cache{$filter}{controlled} = scalar @$ccvm_list;
732 my $method = $_dfilter_controlled_cache{$filter}{controlled} ?
733 'search_config_coded_value_map' : 'search_metabib_uncontrolled_record_attr_value';
734 my $attr_field = $_dfilter_controlled_cache{$filter}{controlled} ?
736 my $value_field = $_dfilter_controlled_cache{$filter}{controlled} ?
739 my $attr_objects = $e->$method({ $attr_field => $filter, $value_field => $params });
740 $common = scalar(grep { exists($_dfilter_stats_cache{$_->id}) } @$attr_objects) unless $common;
742 return (sprintf('%s(%s)', $negate,
745 map { $_->id } @$attr_objects
755 for my $f ( qw/preferred_language preferred_language_multiplier preferred_language_weight core_limit check_limit skip_check superpage superpage_size/ ) {
757 $col = 'preferred_language_multiplier' if ($f eq 'preferred_language_weight');
758 my ($filter) = $self->find_filter($f);
759 if ($filter and @{$filter->args}) {
760 $filters{$col} = $filter->args->[0];
764 $self->QueryParser->superpage($filters{superpage}) if ($filters{superpage});
765 $self->QueryParser->superpage_size($filters{superpage_size}) if ($filters{superpage_size});
766 $self->QueryParser->core_limit($filters{core_limit}) if ($filters{core_limit});
768 $logger->debug("Query plan:\n".Dumper($self));
770 my $flat_plan = $self->flatten;
772 # generate the relevance ranking
773 my $rel = '1'; # Default to something simple in case rank_list is empty.
774 if (@{$$flat_plan{rank_list}}) {
777 . join(")\n" . ${spc} x 5 . "+ (", @{$$flat_plan{rank_list}})
779 . ${spc} x 4 . ")+1";
782 # find any supplied sort option
783 my ($sort_filter) = $self->find_filter('sort');
785 $sort_filter = $sort_filter->args->[0];
787 $sort_filter = 'rel';
791 if (($filters{preferred_language} || $self->QueryParser->default_preferred_language) && ($filters{preferred_language_multiplier} || $self->QueryParser->default_preferred_language_multiplier)) {
793 my $pl = $self->QueryParser->quote_value( $filters{preferred_language} ? $filters{preferred_language} : $self->QueryParser->default_preferred_language );
794 $$flat_plan{with} .= ',' if $$flat_plan{with};
795 $$flat_plan{with} .= "lang_with AS (SELECT id FROM config.coded_value_map WHERE ctype = 'item_lang' AND code = $pl)";
796 $lang_join = ",lang_with";
798 my $plw = $filters{preferred_language_multiplier} ? $filters{preferred_language_multiplier} : $self->QueryParser->default_preferred_language_multiplier;
799 $rel = "($rel * COALESCE( NULLIF( FIRST(mrv.vlist \@> ARRAY[lang_with.id]), FALSE )::INT * $plw, 1))";
800 $$flat_plan{uses_mrv} = 1;
802 $rel = "1.0/($rel)::NUMERIC";
805 if ($$flat_plan{uses_mrv}) {
806 $mrv_join = 'INNER JOIN metabib.record_attr_vector_list mrv ON m.source = mrv.source';
810 if ($$flat_plan{uses_mrd}) {
811 $mra_join = 'INNER JOIN metabib.record_attr mrd ON m.source = mrd.id';
814 my $pubdate_join = "LEFT JOIN metabib.record_sorter pubdate_t ON m.source = pubdate_t.source AND attr = 'pubdate'";
817 if ($self->find_modifier('deleted')) {
818 $bre_join = 'INNER JOIN biblio.record_entry bre ON m.source = bre.id AND bre.deleted';
819 # The above suffices for filters too when the #deleted modifier
821 } elsif ($$flat_plan{uses_bre}) {
822 $bre_join = 'INNER JOIN biblio.record_entry bre ON m.source = bre.id';
828 $desc = 'DESC' if ($self->find_modifier('descending'));
830 my $nullpos = 'NULLS LAST';
831 $nullpos = 'NULLS FIRST' if ($self->find_modifier('nullsfirst'));
833 if (grep {$_ eq $sort_filter} @{$self->QueryParser->dynamic_sorters}) {
834 $rank = "FIRST((SELECT value FROM metabib.record_sorter rbr WHERE rbr.source = m.source and attr = '$sort_filter'))"
835 } elsif ($sort_filter eq 'create_date') {
836 $rank = "FIRST((SELECT create_date FROM biblio.record_entry rbr WHERE rbr.id = m.source))";
837 } elsif ($sort_filter eq 'edit_date') {
838 $rank = "FIRST((SELECT edit_date FROM biblio.record_entry rbr WHERE rbr.id = m.source))";
840 # default to rel ranking
844 my $key = 'm.source';
845 $key = 'm.metarecord' if (grep {$_->name eq 'metarecord' or $_->name eq 'metabib'} @{$self->modifiers});
847 my $core_limit = $self->QueryParser->core_limit || 25000;
848 $core_limit = 1 if($self->find_modifier('lucky'));
850 my $flat_where = $$flat_plan{where};
851 if ($flat_where ne '') {
852 $flat_where = "AND (\n" . ${spc} x 5 . $flat_where . "\n" . ${spc} x 4 . ")";
854 my $with = $$flat_plan{with};
855 $with= "\nWITH $with" if $with;
857 # Need an array for query parser db function; this gives a better plan
858 # than the ARRAY_AGG(DISTINCT m.source) option as of PostgreSQL 9.1
859 my $agg_records = 'ARRAY[m.source] AS records';
860 if ($key =~ /metarecord/) {
861 # metarecord searches still require the ARRAY_AGG approach
862 $agg_records = 'ARRAY_AGG(DISTINCT m.source) AS records';
871 FIRST(pubdate_t.value) AS tie_break
872 FROM metabib.metarecord_source_map m
882 ORDER BY 4 $desc $nullpos, 5 DESC $nullpos, 3 DESC
886 warn $sql if $self->QueryParser->debug;
894 die 'ERROR: nesting too deep or boolean list too long' if ($self->plan_level > 40);
896 my $from = shift || '';
897 my $where = shift || '';
904 for my $node ( @{$self->query_nodes} ) {
907 if ($node->isa( 'QueryParser::query_plan::node' )) {
909 unless (@{$node->only_atoms}) {
910 push @rank_list, '1';
915 my $table = $node->table;
916 my $ctable = $node->combined_table;
917 my $talias = $node->table_alias;
919 my $node_rank = 'COALESCE(' . $node->rank . " * ${talias}.weight, 0.0)";
921 $from .= "\n" . ${spc} x 4 ."LEFT JOIN (\n"
922 . ${spc} x 5 . "SELECT fe.*, fe_weight.weight, ${talias}_xq.tsq, ${talias}_xq.tsq_rank /* search */\n"
923 . ${spc} x 6 . "FROM $table AS fe";
924 $from .= "\n" . ${spc} x 7 . "JOIN config.metabib_field AS fe_weight ON (fe_weight.id = fe.field)";
928 if (@{$node->fields} > 0) {
929 @bump_fields = @{$node->fields};
931 @field_ids = grep defined, (
933 $self->QueryParser->search_field_ids_by_class(
939 @bump_fields = @{$self->QueryParser->search_fields->{$node->classname}};
942 if ($node->dummy_count < @{$node->only_atoms} ) {
943 $with .= ",\n " if $with;
944 $with .= "${talias}_xq AS (SELECT ". $node->tsquery ." AS tsq,". $node->tsquery_rank ." AS tsq_rank )";
945 if ($node->combined_search) {
946 $from .= "\n" . ${spc} x 6 . "JOIN $ctable AS com ON (com.record = fe.source";
948 $from .= " AND com.metabib_field IN (" . join(',',@field_ids) . "))";
950 $from .= " AND com.metabib_field IS NULL)";
952 $from .= "\n" . ${spc} x 6 . "JOIN ${talias}_xq ON (com.index_vector @@ ${talias}_xq.tsq)";
954 $from .= "\n" . ${spc} x 6 . "JOIN ${talias}_xq ON (fe.index_vector @@ ${talias}_xq.tsq)";
957 $from .= "\n" . ${spc} x 6 . ", (SELECT NULL::tsquery AS tsq, NULL:tsquery AS tsq_rank ) AS ${talias}_xq";
961 $from .= "\n" . ${spc} x 6 . "WHERE fe_weight.id IN (" .
962 join(',', @field_ids) . ")";
965 $from .= "\n" . ${spc} x 4 . ") AS $talias ON (m.source = ${talias}.source)";
970 for my $field ( @bump_fields ) {
971 my $bumps = $self->QueryParser->find_relevance_bumps( $node->classname => $field );
972 for my $b (keys %$bumps) {
973 next if (!$$bumps{$b}{active});
974 next if ($used_bumps{$b});
977 next if ($$bumps{$b}{multiplier} == 1); # optimization to remove unneeded bumps
979 push @bumpmults, $$bumps{$b}{multiplier};
983 if(scalar @bumps > 0 && scalar @{$node->only_positive_atoms} > 0) {
984 # Note: Previous rank function used search_normalize outright. Duplicating that here.
985 $node_rank .= "\n" . ${spc} x 5 . "* evergreen.rel_bump(('{' || quote_literal(search_normalize(";
986 $node_rank .= join(")) || ',' || quote_literal(search_normalize(",map { $self->QueryParser->quote_phrase_value($_->content) } @{$node->only_positive_atoms});
987 $node_rank .= ")) || '}')::TEXT[], " . $node->table_alias . ".value, '{" . join(",",@bumps) . "}'::TEXT[], '{" . join(",",@bumpmults) . "}'::NUMERIC[])";
991 $NOT = 'NOT ' if $node->negate;
993 $where .= "$NOT(" . $talias . ".id IS NOT NULL";
994 if (@{$node->phrases}) {
995 $where .= ' AND ' . join(' AND ', map {
996 "${talias}.value ~* ".$self->QueryParser->quote_phrase_value($_, 1)
997 } @{$node->phrases});
999 for my $atom (@{$node->only_real_atoms}) {
1000 next unless $atom->{content} && $atom->{content} =~ /(^\^|\$$)/;
1001 $where .= " AND ${talias}.value ~* ".$self->QueryParser->quote_phrase_value($atom->{content});
1006 push @rank_list, $node_rank;
1008 } elsif ($node->isa( 'QueryParser::query_plan::facet' )) {
1010 my $talias = $node->table_alias;
1013 if (@{$node->fields} > 0) {
1014 push(@field_ids, $self->QueryParser->facet_field_ids_by_class( $node->classname, $_ )->[0]) for (@{$node->fields});
1016 @field_ids = @{ $self->QueryParser->facet_field_ids_by_class( $node->classname ) };
1019 my $join_type = ($node->negate or !$self->top_plan) ? 'LEFT' : 'INNER';
1020 $from .= "\n${spc}$join_type JOIN /* facet */ metabib.facet_entry $talias ON (\n"
1021 . ${spc} x 2 . "m.source = ${talias}.source\n"
1022 . ${spc} x 2 . "AND SUBSTRING(${talias}.value,1,1024) IN ("
1023 . join(",", map { $self->QueryParser->quote_value($_) } @{$node->values}) . ")\n"
1024 . ${spc} x 2 ."AND ${talias}.field IN (". join(',', @field_ids) . ")\n"
1027 if ($join_type ne 'INNER') {
1028 my $NOT = $node->negate ? '' : ' NOT';
1029 $where .= "${talias}.id IS$NOT NULL";
1030 } elsif ($where ne '') {
1031 # Strip extra joiner
1032 $where =~ s/(\s|\n)+(AND|OR)\s$//;
1036 my $subnode = $node->flatten;
1038 # strip the trailing bool from the previous loop if there is
1039 # nothing to add to the where within this loop.
1040 if ($$subnode{where} eq '') {
1041 $where =~ s/(\s|\n)+(AND|OR)\s$//;
1044 push(@rank_list, @{$$subnode{rank_list}});
1045 $from .= $$subnode{from};
1048 $NOT = 'NOT ' if $node->negate;
1050 if ($$subnode{where} ne '') {
1052 . ${spc} x ($self->plan_level + 6) . $$subnode{where} . "\n"
1053 . ${spc} x ($self->plan_level + 5) . ')';
1056 if ($$subnode{with}) {
1057 $with .= ",\n " if $with;
1058 $with .= $$subnode{with};
1061 $uses_bre = $$subnode{uses_bre};
1062 $uses_mrd = $$subnode{uses_mrd};
1063 $uses_mrv = $$subnode{uses_mrv};
1067 warn "flatten(): appending WHERE bool to: $where\n" if $self->QueryParser->debug;
1070 $where .= "\n" . ${spc} x ( $self->plan_level + 5 ) . 'AND ' if ($node eq '&');
1071 $where .= "\n" . ${spc} x ( $self->plan_level + 5 ) . 'OR ' if ($node eq '|');
1076 my $joiner = "\n" . ${spc} x ( $self->plan_level + 5 ) . ($self->joiner eq '&' ? 'AND ' : 'OR ');
1080 # for each dynamic filter, build more of the WHERE clause
1081 for my $filter (@{$self->filters}) {
1082 my $NOT = $filter->negate ? 'NOT ' : '';
1083 if (grep { $_ eq $filter->name } @{ $self->QueryParser->dynamic_filters }) {
1085 my $fname = $filter->name;
1086 $fname = 'item_lang' if $fname eq 'language'; #XXX filter aliases
1088 warn "flatten(): processing dynamic filter ". $filter->name ."\n"
1089 if $self->QueryParser->debug;
1092 ($vlist_query, $common) = $self->dynamic_filter_compile( $fname, $filter->args, $filter->negate );
1094 # bool joiner for intra-plan nodes/filters
1095 push(@dlist, $self->joiner) if @dlist;
1096 push(@dlist, $vlist_query);
1099 if ($filter->name eq 'before') {
1100 if (@{$filter->args} == 1) {
1101 $where .= $joiner if $where ne '';
1102 $where .= "${NOT}COALESCE(pubdate_t.value <= "
1103 . $self->QueryParser->quote_value($filter->args->[0])
1106 } elsif ($filter->name eq 'after') {
1107 if (@{$filter->args} == 1) {
1108 $where .= $joiner if $where ne '';
1109 $where .= "${NOT}COALESCE(pubdate_t.value >= "
1110 . $self->QueryParser->quote_value($filter->args->[0])
1113 } elsif ($filter->name eq 'during') {
1114 if (@{$filter->args} == 1) {
1115 $where .= $joiner if $where ne '';
1116 $where .= "${NOT}COALESCE("
1117 . $self->QueryParser->quote_value($filter->args->[0])
1118 . " BETWEEN pubdate_t.value AND (mrd.attrs->'date2'), false)";
1121 } elsif ($filter->name eq 'between') {
1122 if (@{$filter->args} == 2) {
1123 $where .= $joiner if $where ne '';
1124 $where .= "${NOT}COALESCE(pubdate_t.value BETWEEN "
1125 . $self->QueryParser->quote_value($filter->args->[0])
1127 . $self->QueryParser->quote_value($filter->args->[1])
1130 } elsif ($filter->name eq 'container') {
1131 if (@{$filter->args} >= 3) {
1132 my ($class, $ctype, $cid, $token) = @{$filter->args};
1135 my $rec_field = 'ci.target_biblio_record_entry';
1136 if ($class eq 'bre') {
1137 $class = 'biblio_record_entry';
1138 } elsif ($class eq 'acn') {
1139 $class = 'call_number';
1140 $rec_field = 'cn.record';
1141 $rec_join = 'JOIN asset.call_number cn ON (ci.target_call_number = cn.id)';
1142 } elsif ($class eq 'acp') {
1144 $rec_field = 'cn.record';
1145 $rec_join = 'JOIN asset.copy cp ON (ci.target_copy = cp.id) JOIN asset.call_number cn ON (cp.call_number = cn.id)';
1151 my ($u,$e) = $apputils->checksesperm($token) if ($token);
1152 $perm_join = ' OR c.owner = ' . $u->id if ($u && !$e);
1154 my $filter_alias = "$filter";
1155 $filter_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
1156 $filter_alias =~ s/\|/_/go;
1158 $with .= ",\n " if $with;
1159 $with .= "container_${filter_alias} AS (\n";
1160 $with .= " SELECT $rec_field AS record FROM container.${class}_bucket_item ci\n"
1161 . " JOIN container.${class}_bucket c ON (c.id = ci.bucket) $rec_join\n"
1162 . " WHERE c.btype = " . $self->QueryParser->quote_value($ctype) . "\n"
1163 . " AND c.id = " . $self->QueryParser->quote_value($cid) . "\n"
1164 . " AND (c.pub IS TRUE$perm_join)\n";
1165 if ($class eq 'copy') {
1167 . " SELECT pr.peer_record AS record FROM container.copy_bucket_item ci\n"
1168 . " JOIN container.copy_bucket c ON (c.id = ci.bucket)\n"
1169 . " JOIN biblio.peer_bib_copy_map pr ON ci.target_copy = pr.target_copy\n"
1170 . " WHERE c.btype = " . $self->QueryParser->quote_value($ctype) . "\n"
1171 . " AND c.id = " . $self->QueryParser->quote_value($cid) . "\n"
1172 . " AND (c.pub IS TRUE$perm_join)\n";
1176 my $optimize_join = 1 if $self->top_plan and !$NOT;
1177 $from .= "\n" . ${spc} x 3 . ( $optimize_join ? 'INNER' : 'LEFT') . " JOIN container_${filter_alias} ON container_${filter_alias}.record = m.source";
1179 if (!$optimize_join) {
1180 $where .= $joiner if $where ne '';
1181 $where .= "(container_${filter_alias} IS " . ( $NOT ? 'NULL)' : 'NOT NULL)');
1185 } elsif ($filter->name eq 'record_list') {
1186 if (@{$filter->args} > 0) {
1187 my $key = 'm.source';
1188 $key = 'm.metarecord' if (grep {$_->name eq 'metarecord' or $_->name eq 'metabib'} @{$self->QueryParser->parse_tree->modifiers});
1189 $where .= $joiner if $where ne '';
1190 $where .= "$key ${NOT}IN (" . join(',', map { $self->QueryParser->quote_value($_) } @{$filter->args}) . ')';
1193 } elsif ($filter->name eq 'has_browse_entry') {
1194 if (@{$filter->args} >= 2) {
1195 my $entry = int(shift @{$filter->args});
1196 my $fields = join(",", map(int, @{$filter->args}));
1197 $from .= "\n" . $spc x 3 . sprintf("INNER JOIN metabib.browse_entry_def_map mbedm ON (mbedm.source = m.source AND mbedm.entry = %d AND mbedm.def IN (%s))", $entry, $fields);
1199 } elsif ($filter->name eq 'edit_date' or $filter->name eq 'create_date') {
1200 # bre.create_date and bre.edit_date filtering
1201 my $datefilter = $filter->name;
1205 if ($filter && $filter->args && scalar(@{$filter->args}) > 0 && scalar(@{$filter->args}) < 3) {
1206 my ($cstart, $cend) = @{$filter->args};
1208 if (!$cstart and !$cend) {
1209 # useless use of filter
1210 } elsif (!$cstart or $cstart eq '-infinity') { # no start supplied
1211 if ($cend eq 'infinity') {
1212 # useless use of filter
1215 $cend = cleanse_ISO8601($cend);
1216 $where .= $joiner if $where ne '';
1217 $where .= "bre.$datefilter <= \$_$$\$$cend\$_$$\$";
1220 } elsif (!$cend or $cend eq 'infinity') { # no end supplied
1221 if ($cstart eq '-infinity') {
1222 # useless use of filter
1223 } else { # "after $cstart"
1224 $cstart = cleanse_ISO8601($cstart);
1225 $where .= $joiner if $where ne '';
1226 $where .= "bre.$datefilter >= \$_$$\$$cstart\$_$$\$";
1228 } else { # both supplied
1229 # "between $cstart and $cend"
1230 $cstart = cleanse_ISO8601($cstart);
1231 $cend = cleanse_ISO8601($cend);
1232 $where .= $joiner if $where ne '';
1233 $where .= "bre.$datefilter BETWEEN \$_$$\$$cstart\$_$$\$ AND \$_$$\$$cend\$_$$\$";
1236 } elsif ($filter->name eq 'bib_source') {
1239 if (@{$filter->args} > 0) {
1240 $where .= $joiner if $where ne '';
1241 $where .= "${NOT}COALESCE(bre.source IN ("
1242 . join(',', map { $self->QueryParser->quote_value($_) } @{ $filter->args })
1251 $where .= $joiner if $where ne '';
1252 if ($common) { # Use a function wrapper to inform PG of the non-rareness of one or more filter elements
1254 'evergreen.query_int_wrapper(mrv.vlist, \'%s\')',
1259 'mrv.vlist @@ \'%s\'',
1265 warn "flatten(): full filter where => $where\n" if $self->QueryParser->debug;
1268 rank_list => \@rank_list,
1272 uses_bre => $uses_bre,
1273 uses_mrv => $uses_mrv,
1274 uses_mrd => $uses_mrd
1279 #-------------------------------
1280 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::filter;
1281 use base 'QueryParser::query_plan::filter';
1283 #-------------------------------
1284 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::facet;
1285 use base 'QueryParser::query_plan::facet';
1289 my ($classname) = split '\|', $self->name;
1295 my ($classname,@fields) = split '\|', $self->name;
1302 my $table_alias = "$self";
1303 $table_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
1304 $table_alias .= '_' . $self->name;
1305 $table_alias =~ s/\|/_/go;
1307 return $table_alias;
1311 #-------------------------------
1312 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::modifier;
1313 use base 'QueryParser::query_plan::modifier';
1315 #-------------------------------
1316 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::node::atom;
1317 use base 'QueryParser::query_plan::node::atom';
1323 $self->{sql} = $sql if ($sql);
1325 return $self->{sql} if ($self->{sql});
1326 return $self->buildSQL;
1332 my $classname = $self->node->classname;
1334 return $self->sql("to_tsquery('$classname','')") if $self->{dummy};
1336 my $normalizers = $self->node->plan->QueryParser->query_normalizers( $classname );
1337 my $fields = $self->node->fields;
1340 my $filter = $self->node->plan->find_filter('preferred_language');
1341 $lang ||= $filter->args->[0] if ($filter && $filter->args);
1342 $lang ||= $self->node->plan->QueryParser->default_preferred_language;
1343 my $ts_configs = [];
1345 if (@{$self->node->phrases}) {
1346 # We assume we want 'simple' for phrases. Gives us less to match against later.
1347 $ts_configs = ['simple'];
1350 $ts_configs = $self->node->plan->QueryParser->class_ts_config($classname, $lang);
1352 for my $field (@$fields) {
1353 push @$ts_configs, @{$self->node->plan->QueryParser->field_ts_config($classname, $field, $lang)};
1356 $ts_configs = [keys %{{map { $_ => 1 } @$ts_configs}}];
1359 # Assume we want exact if none otherwise provided.
1360 # Because we can reasonably expect this to exist
1361 $ts_configs = ['simple'] unless (scalar @$ts_configs);
1363 $fields = $self->node->plan->QueryParser->search_fields->{$classname} if (!@$fields);
1367 for my $field (@$fields) {
1368 for my $nfield (keys %$normalizers) {
1369 for my $nizer ( @{$$normalizers{$nfield}} ) {
1370 if ($field eq $nfield) {
1371 my $param_string = OpenSRF::Utils::JSON->perl2JSON($nizer->{params});
1372 if (!exists($norms{$nizer->{function}.$param_string})) {
1373 $norms{$nizer->{function}.$param_string} = {p=>$pos++,n=>$nizer};
1380 my $sql = $self->node->plan->QueryParser->quote_value($self->content);
1382 for my $n ( map { $$_{n} } sort { $$a{p} <=> $$b{p} } values %norms ) {
1383 $sql = join(', ', $sql, map { $self->node->plan->QueryParser->quote_value($_) } @{ $n->{params} });
1384 $sql = $n->{function}."($sql)";
1387 my $prefix = $self->prefix || '';
1388 my $suffix = $self->suffix || '';
1389 my $joiner = ' || ';
1390 $joiner = ' && ' if $self->prefix eq '!'; # Negative atoms should be "none of the variants" instead of "any of the variants"
1392 $prefix = "'$prefix' ||" if $prefix;
1394 my $suffix_after = '';
1396 $suffix_op = ":$suffix" if $suffix;
1397 $suffix_after = "|| '$suffix_op'" if $suffix;
1400 for my $ts_config (@$ts_configs) {
1401 push @sql_set, "to_tsquery('$ts_config', COALESCE(NULLIF($prefix '(' || btrim(regexp_replace($sql,E'(?:\\\\s+|:)','$suffix_op&','g'),'&|') $suffix_after || ')', '()'), ''))";
1404 $sql = join($joiner, @sql_set);
1405 $sql = '(' . $sql . ')' if (scalar(@$ts_configs) > 1);
1407 return $self->sql($sql);
1410 #-------------------------------
1411 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::node;
1412 use base 'QueryParser::query_plan::node';
1417 $self->{dummy_count} = 0;
1419 my $atoms = $self->query_atoms;
1421 for my $a (@$atoms) {
1422 push(@only_atoms, $a) if (ref($a) && $a->isa('QueryParser::query_plan::node::atom'));
1423 $self->{dummy_count}++ if (ref($a) && $a->{dummy});
1426 return \@only_atoms;
1429 sub only_real_atoms {
1432 my $atoms = $self->query_atoms;
1433 my @only_real_atoms;
1434 for my $a (@$atoms) {
1435 push(@only_real_atoms, $a) if (ref($a) && $a->isa('QueryParser::query_plan::node::atom') && !($a->{dummy}));
1438 return \@only_real_atoms;
1441 sub only_positive_atoms {
1444 my $atoms = $self->query_atoms;
1445 my @only_positive_atoms;
1446 for my $a (@$atoms) {
1447 push(@only_positive_atoms, $a) if (ref($a) && $a->isa('QueryParser::query_plan::node::atom') && !($a->{dummy}) && ($a->{prefix} ne '!'));
1450 return \@only_positive_atoms;
1455 return $self->{dummy_count};
1461 $self->{table} = $table if ($table);
1462 return $self->{table} if $self->{table};
1463 return $self->table( 'metabib.' . $self->classname . '_field_entry' );
1466 sub combined_table {
1469 $self->{ctable} = $ctable if ($ctable);
1470 return $self->{ctable} if $self->{ctable};
1471 return $self->combined_table( 'metabib.combined_' . $self->classname . '_field_entry' );
1474 sub combined_search {
1476 return $self->plan->QueryParser->search_class_combined($self->classname);
1481 my $table_alias = shift;
1482 $self->{table_alias} = $table_alias if ($table_alias);
1483 return $self->{table_alias} if ($self->{table_alias});
1485 $table_alias = "$self";
1486 $table_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
1487 $table_alias .= '_' . $self->requested_class;
1488 $table_alias =~ s/\|/_/go;
1490 return $self->table_alias( $table_alias );
1495 return $self->{tsquery} if ($self->{tsquery});
1497 for my $atom (@{$self->query_atoms}) {
1499 $self->{tsquery} .= "\n" . ${spc} x 3 . $atom->sql;
1501 $self->{tsquery} .= $atom x 2;
1505 return $self->{tsquery};
1510 return $self->{tsquery_rank} if ($self->{tsquery_rank});
1513 for my $atom (@{$self->only_positive_atoms}) {
1514 push @atomlines, "\n" . ${spc} x 3 . $atom->sql;
1516 $self->{tsquery_rank} = join(' ||', @atomlines);
1517 $self->{tsquery_rank} = 'NULL::tsquery' unless $self->{tsquery_rank};
1518 return $self->{tsquery_rank};
1523 return $self->{rank} if ($self->{rank});
1525 my $rank_norm_map = $self->plan->QueryParser->custom_data->{rank_cd_weight_map};
1527 my $cover_density = 0;
1528 for my $norm ( keys %$rank_norm_map) {
1529 $cover_density += $$rank_norm_map{$norm} if ($self->plan->find_modifier($norm));
1532 my $weights = join(', ', @{$self->plan->QueryParser->search_class_weights($self->classname)});
1534 return $self->{rank} = "ts_rank_cd('{" . $weights . "}', " . $self->table_alias . '.index_vector, ' . $self->table_alias . ".tsq_rank, $cover_density)";