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 })
48 sub location_groups_callback {
49 my ($invocant, $self, $struct, $filter, $params, $negate) = @_;
51 return sprintf(' %slocations(%s)',
58 OpenILS::Utils::CStoreEditor
60 ->search_asset_copy_location_group_map({ lgroup => $params })
67 my ($invocant, $self, $struct, $filter, $params, $negate) = @_;
70 my $negate_flag = ($negate ? '-' : '');
72 for my $param (@$params) {
73 my ($t,$f) = split('-', $param);
75 $treturn .= 'item_type(' . join(',',split('', $t)) . ')' if ($t);
76 $treturn .= ' ' if ($t and $f);
77 $treturn .= 'item_form(' . join(',',split('', $f)) . ')' if ($f);
78 $treturn = '(' . $treturn . ')' if ($t and $f);
79 push(@returns, $treturn) if $treturn;
81 $return = join(' || ', @returns);
82 $return = '(' . $return . ')' if(@returns > 1);
83 $return = $negate_flag.$return if($return);
91 if ($value =~ /^\d/) { # may have to use non-$ quoting
93 $value =~ s/\\/\\\\/g;
96 return "\$_$$\$$value\$_$$\$";
99 sub quote_phrase_value {
104 my $left_anchored = '';
105 my $right_anchored = '';
106 $left_anchored = $1 if $value =~ m/^([*\^])/;
107 $right_anchored = $1 if $value =~ m/([*\$])$/;
108 $value =~ s/^[*\^]// if $left_anchored;
109 $value =~ s/[*\$]$// if $right_anchored;
110 $value = quotemeta($value);
111 $value = '^' . $value if $left_anchored eq '^';
112 $value = "$value\$" if $right_anchored eq '$';
113 $value = '[[:<:]]' . $value if $wb && !$left_anchored;
114 $value .= '[[:>:]]' if $wb && !$right_anchored;
115 return $self->quote_value($value);
122 sub default_preferred_language {
126 $self->custom_data->{default_preferred_language} = $lang if ($lang);
127 return $self->custom_data->{default_preferred_language};
130 sub default_preferred_language_multiplier {
134 $self->custom_data->{default_preferred_language_multiplier} = $lang if ($lang);
135 return $self->custom_data->{default_preferred_language_multiplier};
141 return 0 unless $self->parse_tree;
142 return 0 if @{$self->parse_tree->filters};
143 return 0 if @{$self->parse_tree->modifiers};
144 for my $node ( @{ $self->parse_tree->query_nodes } ) {
145 return 0 if (!ref($node) && $node eq '|');
146 next unless (ref($node));
147 return 0 if ($node->isa('QueryParser::query_plan'));
155 return $self->parse_tree->toSQL;
158 sub dynamic_filters {
162 $self->custom_data->{dynamic_filters} ||= [];
163 push(@{$self->custom_data->{dynamic_filters}}, $new) if ($new);
164 return $self->custom_data->{dynamic_filters};
167 sub dynamic_sorters {
171 $self->custom_data->{dynamic_sorters} ||= [];
172 push(@{$self->custom_data->{dynamic_sorters}}, $new) if ($new);
173 return $self->custom_data->{dynamic_sorters};
176 sub facet_field_id_map {
180 $self->custom_data->{facet_field_id_map} ||= {};
181 $self->custom_data->{facet_field_id_map} = $map if ($map);
182 return $self->custom_data->{facet_field_id_map};
185 sub add_facet_field_id_map {
192 $self->add_facet_field( $class => $field );
193 $self->facet_field_id_map->{by_id}{$id} = { classname => $class, field => $field, weight => $weight };
194 $self->facet_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 facet_field_class_by_id {
206 return $self->facet_field_id_map->{by_id}{$id};
209 sub facet_field_ids_by_class {
214 return undef unless ($class);
217 return [$self->facet_field_id_map->{by_class}{$class}{$field}];
220 return [values( %{ $self->facet_field_id_map->{by_class}{$class} } )];
223 sub search_field_id_map {
227 $self->custom_data->{search_field_id_map} ||= {};
228 $self->custom_data->{search_field_id_map} = $map if ($map);
229 return $self->custom_data->{search_field_id_map};
232 sub add_search_field_id_map {
239 $self->add_search_field( $class => $field );
240 $self->search_field_id_map->{by_id}{$id} = { classname => $class, field => $field, weight => $weight };
241 $self->search_field_id_map->{by_class}{$class}{$field} = $id;
244 by_id => { $id => { classname => $class, field => $field, weight => $weight } },
245 by_class => { $class => { $field => $id } }
249 sub search_field_class_by_id {
253 return $self->search_field_id_map->{by_id}{$id};
256 sub search_field_ids_by_class {
261 return undef unless ($class);
264 return [$self->search_field_id_map->{by_class}{$class}{$field}];
267 return [values( %{ $self->search_field_id_map->{by_class}{$class} } )];
270 sub relevance_bumps {
274 $self->custom_data->{rel_bumps} ||= {};
275 $self->custom_data->{rel_bumps} = $bumps if ($bumps);
276 return $self->custom_data->{rel_bumps};
279 sub find_relevance_bumps {
284 return $self->relevance_bumps->{$class}{$field};
287 sub add_relevance_bump {
292 my $multiplier = shift;
295 if (defined($active) and $active eq 'f') {
301 $self->relevance_bumps->{$class}{$field}{$type} = { multiplier => $multiplier, active => $active };
303 return { $class => { $field => { $type => { multiplier => $multiplier, active => $active } } } };
306 sub search_class_weights {
309 my $a_weight = shift;
310 my $b_weight = shift;
311 my $c_weight = shift;
312 my $d_weight = shift;
314 $self->custom_data->{class_weights} ||= {};
315 # Note: This reverses the A-D order, putting D first, because that is how the call actually works in PG
316 $self->custom_data->{class_weights}->{$class} ||= [0.1, 0.2, 0.4, 1.0];
317 $self->custom_data->{class_weights}->{$class} = [$d_weight, $c_weight, $b_weight, $a_weight] if $a_weight;
318 return $self->custom_data->{class_weights}->{$class};
321 sub class_ts_config {
324 my $lang = shift || 'DEFAULT';
326 my $ts_config = shift;
328 $self->custom_data->{class_ts_config} ||= {};
329 $self->custom_data->{class_ts_config}->{$class} ||= {};
330 $self->custom_data->{class_ts_config}->{$class}->{$lang} ||= {};
331 $self->custom_data->{class_ts_config}->{$class}->{$lang}->{normal} ||= [];
332 $self->custom_data->{class_ts_config}->{$class}->{$lang}->{always} ||= [];
333 $self->custom_data->{class_ts_config}->{$class}->{'DEFAULT'} ||= {};
334 $self->custom_data->{class_ts_config}->{$class}->{'DEFAULT'}->{normal} ||= [];
335 $self->custom_data->{class_ts_config}->{$class}->{'DEFAULT'}->{always} ||= [];
338 push @{$self->custom_data->{class_ts_config}->{$class}->{$lang}->{normal}}, $ts_config unless $always;
339 push @{$self->custom_data->{class_ts_config}->{$class}->{$lang}->{always}}, $ts_config if $always;
343 push @$return, @{$self->custom_data->{class_ts_config}->{$class}->{$lang}->{always}};
344 push @$return, @{$self->custom_data->{class_ts_config}->{$class}->{$lang}->{normal}} unless $always;
345 if($lang ne 'DEFAULT') {
346 push @$return, @{$self->custom_data->{class_ts_config}->{$class}->{'DEFAULT'}->{always}};
347 push @$return, @{$self->custom_data->{class_ts_config}->{$class}->{'DEFAULT'}->{normal}} unless $always;
352 sub field_ts_config {
356 my $lang = shift || 'DEFAULT';
357 my $ts_config = shift;
359 $self->custom_data->{field_ts_config} ||= {};
360 $self->custom_data->{field_ts_config}->{$class} ||= {};
361 $self->custom_data->{field_ts_config}->{$class}->{$field} ||= {};
362 $self->custom_data->{field_ts_config}->{$class}->{$field}->{$lang} ||= [];
363 $self->custom_data->{field_ts_config}->{$class}->{$field}->{'DEFAULT'} ||= [];
366 push @{$self->custom_data->{field_ts_config}->{$class}->{$field}->{$lang}}, $ts_config;
370 push @$return, @{$self->custom_data->{field_ts_config}->{$class}->{$field}->{$lang}};
371 if($lang ne 'DEFAULT') {
372 push @$return, @{$self->custom_data->{field_ts_config}->{$class}->{$field}->{'DEFAULT'}};
374 # Make it easy on us: Grab any "always" for the class here. If we have none we grab them all.
375 push @$return, @{$self->class_ts_config($class, $lang, scalar(@$return))};
379 sub initialize_search_field_id_map {
381 my $cmf_list = shift;
383 for my $cmf (@$cmf_list) {
384 __PACKAGE__->add_search_field_id_map( $cmf->field_class, $cmf->name, $cmf->id, $cmf->weight ) if ($U->is_true($cmf->search_field));
385 __PACKAGE__->add_facet_field_id_map( $cmf->field_class, $cmf->name, $cmf->id, $cmf->weight ) if ($U->is_true($cmf->facet_field));
388 return $self->search_field_id_map;
391 sub initialize_aliases {
393 my $cmsa_list = shift;
395 for my $cmsa (@$cmsa_list) {
397 __PACKAGE__->add_search_class_alias( $cmsa->field_class, $cmsa->alias );
399 my $c = $self->search_field_class_by_id( $cmsa->field );
400 __PACKAGE__->add_search_field_alias( $cmsa->field_class, $c->{field}, $cmsa->alias );
405 sub initialize_relevance_bumps {
407 my $sra_list = shift;
409 for my $sra (@$sra_list) {
410 my $c = $self->search_field_class_by_id( $sra->field );
411 __PACKAGE__->add_relevance_bump( $c->{classname}, $c->{field}, $sra->bump_type, $sra->multiplier, $sra->active );
414 return $self->relevance_bumps;
417 sub initialize_query_normalizers {
419 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" }] }
421 for my $cmfinm ( @$tree ) {
422 my $field_info = $self->search_field_class_by_id( $cmfinm->field );
423 __PACKAGE__->add_query_normalizer( $field_info->{classname}, $field_info->{field}, $cmfinm->norm->func, OpenSRF::Utils::JSON->JSON2perl($cmfinm->params) );
427 sub initialize_dynamic_filters {
429 my $list = shift; # open-ils.cstore.direct.config.record_attr_definition.search.atomic { "id" : { "!=" : null } }
431 for my $crad ( @$list ) {
432 __PACKAGE__->dynamic_filters( __PACKAGE__->add_search_filter( $crad->name ) ) if ($U->is_true($crad->filter));
433 __PACKAGE__->dynamic_sorters( $crad->name ) if ($U->is_true($crad->sorter));
437 sub initialize_filter_normalizers {
439 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" }] }
441 for my $crainm ( @$tree ) {
442 __PACKAGE__->add_filter_normalizer( $crainm->attr, $crainm->norm->func, OpenSRF::Utils::JSON->JSON2perl($crainm->params) );
446 sub initialize_class_weights {
450 for my $search_class (@$classes) {
451 __PACKAGE__->search_class_weights( $search_class->name, $search_class->a_weight, $search_class->b_weight, $search_class->c_weight, $search_class->d_weight );
455 sub initialize_class_ts_config {
457 my $class_entries = shift;
459 for my $search_class_entry (@$class_entries) {
460 __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);
464 sub initialize_field_ts_config {
466 my $field_entries = shift;
467 my $field_objects = shift;
468 my %field_hash = map { $_->id => $_ } @$field_objects;
470 for my $search_field_entry (@$field_entries) {
471 my $field_object = $field_hash{$search_field_entry->metabib_field};
472 __PACKAGE__->field_ts_config($field_object->field_class,$field_object->name,$search_field_entry->search_lang,$search_field_entry->ts_config);
477 sub initialization_complete {
485 return $_complete if ($_complete);
487 # tsearch rank normalization adjustments. see http://www.postgresql.org/docs/9.0/interactive/textsearch-controls.html#TEXTSEARCH-RANKING for details
488 $self->custom_data->{rank_cd_weight_map} = {
489 CD_logDocumentLength => 1,
490 CD_documentLength => 2,
491 CD_meanHarmonic => 4,
493 CD_logUniqueWords => 16,
497 $self->add_search_modifier( $_ ) for (keys %{ $self->custom_data->{rank_cd_weight_map} });
499 $self->initialize_search_field_id_map( $args{config_metabib_field} )
500 if ($args{config_metabib_field});
502 $self->initialize_aliases( $args{config_metabib_search_alias} )
503 if ($args{config_metabib_search_alias});
505 $self->initialize_relevance_bumps( $args{search_relevance_adjustment} )
506 if ($args{search_relevance_adjustment});
508 $self->initialize_query_normalizers( $args{config_metabib_field_index_norm_map} )
509 if ($args{config_metabib_field_index_norm_map});
511 $self->initialize_dynamic_filters( $args{config_record_attr_definition} )
512 if ($args{config_record_attr_definition});
514 $self->initialize_filter_normalizers( $args{config_record_attr_index_norm_map} )
515 if ($args{config_record_attr_index_norm_map});
517 $self->initialize_search_class_weights( $args{config_metabib_class} )
518 if ($args{config_metabib_class});
520 $self->initialize_class_ts_config( $args{config_metabib_class_ts_map} )
521 if ($args{config_metabib_class_ts_map});
523 $self->initialize_field_ts_config( $args{config_metabib_field_ts_map}, $args{config_metabib_field} )
524 if ($args{config_metabib_field_ts_map} && $args{config_metabib_field});
527 $args{config_metabib_field_index_norm_map} &&
528 $args{search_relevance_adjustment} &&
529 $args{config_metabib_search_alias} &&
530 $args{config_metabib_field} &&
531 $args{config_record_attr_definition}
539 __PACKAGE__->allow_nested_modifiers(1);
541 __PACKAGE__->add_search_field_id_map( series => seriestitle => 1 => 1 );
543 __PACKAGE__->add_search_field_id_map( series => seriestitle => 1 => 1 );
544 __PACKAGE__->add_relevance_bump( series => seriestitle => first_word => 1.5 );
545 __PACKAGE__->add_relevance_bump( series => seriestitle => full_match => 20 );
547 __PACKAGE__->add_search_field_id_map( title => abbreviated => 2 => 1 );
548 __PACKAGE__->add_relevance_bump( title => abbreviated => first_word => 1.5 );
549 __PACKAGE__->add_relevance_bump( title => abbreviated => full_match => 20 );
551 __PACKAGE__->add_search_field_id_map( title => translated => 3 => 1 );
552 __PACKAGE__->add_relevance_bump( title => translated => first_word => 1.5 );
553 __PACKAGE__->add_relevance_bump( title => translated => full_match => 20 );
555 __PACKAGE__->add_search_field_id_map( title => proper => 6 => 1 );
556 __PACKAGE__->add_query_normalizer( title => proper => 'search_normalize' );
557 __PACKAGE__->add_relevance_bump( title => proper => first_word => 1.5 );
558 __PACKAGE__->add_relevance_bump( title => proper => full_match => 20 );
559 __PACKAGE__->add_relevance_bump( title => proper => word_order => 10 );
561 __PACKAGE__->add_search_field_id_map( author => corporate => 7 => 1 );
562 __PACKAGE__->add_relevance_bump( author => corporate => first_word => 1.5 );
563 __PACKAGE__->add_relevance_bump( author => corporate => full_match => 20 );
565 __PACKAGE__->add_facet_field_id_map( author => personal => 8 => 1 );
567 __PACKAGE__->add_search_field_id_map( author => personal => 8 => 1 );
568 __PACKAGE__->add_relevance_bump( author => personal => first_word => 1.5 );
569 __PACKAGE__->add_relevance_bump( author => personal => full_match => 20 );
570 __PACKAGE__->add_query_normalizer( author => personal => 'search_normalize' );
571 __PACKAGE__->add_query_normalizer( author => personal => 'split_date_range' );
573 __PACKAGE__->add_facet_field_id_map( subject => topic => 14 => 1 );
575 __PACKAGE__->add_search_field_id_map( subject => topic => 14 => 1 );
576 __PACKAGE__->add_relevance_bump( subject => topic => first_word => 1 );
577 __PACKAGE__->add_relevance_bump( subject => topic => full_match => 1 );
579 __PACKAGE__->add_search_field_id_map( subject => complete => 16 => 1 );
580 __PACKAGE__->add_relevance_bump( subject => complete => first_word => 1 );
581 __PACKAGE__->add_relevance_bump( subject => complete => full_match => 1 );
583 __PACKAGE__->add_search_field_id_map( keyword => keyword => 15 => 1 );
584 __PACKAGE__->add_relevance_bump( keyword => keyword => first_word => 1 );
585 __PACKAGE__->add_relevance_bump( keyword => keyword => full_match => 1 );
587 __PACKAGE__->class_ts_config( 'series', undef, 1, 'english_nostop' );
588 __PACKAGE__->class_ts_config( 'title', undef, 1, 'english_nostop' );
589 __PACKAGE__->class_ts_config( 'author', undef, 1, 'english_nostop' );
590 __PACKAGE__->class_ts_config( 'subject', undef, 1, 'english_nostop' );
591 __PACKAGE__->class_ts_config( 'keyword', undef, 1, 'english_nostop' );
592 __PACKAGE__->class_ts_config( 'series', undef, 1, 'simple' );
593 __PACKAGE__->class_ts_config( 'title', undef, 1, 'simple' );
594 __PACKAGE__->class_ts_config( 'author', undef, 1, 'simple' );
595 __PACKAGE__->class_ts_config( 'subject', undef, 1, 'simple' );
596 __PACKAGE__->class_ts_config( 'keyword', undef, 1, 'simple' );
598 # French! To test language limiters
599 __PACKAGE__->class_ts_config( 'series', 'fre', 1, 'french_nostop' );
600 __PACKAGE__->class_ts_config( 'title', 'fre', 1, 'french_nostop' );
601 __PACKAGE__->class_ts_config( 'author', 'fre', 1, 'french_nostop' );
602 __PACKAGE__->class_ts_config( 'subject', 'fre', 1, 'french_nostop' );
603 __PACKAGE__->class_ts_config( 'keyword', 'fre', 1, 'french_nostop' );
605 # Not a default config by any means, but good for some testing
606 __PACKAGE__->field_ts_config( 'author', 'personal', 'eng', 'english' );
607 __PACKAGE__->field_ts_config( 'author', 'personal', 'fre', 'french' );
609 __PACKAGE__->add_search_class_alias( keyword => 'kw' );
610 __PACKAGE__->add_search_class_alias( title => 'ti' );
611 __PACKAGE__->add_search_class_alias( author => 'au' );
612 __PACKAGE__->add_search_class_alias( author => 'name' );
613 __PACKAGE__->add_search_class_alias( author => 'dc.contributor' );
614 __PACKAGE__->add_search_class_alias( subject => 'su' );
615 __PACKAGE__->add_search_class_alias( subject => 'bib.subject(?:Title|Place|Occupation)' );
616 __PACKAGE__->add_search_class_alias( series => 'se' );
617 __PACKAGE__->add_search_class_alias( keyword => 'dc.identifier' );
619 __PACKAGE__->add_query_normalizer( author => corporate => 'search_normalize' );
620 __PACKAGE__->add_query_normalizer( keyword => keyword => 'search_normalize' );
622 __PACKAGE__->add_search_field_alias( subject => name => 'bib.subjectName' );
626 __PACKAGE__->default_search_class( 'keyword' );
628 # implements EG-specific stored subqueries
629 __PACKAGE__->add_search_filter( 'saved_query', sub { return __PACKAGE__->subquery_callback(@_) } );
630 __PACKAGE__->add_search_filter( 'filter_group_entry', sub { return __PACKAGE__->filter_group_entry_callback(@_) } );
632 # will be retained simply for back-compat
633 __PACKAGE__->add_search_filter( 'format', sub { return __PACKAGE__->format_callback(@_) } );
635 # grumble grumble, special cases against date1 and date2
636 __PACKAGE__->add_search_filter( 'before' );
637 __PACKAGE__->add_search_filter( 'after' );
638 __PACKAGE__->add_search_filter( 'between' );
639 __PACKAGE__->add_search_filter( 'during' );
641 # various filters for limiting in various ways
642 __PACKAGE__->add_search_filter( 'edit_date' );
643 __PACKAGE__->add_search_filter( 'create_date' );
644 __PACKAGE__->add_search_filter( 'statuses' );
645 __PACKAGE__->add_search_filter( 'locations' );
646 __PACKAGE__->add_search_filter( 'location_groups', sub { return __PACKAGE__->location_groups_callback(@_) } );
647 __PACKAGE__->add_search_filter( 'bib_source' );
648 __PACKAGE__->add_search_filter( 'site' );
649 __PACKAGE__->add_search_filter( 'pref_ou' );
650 __PACKAGE__->add_search_filter( 'lasso' );
651 __PACKAGE__->add_search_filter( 'my_lasso' );
652 __PACKAGE__->add_search_filter( 'depth' );
653 __PACKAGE__->add_search_filter( 'language' );
654 __PACKAGE__->add_search_filter( 'offset' );
655 __PACKAGE__->add_search_filter( 'limit' );
656 __PACKAGE__->add_search_filter( 'check_limit' );
657 __PACKAGE__->add_search_filter( 'skip_check' );
658 __PACKAGE__->add_search_filter( 'superpage' );
659 __PACKAGE__->add_search_filter( 'superpage_size' );
660 __PACKAGE__->add_search_filter( 'estimation_strategy' );
661 __PACKAGE__->add_search_modifier( 'available' );
662 __PACKAGE__->add_search_modifier( 'staff' );
663 __PACKAGE__->add_search_modifier( 'lucky' );
665 # Start from container data (bre, acn, acp): container(bre,bookbag,123,deadb33fdeadb33fdeadb33fdeadb33f)
666 __PACKAGE__->add_search_filter( 'container' );
668 # Start from a list of record ids, either bre or metarecords, depending on the #metabib modifier
669 __PACKAGE__->add_search_filter( 'record_list' );
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 use OpenILS::Utils::CStoreEditor;
697 my $apputils = "OpenILS::Application::AppUtils";
698 my $editor = OpenILS::Utils::CStoreEditor->new;
705 for my $f ( qw/preferred_language preferred_language_multiplier preferred_language_weight core_limit check_limit skip_check superpage superpage_size/ ) {
707 $col = 'preferred_language_multiplier' if ($f eq 'preferred_language_weight');
708 my ($filter) = $self->find_filter($f);
709 if ($filter and @{$filter->args}) {
710 $filters{$col} = $filter->args->[0];
713 $self->new_filter( statuses => [0,7,12] ) if ($self->find_modifier('available'));
715 $self->QueryParser->superpage($filters{superpage}) if ($filters{superpage});
716 $self->QueryParser->superpage_size($filters{superpage_size}) if ($filters{superpage_size});
717 $self->QueryParser->core_limit($filters{core_limit}) if ($filters{core_limit});
719 $logger->debug("Query plan:\n".Dumper($self));
721 my $flat_plan = $self->flatten;
723 # generate the relevance ranking
724 my $rel = '1'; # Default to something simple in case rank_list is empty.
725 if (@{$$flat_plan{rank_list}}) {
728 . join(")\n" . ${spc} x 5 . "+ (", @{$$flat_plan{rank_list}})
730 . ${spc} x 4 . ")+1";
733 # find any supplied sort option
734 my ($sort_filter) = $self->find_filter('sort');
736 $sort_filter = $sort_filter->args->[0];
738 $sort_filter = 'rel';
741 if (($filters{preferred_language} || $self->QueryParser->default_preferred_language) && ($filters{preferred_language_multiplier} || $self->QueryParser->default_preferred_language_multiplier)) {
742 my $pl = $self->QueryParser->quote_value( $filters{preferred_language} ? $filters{preferred_language} : $self->QueryParser->default_preferred_language );
743 my $plw = $filters{preferred_language_multiplier} ? $filters{preferred_language_multiplier} : $self->QueryParser->default_preferred_language_multiplier;
744 $rel = "($rel * COALESCE( NULLIF( FIRST(mrd.attrs \@> hstore('item_lang', $pl)), FALSE )::INT * $plw, 1))";
746 $rel = "1.0/($rel)::NUMERIC";
751 $desc = 'DESC' if ($self->find_modifier('descending'));
753 my $nullpos = 'NULLS LAST';
754 $nullpos = 'NULLS FIRST' if ($self->find_modifier('nullsfirst'));
756 if (grep {$_ eq $sort_filter} @{$self->QueryParser->dynamic_sorters}) {
757 $rank = "FIRST(mrd.attrs->'$sort_filter')"
758 } elsif ($sort_filter eq 'create_date') {
759 $rank = "FIRST((SELECT create_date FROM biblio.record_entry rbr WHERE rbr.id = m.source))";
760 } elsif ($sort_filter eq 'edit_date') {
761 $rank = "FIRST((SELECT edit_date FROM biblio.record_entry rbr WHERE rbr.id = m.source))";
763 # default to rel ranking
767 my $key = 'm.source';
768 $key = 'm.metarecord' if (grep {$_->name eq 'metarecord' or $_->name eq 'metabib'} @{$self->modifiers});
770 my $core_limit = $self->QueryParser->core_limit || 25000;
771 $core_limit = 1 if($self->find_modifier('lucky'));
773 my $flat_where = $$flat_plan{where};
774 if ($flat_where ne '') {
775 $flat_where = "AND (\n" . ${spc} x 5 . $flat_where . "\n" . ${spc} x 4 . ")";
778 my $site = $self->find_filter('site');
779 if ($site && $site->args) {
780 $site = $site->args->[0];
781 if ($site && $site !~ /^(-)?\d+$/) {
782 my $search = $editor->search_actor_org_unit({ shortname => $site });
783 $site = @$search[0]->id if($search && @$search);
784 $site = undef unless ($search);
789 my $lasso = $self->find_filter('lasso');
790 if ($lasso && $lasso->args) {
791 $lasso = $lasso->args->[0];
792 if ($lasso && $lasso !~ /^\d+$/) {
793 my $search = $editor->search_actor_org_lasso({ name => $lasso });
794 $lasso = @$search[0]->id if($search && @$search);
795 $lasso = undef unless ($search);
800 my $depth = $self->find_filter('depth');
801 if ($depth && $depth->args) {
802 $depth = $depth->args->[0];
803 if ($depth && $depth !~ /^\d+$/) {
804 # This *is* what metabib.pm has been doing....but it makes no sense to me. :/
805 # Should this be looking up the depth of the OU type on the OU in question?
806 my $search = $editor->search_actor_org_unit([{ name => $depth },{ opac_label => $depth }]);
807 $depth = @$search[0]->id if($search && @$search);
808 $depth = undef unless($search);
813 my $pref_ou = $self->find_filter('pref_ou');
814 if ($pref_ou && $pref_ou->args) {
815 $pref_ou = $pref_ou->args->[0];
816 if ($pref_ou && $pref_ou !~ /^(-)?\d+$/) {
817 my $search = $editor->search_actor_org_unit({ shortname => $pref_ou });
818 $pref_ou = @$search[0]->id if($search && @$search);
819 $pref_ou = undef unless ($search);
825 # Supposedly at some point a site of 0 and a depth will equal user lasso id.
826 # We need OU buckets before that happens. 'my_lasso' is, I believe, the target filter for it.
828 $site = -$lasso if ($lasso);
830 # Default to the top of the org tree if we have nothing else. This would need tweaking for the user lasso bit.
832 my $search = $editor->search_actor_org_unit({ parent_ou => undef });
833 $site = @$search[0]->id if ($search);
836 my $depth_check = '';
837 $depth_check = ", $depth" if ($depth);
840 $with .= " search_org_list AS (\n";
844 $with .= " SELECT DISTINCT org_unit from actor.org_lasso_map WHERE lasso = $lasso\n";
845 } elsif ($site > 0) {
846 $with .= " SELECT DISTINCT id FROM actor.org_unit_descendants($site$depth_check)\n";
848 # Placeholder for user lasso stuff.
851 $with .= " luri_org_list AS (\n";
853 # We can re-use the lasso var, we already updated it above.
854 $with .= " SELECT DISTINCT (actor.org_unit_ancestors(org_unit)).id from actor.org_lasso_map WHERE lasso = $lasso\n";
855 } elsif ($site > 0) {
856 $with .= " SELECT DISTINCT id FROM actor.org_unit_ancestors($site)\n";
858 # Placeholder for user lasso stuff.
862 $with .= " SELECT DISTINCT id FROM actor.org_unit_ancestors($pref_ou)\n";
865 $with .= ",\n " . $$flat_plan{with} if ($$flat_plan{with});
868 my $limit_where = <<" SQL";
869 -- Filter records based on visibility
871 cbs.transcendant IS TRUE
874 if ($self->find_modifier('staff')) {
875 $limit_where .= <<" SQL";
877 SELECT 1 FROM asset.call_number cn
878 JOIN asset.copy cp ON (cp.call_number = cn.id)
881 AND cp.circ_lib IN ( SELECT * FROM search_org_list )
882 AND cn.record = m.source
887 SELECT 1 FROM biblio.peer_bib_copy_map pr
888 JOIN asset.copy cp ON (cp.id = pr.target_copy)
890 AND cp.circ_lib IN ( SELECT * FROM search_org_list )
891 AND pr.peer_record = m.source
896 SELECT 1 FROM asset.call_number cn
897 JOIN asset.copy cp ON (cp.call_number = cn.id)
898 WHERE cn.record = m.source
904 SELECT 1 FROM biblio.peer_bib_copy_map pr
905 JOIN asset.copy cp ON (cp.id = pr.target_copy)
907 AND pr.peer_record = m.source
912 SELECT 1 FROM asset.call_number acn
913 JOIN asset.uri_call_number_map aucnm ON acn.id = aucnm.call_number
914 JOIN asset.uri uri ON aucnm.uri = uri.id
915 WHERE NOT acn.deleted
917 AND acn.record = m.source
923 $limit_where .= <<" SQL";
925 SELECT 1 FROM asset.opac_visible_copies
926 WHERE circ_lib IN ( SELECT * FROM search_org_list )
927 AND record = m.source
932 SELECT 1 FROM biblio.peer_bib_copy_map pr
933 JOIN asset.opac_visible_copies cp ON (cp.copy_id = pr.target_copy)
934 WHERE cp.circ_lib IN ( SELECT * FROM search_org_list )
935 AND pr.peer_record = m.source
940 $limit_where .= <<" SQL";
943 SELECT 1 FROM asset.call_number acn
944 JOIN asset.uri_call_number_map aucnm ON acn.id = aucnm.call_number
945 JOIN asset.uri uri ON aucnm.uri = uri.id
946 WHERE NOT acn.deleted AND uri.active AND acn.record = m.source AND acn.owning_lib IN (
947 SELECT * FROM luri_org_list
954 # For single records we want the record id
955 # For metarecords we want NULL or the only record ID.
956 my $agg_record = 'm.source AS record';
957 if ($key =~ /metarecord/) {
958 $agg_record = 'CASE WHEN COUNT(DISTINCT m.source) = 1 THEN FIRST(m.source) ELSE NULL END AS record';
968 FIRST(mrd.attrs->'date1') AS tie_break
969 FROM metabib.metarecord_source_map m
971 INNER JOIN metabib.record_attr mrd ON m.source = mrd.id
972 INNER JOIN biblio.record_entry bre ON m.source = bre.id
973 LEFT JOIN config.bib_source cbs ON bre.source = cbs.id
978 ORDER BY 4 $desc $nullpos, 5 DESC $nullpos, 3 DESC
982 warn $sql if $self->QueryParser->debug;
990 my $from = shift || '';
991 my $where = shift || '';
995 for my $node ( @{$self->query_nodes} ) {
998 if ($node->isa( 'QueryParser::query_plan::node' )) {
1000 unless (@{$node->only_atoms}) {
1001 push @rank_list, '1';
1006 my $table = $node->table;
1007 my $ctable = $node->combined_table;
1008 my $talias = $node->table_alias;
1010 my $node_rank = 'COALESCE(' . $node->rank . " * ${talias}.weight, 0.0)";
1012 $from .= "\n" . ${spc} x 4 ."LEFT JOIN (\n"
1013 . ${spc} x 5 . "SELECT fe.*, fe_weight.weight, ${talias}_xq.tsq, ${talias}_xq.tsq_rank /* search */\n"
1014 . ${spc} x 6 . "FROM $table AS fe";
1015 $from .= "\n" . ${spc} x 7 . "JOIN config.metabib_field AS fe_weight ON (fe_weight.id = fe.field)";
1019 if (@{$node->fields} > 0) {
1020 @bump_fields = @{$node->fields};
1022 @field_ids = grep defined, (
1024 $self->QueryParser->search_field_ids_by_class(
1025 $node->classname, $_
1030 @bump_fields = @{$self->QueryParser->search_fields->{$node->classname}};
1033 if ($node->dummy_count < @{$node->only_atoms} ) {
1034 $with .= ",\n " if $with;
1035 $with .= "${talias}_xq AS (SELECT ". $node->tsquery ." AS tsq,". $node->tsquery_rank ." AS tsq_rank )";
1036 $from .= "\n" . ${spc} x 6 . "JOIN $ctable AS com ON (com.record = fe.source";
1038 $from .= " AND com.metabib_field IN (" . join(',',@field_ids) . "))";
1040 $from .= " AND com.metabib_field IS NULL)";
1042 $from .= "\n" . ${spc} x 6 . "JOIN ${talias}_xq ON (com.index_vector @@ ${talias}_xq.tsq)";
1044 $from .= "\n" . ${spc} x 6 . ", (SELECT NULL::tsquery AS tsq, NULL:tsquery AS tsq_rank ) AS ${talias}_xq";
1048 $from .= "\n" . ${spc} x 6 . "WHERE fe_weight.id IN (" .
1049 join(',', @field_ids) . ")";
1052 $from .= "\n" . ${spc} x 4 . ") AS $talias ON (m.source = ${talias}.source)";
1057 for my $field ( @bump_fields ) {
1058 my $bumps = $self->QueryParser->find_relevance_bumps( $node->classname => $field );
1059 for my $b (keys %$bumps) {
1060 next if (!$$bumps{$b}{active});
1061 next if ($used_bumps{$b});
1062 $used_bumps{$b} = 1;
1064 next if ($$bumps{$b}{multiplier} == 1); # optimization to remove unneeded bumps
1066 push @bumpmults, $$bumps{$b}{multiplier};
1070 if(scalar @bumps > 0 && scalar @{$node->only_positive_atoms} > 0) {
1071 # Note: Previous rank function used search_normalize outright. Duplicating that here.
1072 $node_rank .= "\n" . ${spc} x 5 . "* evergreen.rel_bump(('{' || search_normalize(";
1073 $node_rank .= join(") || ',' || search_normalize(",map { $self->QueryParser->quote_phrase_value($_->content) } @{$node->only_positive_atoms});
1074 $node_rank .= ") || '}')::TEXT[], " . $node->table_alias . ".value, '{" . join(",",@bumps) . "}'::TEXT[], '{" . join(",",@bumpmults) . "}'::NUMERIC[])";
1078 $NOT = 'NOT ' if $node->negate;
1080 $where .= "$NOT(" . $talias . ".id IS NOT NULL";
1081 if (@{$node->phrases}) {
1082 $where .= ' AND ' . join(' AND ', map {
1083 "${talias}.value ~* ".$self->QueryParser->quote_phrase_value($_, 1)
1084 } @{$node->phrases});
1086 for my $atom (@{$node->only_real_atoms}) {
1087 next unless $atom->{content} && $atom->{content} =~ /(^\^|\$$)/;
1088 $where .= " AND ${talias}.value ~* ".$self->QueryParser->quote_phrase_value($atom->{content});
1093 push @rank_list, $node_rank;
1095 } elsif ($node->isa( 'QueryParser::query_plan::facet' )) {
1097 my $talias = $node->table_alias;
1100 if (@{$node->fields} > 0) {
1101 push(@field_ids, $self->QueryParser->facet_field_ids_by_class( $node->classname, $_ )->[0]) for (@{$node->fields});
1103 @field_ids = @{ $self->QueryParser->facet_field_ids_by_class( $node->classname ) };
1106 my $join_type = ($node->negate or !$self->top_plan) ? 'LEFT' : 'INNER';
1107 $from .= "\n${spc}$join_type JOIN /* facet */ metabib.facet_entry $talias ON (\n"
1108 . ${spc} x 2 . "m.source = ${talias}.source\n"
1109 . ${spc} x 2 . "AND SUBSTRING(${talias}.value,1,1024) IN ("
1110 . join(",", map { $self->QueryParser->quote_value($_) } @{$node->values}) . ")\n"
1111 . ${spc} x 2 ."AND ${talias}.field IN (". join(',', @field_ids) . ")\n"
1114 if ($join_type ne 'INNER') {
1115 my $NOT = $node->negate ? '' : ' NOT';
1116 $where .= "${talias}.id IS$NOT NULL";
1117 } elsif ($where ne '') {
1118 # Strip extra joiner
1119 $where =~ s/(\s|\n)+(AND|OR)\s$//;
1123 my $subnode = $node->flatten;
1125 # strip the trailing bool from the previous loop if there is
1126 # nothing to add to the where within this loop.
1127 if ($$subnode{where} eq '') {
1128 $where =~ s/(\s|\n)+(AND|OR)\s$//;
1131 push(@rank_list, @{$$subnode{rank_list}});
1132 $from .= $$subnode{from};
1135 $NOT = 'NOT ' if $node->negate;
1137 if ($$subnode{where} ne '') {
1139 . ${spc} x ($self->plan_level + 6) . $$subnode{where} . "\n"
1140 . ${spc} x ($self->plan_level + 5) . ')';
1143 if ($$subnode{with}) {
1144 $with .= ",\n " if $with;
1145 $with .= $$subnode{with};
1150 warn "flatten(): appending WHERE bool to: $where\n" if $self->QueryParser->debug;
1153 $where .= "\n" . ${spc} x ( $self->plan_level + 5 ) . 'AND ' if ($node eq '&');
1154 $where .= "\n" . ${spc} x ( $self->plan_level + 5 ) . 'OR ' if ($node eq '|');
1159 my $joiner = "\n" . ${spc} x ( $self->plan_level + 5 ) . ($self->joiner eq '&' ? 'AND ' : 'OR ');
1160 # for each dynamic filter, build more of the WHERE clause
1161 for my $filter (@{$self->filters}) {
1162 my $NOT = $filter->negate ? 'NOT ' : '';
1163 if (grep { $_ eq $filter->name } @{ $self->QueryParser->dynamic_filters }) {
1165 warn "flatten(): processing dynamic filter ". $filter->name ."\n"
1166 if $self->QueryParser->debug;
1168 # bool joiner for intra-plan nodes/filters
1169 $where .= $joiner if $where ne '';
1171 my @fargs = @{$filter->args};
1172 my $fname = $filter->name;
1173 $fname = 'item_lang' if $fname eq 'language'; #XXX filter aliases
1176 "${NOT}COALESCE((mrd.attrs->'%s') IN (%s), false)", $fname,
1177 join(',', map { $self->QueryParser->quote_value($_) } @fargs)
1180 warn "flatten(): filter where => $where\n"
1181 if $self->QueryParser->debug;
1183 if ($filter->name eq 'before') {
1184 if (@{$filter->args} == 1) {
1185 $where .= $joiner if $where ne '';
1186 $where .= "${NOT}COALESCE((mrd.attrs->'date1') <= "
1187 . $self->QueryParser->quote_value($filter->args->[0])
1190 } elsif ($filter->name eq 'after') {
1191 if (@{$filter->args} == 1) {
1192 $where .= $joiner if $where ne '';
1193 $where .= "${NOT}COALESCE((mrd.attrs->'date1') >= "
1194 . $self->QueryParser->quote_value($filter->args->[0])
1197 } elsif ($filter->name eq 'during') {
1198 if (@{$filter->args} == 1) {
1199 $where .= $joiner if $where ne '';
1200 $where .= "${NOT}COALESCE("
1201 . $self->QueryParser->quote_value($filter->args->[0])
1202 . " BETWEEN (mrd.attrs->'date1') AND (mrd.attrs->'date2'), false)";
1204 } elsif ($filter->name eq 'between') {
1205 if (@{$filter->args} == 2) {
1206 $where .= $joiner if $where ne '';
1207 $where .= "${NOT}COALESCE((mrd.attrs->'date1') BETWEEN "
1208 . $self->QueryParser->quote_value($filter->args->[0])
1210 . $self->QueryParser->quote_value($filter->args->[1])
1213 } elsif ($filter->name eq 'container') {
1214 if (@{$filter->args} >= 3) {
1215 my ($class, $ctype, $cid, $token) = @{$filter->args};
1218 my $rec_field = 'ci.target_biblio_record_entry';
1219 if ($class eq 'bre') {
1220 $class = 'biblio_record_entry';
1221 } elsif ($class eq 'acn') {
1222 $class = 'call_number';
1223 $rec_field = 'cn.record';
1224 $rec_join = 'JOIN asset.call_number cn ON (ci.target_call_number = cn.id)';
1225 } elsif ($class eq 'acp') {
1227 $rec_field = 'cn.record';
1228 $rec_join = 'JOIN asset.copy cp ON (ci.target_copy = cp.id) JOIN asset.call_number cn ON (cp.call_number = cn.id)';
1234 my ($u,$e) = $apputils->checksesperm($token) if ($token);
1235 $perm_join = ' OR c.owner = ' . $u->id if ($u && !$e);
1237 my $filter_alias = "$filter";
1238 $filter_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
1239 $filter_alias =~ s/\|/_/go;
1241 $with .= ",\n " if $with;
1242 $with .= "container_${filter_alias} AS (\n";
1243 $with .= " SELECT $rec_field AS record FROM container.${class}_bucket_item ci\n"
1244 . " JOIN container.${class}_bucket c ON (c.id = ci.bucket) $rec_join\n"
1245 . " WHERE c.btype = " . $self->QueryParser->quote_value($ctype) . "\n"
1246 . " AND c.id = " . $self->QueryParser->quote_value($cid) . "\n"
1247 . " AND (c.pub IS TRUE$perm_join)\n";
1248 if ($class eq 'copy') {
1250 . " SELECT pr.peer_record AS record FROM container.copy_bucket_item ci\n"
1251 . " JOIN container.copy_bucket c ON (c.id = ci.bucket)\n"
1252 . " JOIN biblio.peer_bib_copy_map pr ON ci.target_copy = pr.target_copy\n"
1253 . " WHERE c.btype = " . $self->QueryParser->quote_value($ctype) . "\n"
1254 . " AND c.id = " . $self->QueryParser->quote_value($cid) . "\n"
1255 . " AND (c.pub IS TRUE$perm_join)\n";
1259 $from .= "\n" . ${spc} x 3 . "LEFT JOIN container_${filter_alias} ON container_${filter_alias}.record = m.source";
1261 my $spcdepth = $self->plan_level + 5;
1263 $where .= $joiner if $where ne '';
1264 $where .= "${NOT}(container_${filter_alias} IS NOT NULL)";
1267 } elsif ($filter->name eq 'record_list') {
1268 if (@{$filter->args} > 0) {
1269 my $key = 'm.source';
1270 $key = 'm.metarecord' if (grep {$_->name eq 'metarecord' or $_->name eq 'metabib'} @{$self->QueryParser->parse_tree->modifiers});
1271 $where .= $joiner if $where ne '';
1272 $where .= "$key ${NOT}IN (" . join(',', map { $self->QueryParser->quote_value($_) } @{$filter->args}) . ')';
1275 } elsif ($filter->name eq 'edit_date' or $filter->name eq 'create_date') {
1276 # bre.create_date and bre.edit_date filtering
1277 my $datefilter = $filter->name;
1279 if ($filter && $filter->args && scalar(@{$filter->args}) > 0 && scalar(@{$filter->args}) < 3) {
1280 my ($cstart, $cend) = @{$filter->args};
1282 if (!$cstart and !$cend) {
1283 # useless use of filter
1284 } elsif (!$cstart or $cstart eq '-infinity') { # no start supplied
1285 if ($cend eq 'infinity') {
1286 # useless use of filter
1289 $cend = cleanse_ISO8601($cend);
1290 $where .= $joiner if $where ne '';
1291 $where .= "bre.$datefilter <= \$_$$\$$cend\$_$$\$";
1294 } elsif (!$cend or $cend eq 'infinity') { # no end supplied
1295 if ($cstart eq '-infinity') {
1296 # useless use of filter
1297 } else { # "after $cstart"
1298 $cstart = cleanse_ISO8601($cstart);
1299 $where .= $joiner if $where ne '';
1300 $where .= "bre.$datefilter >= \$_$$\$$cstart\$_$$\$";
1302 } else { # both supplied
1303 # "between $cstart and $cend"
1304 $cstart = cleanse_ISO8601($cstart);
1305 $cend = cleanse_ISO8601($cend);
1306 $where .= $joiner if $where ne '';
1307 $where .= "bre.$datefilter BETWEEN \$_$$\$$cstart\$_$$\$ AND \$_$$\$$cend\$_$$\$";
1310 } elsif ($filter->name eq 'locations') {
1311 if (@{$filter->args} > 0) {
1312 my $spcdepth = $self->plan_level + 5;
1313 $where .= $joiner if $where ne '';
1315 . ${spc} x ($spcdepth + 1) . "${NOT}EXISTS(\n"
1316 . ${spc} x ($spcdepth + 2) . "SELECT 1 FROM asset.call_number acn\n"
1317 . ${spc} x ($spcdepth + 5) . "JOIN asset.copy acp ON acn.id = acp.call_number\n"
1318 . ${spc} x ($spcdepth + 2) . "WHERE m.source = acn.record\n"
1319 . ${spc} x ($spcdepth + 5) . "AND acp.circ_lib IN (SELECT * FROM search_org_list)\n"
1320 . ${spc} x ($spcdepth + 5) . "AND NOT acn.deleted\n"
1321 . ${spc} x ($spcdepth + 5) . "AND NOT acp.deleted\n"
1322 . ${spc} x ($spcdepth + 5) . "AND acp.location IN (" . join(',', map { $self->QueryParser->quote_value($_) } @{ $filter->args }) . ")\n"
1323 . ${spc} x ($spcdepth + 2) . "LIMIT 1\n"
1324 . ${spc} x ($spcdepth + 1) . ")\n"
1325 . ${spc} x ($spcdepth + 1) . ($filter->negate ? 'AND' : 'OR') . "\n"
1326 . ${spc} x ($spcdepth + 1) . "${NOT}EXISTS(\n"
1327 . ${spc} x ($spcdepth + 2) . "SELECT 1 FROM biblio.peer_bib_copy_map pr\n"
1328 . ${spc} x ($spcdepth + 5) . "JOIN asset.copy acp ON pr.target_copy = acp.id\n"
1329 . ${spc} x ($spcdepth + 2) . "WHERE m.source = pr.peer_record\n"
1330 . ${spc} x ($spcdepth + 5) . "AND acp.circ_lib IN (SELECT * FROM search_org_list)\n"
1331 . ${spc} x ($spcdepth + 5) . "AND NOT acp.deleted\n"
1332 . ${spc} x ($spcdepth + 5) . "AND acp.location IN (" . join(',', map { $self->QueryParser->quote_value($_) } @{ $filter->args }) . ")\n"
1333 . ${spc} x ($spcdepth + 2) . "LIMIT 1\n"
1334 . ${spc} x ($spcdepth + 1) . ")\n"
1335 . ${spc} x $spcdepth . ")";
1337 } elsif ($filter->name eq 'statuses') {
1338 if (@{$filter->args} > 0) {
1339 my $spcdepth = $self->plan_level + 5;
1340 $where .= $joiner if $where ne '';
1342 . ${spc} x ($spcdepth + 1) . "${NOT}EXISTS(\n"
1343 . ${spc} x ($spcdepth + 2) . "SELECT 1 FROM asset.call_number acn\n"
1344 . ${spc} x ($spcdepth + 5) . "JOIN asset.copy acp ON acn.id = acp.call_number\n"
1345 . ${spc} x ($spcdepth + 2) . "WHERE m.source = acn.record\n"
1346 . ${spc} x ($spcdepth + 5) . "AND acp.circ_lib IN (SELECT * FROM search_org_list)\n"
1347 . ${spc} x ($spcdepth + 5) . "AND NOT acn.deleted\n"
1348 . ${spc} x ($spcdepth + 5) . "AND NOT acp.deleted\n"
1349 . ${spc} x ($spcdepth + 5) . "AND acp.status IN (" . join(',', map { $self->QueryParser->quote_value($_) } @{ $filter->args }) . ")\n"
1350 . ${spc} x ($spcdepth + 2) . "LIMIT 1\n"
1351 . ${spc} x ($spcdepth + 1) . ")\n"
1352 . ${spc} x ($spcdepth + 1) . ($filter->negate ? 'AND' : 'OR') . "\n"
1353 . ${spc} x ($spcdepth + 1) . "${NOT}EXISTS(\n"
1354 . ${spc} x ($spcdepth + 2) . "SELECT 1 FROM biblio.peer_bib_copy_map pr\n"
1355 . ${spc} x ($spcdepth + 5) . "JOIN asset.copy acp ON pr.target_copy = acp.id\n"
1356 . ${spc} x ($spcdepth + 2) . "WHERE m.source = pr.peer_record\n"
1357 . ${spc} x ($spcdepth + 5) . "AND acp.circ_lib IN (SELECT * FROM search_org_list)\n"
1358 . ${spc} x ($spcdepth + 5) . "AND NOT acp.deleted\n"
1359 . ${spc} x ($spcdepth + 5) . "AND acp.status IN (" . join(',', map { $self->QueryParser->quote_value($_) } @{ $filter->args }) . ")\n"
1360 . ${spc} x ($spcdepth + 2) . "LIMIT 1\n"
1361 . ${spc} x ($spcdepth + 1) . ")\n"
1362 . ${spc} x $spcdepth . ")";
1364 } elsif ($filter->name eq 'bib_source') {
1365 if (@{$filter->args} > 0) {
1366 $where .= $joiner if $where ne '';
1367 $where .= "${NOT}COALESCE(bre.source IN ("
1368 . join(',', map { $self->QueryParser->quote_value($_) } @{ $filter->args })
1374 warn "flatten(): full filter where => $where\n" if $self->QueryParser->debug;
1376 return { rank_list => \@rank_list, from => $from, where => $where, with => $with };
1380 #-------------------------------
1381 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::filter;
1382 use base 'QueryParser::query_plan::filter';
1384 #-------------------------------
1385 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::facet;
1386 use base 'QueryParser::query_plan::facet';
1390 my ($classname) = split '\|', $self->name;
1396 my ($classname,@fields) = split '\|', $self->name;
1403 my $table_alias = "$self";
1404 $table_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
1405 $table_alias .= '_' . $self->name;
1406 $table_alias =~ s/\|/_/go;
1408 return $table_alias;
1412 #-------------------------------
1413 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::modifier;
1414 use base 'QueryParser::query_plan::modifier';
1416 #-------------------------------
1417 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::node::atom;
1418 use base 'QueryParser::query_plan::node::atom';
1424 $self->{sql} = $sql if ($sql);
1426 return $self->{sql} if ($self->{sql});
1427 return $self->buildSQL;
1433 my $classname = $self->node->classname;
1435 return $self->sql("to_tsquery('$classname','')") if $self->{dummy};
1437 my $normalizers = $self->node->plan->QueryParser->query_normalizers( $classname );
1438 my $fields = $self->node->fields;
1441 my $filter = $self->node->plan->find_filter('preferred_language');
1442 $lang ||= $filter->args->[0] if ($filter && $filter->args);
1443 $lang ||= $self->node->plan->QueryParser->default_preferred_language;
1444 my $ts_configs = [];
1446 if (@{$self->node->phrases}) {
1447 # We assume we want 'simple' for phrases. Gives us less to match against later.
1448 $ts_configs = ['simple'];
1451 $ts_configs = $self->node->plan->QueryParser->class_ts_config($classname, $lang);
1453 for my $field (@$fields) {
1454 push @$ts_configs, @{$self->node->plan->QueryParser->field_ts_config($classname, $field, $lang)};
1457 $ts_configs = [keys %{{map { $_ => 1 } @$ts_configs}}];
1460 # Assume we want exact if none otherwise provided.
1461 # Because we can reasonably expect this to exist
1462 $ts_configs = ['simple'] unless (scalar @$ts_configs);
1464 $fields = $self->node->plan->QueryParser->search_fields->{$classname} if (!@$fields);
1468 for my $field (@$fields) {
1469 for my $nfield (keys %$normalizers) {
1470 for my $nizer ( @{$$normalizers{$nfield}} ) {
1471 if ($field eq $nfield) {
1472 my $param_string = OpenSRF::Utils::JSON->perl2JSON($nizer->{params});
1473 if (!exists($norms{$nizer->{function}.$param_string})) {
1474 $norms{$nizer->{function}.$param_string} = {p=>$pos++,n=>$nizer};
1481 my $sql = $self->node->plan->QueryParser->quote_value($self->content);
1483 for my $n ( map { $$_{n} } sort { $$a{p} <=> $$b{p} } values %norms ) {
1484 $sql = join(', ', $sql, map { $self->node->plan->QueryParser->quote_value($_) } @{ $n->{params} });
1485 $sql = $n->{function}."($sql)";
1488 my $prefix = $self->prefix || '';
1489 my $suffix = $self->suffix || '';
1490 my $joiner = ' || ';
1491 $joiner = ' && ' if $self->prefix eq '!'; # Negative atoms should be "none of the variants" instead of "any of the variants"
1493 $prefix = "'$prefix' ||" if $prefix;
1495 my $suffix_after = '';
1497 $suffix_op = ":$suffix" if $suffix;
1498 $suffix_after = "|| '$suffix_op'" if $suffix;
1501 for my $ts_config (@$ts_configs) {
1502 push @sql_set, "to_tsquery('$ts_config', COALESCE(NULLIF($prefix '(' || btrim(regexp_replace($sql,E'(?:\\\\s+|:)','$suffix_op&','g'),'&|') $suffix_after || ')', '()'), ''))";
1505 $sql = join($joiner, @sql_set);
1506 $sql = '(' . $sql . ')' if (scalar(@$ts_configs) > 1);
1508 return $self->sql($sql);
1511 #-------------------------------
1512 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::node;
1513 use base 'QueryParser::query_plan::node';
1518 $self->{dummy_count} = 0;
1520 my $atoms = $self->query_atoms;
1522 for my $a (@$atoms) {
1523 push(@only_atoms, $a) if (ref($a) && $a->isa('QueryParser::query_plan::node::atom'));
1524 $self->{dummy_count}++ if (ref($a) && $a->{dummy});
1527 return \@only_atoms;
1530 sub only_real_atoms {
1533 my $atoms = $self->query_atoms;
1534 my @only_real_atoms;
1535 for my $a (@$atoms) {
1536 push(@only_real_atoms, $a) if (ref($a) && $a->isa('QueryParser::query_plan::node::atom') && !($a->{dummy}));
1539 return \@only_real_atoms;
1542 sub only_positive_atoms {
1545 my $atoms = $self->query_atoms;
1546 my @only_positive_atoms;
1547 for my $a (@$atoms) {
1548 push(@only_positive_atoms, $a) if (ref($a) && $a->isa('QueryParser::query_plan::node::atom') && !($a->{dummy}) && ($a->{prefix} ne '!'));
1551 return \@only_positive_atoms;
1556 return $self->{dummy_count};
1562 $self->{table} = $table if ($table);
1563 return $self->{table} if $self->{table};
1564 return $self->table( 'metabib.' . $self->classname . '_field_entry' );
1567 sub combined_table {
1570 $self->{ctable} = $ctable if ($ctable);
1571 return $self->{ctable} if $self->{ctable};
1572 return $self->combined_table( 'metabib.combined_' . $self->classname . '_field_entry' );
1577 my $table_alias = shift;
1578 $self->{table_alias} = $table_alias if ($table_alias);
1579 return $self->{table_alias} if ($self->{table_alias});
1581 $table_alias = "$self";
1582 $table_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
1583 $table_alias .= '_' . $self->requested_class;
1584 $table_alias =~ s/\|/_/go;
1586 return $self->table_alias( $table_alias );
1591 return $self->{tsquery} if ($self->{tsquery});
1593 for my $atom (@{$self->query_atoms}) {
1595 $self->{tsquery} .= "\n" . ${spc} x 3 . $atom->sql;
1597 $self->{tsquery} .= $atom x 2;
1601 return $self->{tsquery};
1606 return $self->{tsquery_rank} if ($self->{tsquery_rank});
1609 for my $atom (@{$self->only_positive_atoms}) {
1610 push @atomlines, "\n" . ${spc} x 3 . $atom->sql;
1612 $self->{tsquery_rank} = join(' ||', @atomlines);
1613 $self->{tsquery_rank} = 'NULL::tsquery' unless $self->{tsquery_rank};
1614 return $self->{tsquery_rank};
1619 return $self->{rank} if ($self->{rank});
1621 my $rank_norm_map = $self->plan->QueryParser->custom_data->{rank_cd_weight_map};
1623 my $cover_density = 0;
1624 for my $norm ( keys %$rank_norm_map) {
1625 $cover_density += $$rank_norm_map{$norm} if ($self->plan->find_modifier($norm));
1628 my $weights = join(', ', @{$self->plan->QueryParser->search_class_weights($self->classname)});
1630 return $self->{rank} = "ts_rank_cd('{" . $weights . "}', " . $self->table_alias . '.index_vector, ' . $self->table_alias . ".tsq_rank, $cover_density)";