5 use OpenSRF::Utils::JSON;
22 sub facet_class_count {
24 return @{$self->facet_classes};
27 sub search_class_count {
29 return @{$self->search_classes};
34 return @{$self->filters};
39 return @{$self->modifiers};
44 $class = ref($class) || $class;
46 $parser_config{$class}{custom_data} ||= {};
47 return $parser_config{$class}{custom_data};
52 $class = ref($class) || $class;
54 $parser_config{$class}{operators} ||= {};
55 return $parser_config{$class}{operators};
60 $class = ref($class) || $class;
62 $parser_config{$class}{filters} ||= [];
63 return $parser_config{$class}{filters};
66 sub filter_callbacks {
68 $class = ref($class) || $class;
70 $parser_config{$class}{filter_callbacks} ||= {};
71 return $parser_config{$class}{filter_callbacks};
76 $class = ref($class) || $class;
78 $parser_config{$class}{modifiers} ||= [];
79 return $parser_config{$class}{modifiers};
84 $class = ref($class) || $class;
88 my $self = bless {} => $class;
90 for my $o (keys %{QueryParser->operators}) {
91 $class->operator($o => QueryParser->operator($o)) unless ($class->operator($o));
94 for my $opt ( keys %opts) {
95 $self->$opt( $opts{$opt} ) if ($self->can($opt));
103 my $pkg = ref($self) || $self;
104 return do{$pkg.'::query_plan'}->new( QueryParser => $self, @_ );
107 sub add_search_filter {
109 $pkg = ref($pkg) || $pkg;
111 my $callback = shift;
113 return $filter if (grep { $_ eq $filter } @{$pkg->filters});
114 push @{$pkg->filters}, $filter;
115 $pkg->filter_callbacks->{$filter} = $callback if ($callback);
119 sub add_search_modifier {
121 $pkg = ref($pkg) || $pkg;
122 my $modifier = shift;
124 return $modifier if (grep { $_ eq $modifier } @{$pkg->modifiers});
125 push @{$pkg->modifiers}, $modifier;
129 sub add_facet_class {
131 $pkg = ref($pkg) || $pkg;
134 return $class if (grep { $_ eq $class } @{$pkg->facet_classes});
136 push @{$pkg->facet_classes}, $class;
137 $pkg->facet_fields->{$class} = [];
142 sub add_search_class {
144 $pkg = ref($pkg) || $pkg;
147 return $class if (grep { $_ eq $class } @{$pkg->search_classes});
149 push @{$pkg->search_classes}, $class;
150 $pkg->search_fields->{$class} = [];
151 $pkg->default_search_class( $pkg->search_classes->[0] ) if (@{$pkg->search_classes} == 1);
158 $class = ref($class) || $class;
162 return undef unless ($opname);
164 $parser_config{$class}{operators} ||= {};
165 $parser_config{$class}{operators}{$opname} = $op if ($op);
167 return $parser_config{$class}{operators}{$opname};
172 $class = ref($class) || $class;
175 $parser_config{$class}{facet_classes} ||= [];
176 $parser_config{$class}{facet_classes} = $classes if (ref($classes) && @$classes);
177 return $parser_config{$class}{facet_classes};
182 $class = ref($class) || $class;
185 $parser_config{$class}{classes} ||= [];
186 $parser_config{$class}{classes} = $classes if (ref($classes) && @$classes);
187 return $parser_config{$class}{classes};
190 sub add_query_normalizer {
192 $pkg = ref($pkg) || $pkg;
196 my $params = shift || [];
198 # do not add if function AND params are identical to existing member
199 return $func if (grep {
200 $_->{function} eq $func and
201 OpenSRF::Utils::JSON->perl2JSON($_->{params}) eq OpenSRF::Utils::JSON->perl2JSON($params)
202 } @{$pkg->query_normalizers->{$class}->{$field}});
204 push(@{$pkg->query_normalizers->{$class}->{$field}}, { function => $func, params => $params });
209 sub query_normalizers {
211 $pkg = ref($pkg) || $pkg;
216 $parser_config{$pkg}{normalizers} ||= {};
219 $parser_config{$pkg}{normalizers}{$class}{$field} ||= [];
220 return $parser_config{$pkg}{normalizers}{$class}{$field};
222 return $parser_config{$pkg}{normalizers}{$class};
226 return $parser_config{$pkg}{normalizers};
229 sub add_filter_normalizer {
231 $pkg = ref($pkg) || $pkg;
234 my $params = shift || [];
236 return $func if (grep { $_ eq $func } @{$pkg->filter_normalizers->{$filter}});
238 push(@{$pkg->filter_normalizers->{$filter}}, { function => $func, params => $params });
243 sub filter_normalizers {
245 $pkg = ref($pkg) || $pkg;
249 $parser_config{$pkg}{filter_normalizers} ||= {};
251 $parser_config{$pkg}{filter_normalizers}{$filter} ||= [];
252 return $parser_config{$pkg}{filter_normalizers}{$filter};
255 return $parser_config{$pkg}{filter_normalizers};
258 sub default_search_class {
260 $pkg = ref($pkg) || $pkg;
262 $QueryParser::parser_config{$pkg}{default_class} = $pkg->add_search_class( $class ) if $class;
264 return $QueryParser::parser_config{$pkg}{default_class};
267 sub remove_facet_class {
269 $pkg = ref($pkg) || $pkg;
272 return $class if (!grep { $_ eq $class } @{$pkg->facet_classes});
274 $pkg->facet_classes( [ grep { $_ ne $class } @{$pkg->facet_classes} ] );
275 delete $QueryParser::parser_config{$pkg}{facet_fields}{$class};
280 sub remove_search_class {
282 $pkg = ref($pkg) || $pkg;
285 return $class if (!grep { $_ eq $class } @{$pkg->search_classes});
287 $pkg->search_classes( [ grep { $_ ne $class } @{$pkg->search_classes} ] );
288 delete $QueryParser::parser_config{$pkg}{fields}{$class};
293 sub add_facet_field {
295 $pkg = ref($pkg) || $pkg;
299 $pkg->add_facet_class( $class );
301 return { $class => $field } if (grep { $_ eq $field } @{$pkg->facet_fields->{$class}});
303 push @{$pkg->facet_fields->{$class}}, $field;
305 return { $class => $field };
310 $class = ref($class) || $class;
312 $parser_config{$class}{facet_fields} ||= {};
313 return $parser_config{$class}{facet_fields};
316 sub add_search_field {
318 $pkg = ref($pkg) || $pkg;
322 $pkg->add_search_class( $class );
324 return { $class => $field } if (grep { $_ eq $field } @{$pkg->search_fields->{$class}});
326 push @{$pkg->search_fields->{$class}}, $field;
328 return { $class => $field };
333 $class = ref($class) || $class;
335 $parser_config{$class}{fields} ||= {};
336 return $parser_config{$class}{fields};
339 sub add_search_class_alias {
341 $pkg = ref($pkg) || $pkg;
345 $pkg->add_search_class( $class );
347 return { $class => $alias } if (grep { $_ eq $alias } @{$pkg->search_class_aliases->{$class}});
349 push @{$pkg->search_class_aliases->{$class}}, $alias;
351 return { $class => $alias };
354 sub search_class_aliases {
356 $class = ref($class) || $class;
358 $parser_config{$class}{class_map} ||= {};
359 return $parser_config{$class}{class_map};
362 sub add_search_field_alias {
364 $pkg = ref($pkg) || $pkg;
369 return { $class => { $field => $alias } } if (grep { $_ eq $alias } @{$pkg->search_field_aliases->{$class}{$field}});
371 push @{$pkg->search_field_aliases->{$class}{$field}}, $alias;
373 return { $class => { $field => $alias } };
376 sub search_field_aliases {
378 $class = ref($class) || $class;
380 $parser_config{$class}{field_alias_map} ||= {};
381 return $parser_config{$class}{field_alias_map};
384 sub remove_facet_field {
386 $pkg = ref($pkg) || $pkg;
390 return { $class => $field } if (!$pkg->facet_fields->{$class} || !grep { $_ eq $field } @{$pkg->facet_fields->{$class}});
392 $pkg->facet_fields->{$class} = [ grep { $_ ne $field } @{$pkg->facet_fields->{$class}} ];
394 return { $class => $field };
397 sub remove_search_field {
399 $pkg = ref($pkg) || $pkg;
403 return { $class => $field } if (!$pkg->search_fields->{$class} || !grep { $_ eq $field } @{$pkg->search_fields->{$class}});
405 $pkg->search_fields->{$class} = [ grep { $_ ne $field } @{$pkg->search_fields->{$class}} ];
407 return { $class => $field };
410 sub remove_search_field_alias {
412 $pkg = ref($pkg) || $pkg;
417 return { $class => { $field => $alias } } if (!$pkg->search_field_aliases->{$class}{$field} || !grep { $_ eq $alias } @{$pkg->search_field_aliases->{$class}{$field}});
419 $pkg->search_field_aliases->{$class}{$field} = [ grep { $_ ne $alias } @{$pkg->search_field_aliases->{$class}{$field}} ];
421 return { $class => { $field => $alias } };
424 sub remove_search_class_alias {
426 $pkg = ref($pkg) || $pkg;
430 return { $class => $alias } if (!$pkg->search_class_aliases->{$class} || !grep { $_ eq $alias } @{$pkg->search_class_aliases->{$class}});
432 $pkg->search_class_aliases->{$class} = [ grep { $_ ne $alias } @{$pkg->search_class_aliases->{$class}} ];
434 return { $class => $alias };
440 $self->{_debug} = $q if (defined $q);
441 return $self->{_debug};
447 $self->{_query} = $q if (defined $q);
448 return $self->{_query};
454 $self->{_parse_tree} = $q if (defined $q);
455 return $self->{_parse_tree};
460 my $pkg = ref($self) || $self;
461 warn " ** parse package is $pkg\n" if $self->debug;
464 $self->query( shift() )
473 my $pkg = ref($self) || $self;
475 warn " ** decompose package is $pkg\n" if $self->debug;
478 my $current_class = shift || $self->default_search_class;
480 my $recursing = shift || 0;
481 my $phrase_helper = shift || 0;
483 # Build the search class+field uber-regexp
484 my $search_class_re = '^\s*(';
488 for my $class ( keys %{$pkg->search_field_aliases} ) {
489 warn " *** ... Looking for search fields in $class\n" if $self->debug;
491 for my $field ( keys %{$pkg->search_field_aliases->{$class}} ) {
492 warn " *** ... Looking for aliases of $field\n" if $self->debug;
494 for my $alias ( @{$pkg->search_field_aliases->{$class}{$field}} ) {
495 my $aliasr = qr/$alias/;
496 s/(^|\s+)$aliasr\|/$1$class\|$field#$alias\|/g;
497 s/(^|\s+)$aliasr[:=]/$1$class\|$field#$alias:/g;
498 warn " *** Rewriting: $alias ($aliasr) as $class\|$field\n" if $self->debug;
502 $search_class_re .= '|' unless ($first_class);
504 $search_class_re .= $class . '(?:[|#][^:|]+)*';
505 $seen_classes{$class} = 1;
508 for my $class ( keys %{$pkg->search_class_aliases} ) {
510 for my $alias ( @{$pkg->search_class_aliases->{$class}} ) {
511 my $aliasr = qr/$alias/;
512 s/(^|[^|])\b$aliasr\|/$1$class#$alias\|/g;
513 s/(^|[^|])\b$aliasr[:=]/$1$class#$alias:/g;
514 warn " *** Rewriting: $alias ($aliasr) as $class\n" if $self->debug;
517 if (!$seen_classes{$class}) {
518 $search_class_re .= '|' unless ($first_class);
521 $search_class_re .= $class . '(?:[|#][^:|]+)*';
522 $seen_classes{$class} = 1;
525 $search_class_re .= '):';
527 warn " ** Rewritten query: $_\n" if $self->debug;
528 warn " ** Search class RE: $search_class_re\n" if $self->debug;
530 my $required_re = $pkg->operator('required');
531 $required_re = qr/\Q$required_re\E/;
533 my $disallowed_re = $pkg->operator('disallowed');
534 $disallowed_re = qr/\Q$disallowed_re\E/;
536 my $and_re = $pkg->operator('and');
537 $and_re = qr/^\s*\Q$and_re\E/;
539 my $or_re = $pkg->operator('or');
540 $or_re = qr/^\s*\Q$or_re\E/;
542 my $group_start_re = $pkg->operator('group_start');
543 $group_start_re = qr/^\s*\Q$group_start_re\E/;
545 my $group_end = $pkg->operator('group_end');
546 my $group_end_re = qr/^\s*\Q$group_end\E/;
548 my $modifier_tag_re = $pkg->operator('modifier');
549 $modifier_tag_re = qr/^\s*\Q$modifier_tag_re\E/;
552 # Build the filter and modifier uber-regexps
553 my $facet_re = '^\s*(-?)((?:' . join( '|', @{$pkg->facet_classes}) . ')(?:\|\w+)*)\[(.+?)\]';
554 warn " ** Facet RE: $facet_re\n" if $self->debug;
556 my $filter_re = '^\s*(-?)(' . join( '|', @{$pkg->filters}) . ')\(([^()]+)\)';
557 my $filter_as_class_re = '^\s*(-?)(' . join( '|', @{$pkg->filters}) . '):\s*(\S+)';
559 my $modifier_re = '^\s*'.$modifier_tag_re.'(' . join( '|', @{$pkg->modifiers}) . ')\b';
560 my $modifier_as_class_re = '^\s*(' . join( '|', @{$pkg->modifiers}) . '):\s*(\S+)';
562 my $struct = $self->new_plan( level => $recursing );
566 while (!$remainder) {
567 if (/^\s*$/) { # end of an explicit group
569 } elsif (/$group_end_re/) { # end of an explicit group
570 warn "Encountered explicit group end\n" if $self->debug;
573 $remainder = $struct->top_plan ? '' : $';
576 } elsif ($self->filter_count && /$filter_re/) { # found a filter
577 warn "Encountered search filter: $1$2 set to $3\n" if $self->debug;
579 my $negate = ($1 eq $pkg->operator('disallowed')) ? 1 : 0;
583 my $params = [ split '[,]+', $3 ];
585 if ($pkg->filter_callbacks->{$filter}) {
586 my $replacement = $pkg->filter_callbacks->{$filter}->($self, $struct, $filter, $params, $negate);
587 $_ = "$replacement $_" if ($replacement);
589 $struct->new_filter( $filter => $params, $negate );
594 } elsif ($self->filter_count && /$filter_as_class_re/) { # found a filter
595 warn "Encountered search filter: $1$2 set to $3\n" if $self->debug;
597 my $negate = ($1 eq $pkg->operator('disallowed')) ? 1 : 0;
601 my $params = [ split '[,]+', $3 ];
603 if ($pkg->filter_callbacks->{$filter}) {
604 my $replacement = $pkg->filter_callbacks->{$filter}->($self, $struct, $filter, $params, $negate);
605 $_ = "$replacement $_" if ($replacement);
607 $struct->new_filter( $filter => $params, $negate );
611 } elsif ($self->modifier_count && /$modifier_re/) { # found a modifier
612 warn "Encountered search modifier: $1\n" if $self->debug;
615 if (!$struct->top_plan) {
616 warn " Search modifiers only allowed at the top level of the query\n" if $self->debug;
618 $struct->new_modifier($1);
622 } elsif ($self->modifier_count && /$modifier_as_class_re/) { # found a modifier
623 warn "Encountered search modifier: $1\n" if $self->debug;
628 if (!$struct->top_plan) {
629 warn " Search modifiers only allowed at the top level of the query\n" if $self->debug;
630 } elsif ($2 =~ /^[ty1]/i) {
631 $struct->new_modifier($mod);
635 } elsif (/$group_start_re/) { # start of an explicit group
636 warn "Encountered explicit group start\n" if $self->debug;
638 my ($substruct, $subremainder) = $self->decompose( $', $current_class, $recursing + 1 );
639 $struct->add_node( $substruct ) if ($substruct);
643 } elsif (/$and_re/) { # ANDed expression
645 next if ($last_type eq 'AND');
646 next if ($last_type eq 'OR');
647 warn "Encountered AND\n" if $self->debug;
649 $struct->joiner( '&' );
652 } elsif (/$or_re/) { # ORed expression
654 next if ($last_type eq 'AND');
655 next if ($last_type eq 'OR');
656 warn "Encountered OR\n" if $self->debug;
658 $struct->joiner( '|' );
661 } elsif ($self->facet_class_count && /$facet_re/) { # changing current class
662 warn "Encountered facet: $1$2 => $3\n" if $self->debug;
664 my $negate = ($1 eq $pkg->operator('disallowed')) ? 1 : 0;
666 my $facet_value = [ split '\s*#\s*', $3 ];
667 $struct->new_facet( $facet => $facet_value, $negate );
671 } elsif ($self->search_class_count && /$search_class_re/) { # changing current class
673 if ($last_type eq 'CLASS') {
674 $struct->remove_last_node( $current_class );
675 warn "Encountered class change with no searches!\n" if $self->debug;
678 warn "Encountered class change: $1\n" if $self->debug;
680 $current_class = $struct->classed_node( $1 )->requested_class();
683 $last_type = 'CLASS';
684 } elsif (/^\s*($required_re|$disallowed_re)?"([^"]+)"/) { # phrase, always anded
685 warn 'Encountered' . ($1 ? " ['$1' modified]" : '') . " phrase: $2\n" if $self->debug;
687 my $req_ness = $1 || '';
690 if (!$phrase_helper) {
691 warn "Recursing into decompose with the phrase as a subquery\n" if $self->debug;
693 my ($substruct, $subremainder) = $self->decompose( qq/$req_ness"$phrase"/, $current_class, $recursing + 1, 1 );
694 $struct->add_node( $substruct ) if ($substruct);
697 warn "Directly parsing the phrase subquery\n" if $self->debug;
698 $struct->joiner( '&' );
700 my $class_node = $struct->classed_node($current_class);
702 if ($req_ness eq $pkg->operator('disallowed')) {
703 $class_node->add_dummy_atom( node => $class_node );
704 $class_node->add_unphrase( $phrase );
706 #$phrase =~ s/(^|\s)\b/$1-/g;
708 $class_node->add_phrase( $phrase );
716 # } elsif (/^\s*$required_re([^\s"]+)/) { # phrase, always anded
717 # warn "Encountered required atom (mini phrase): $1\n" if $self->debug;
721 # my $class_node = $struct->classed_node($current_class);
722 # $class_node->add_phrase( $phrase );
724 # $struct->joiner( '&' );
727 } elsif (/^\s*([^$group_end\s]+)/o) { # atom
728 warn "Encountered atom: $1\n" if $self->debug;
729 warn "Remainder: $'\n" if $self->debug;
737 my $class_node = $struct->classed_node($current_class);
739 my $prefix = ($atom =~ s/^$disallowed_re//o) ? '!' : '';
740 my $truncate = ($atom =~ s/\*$//o) ? '*' : '';
742 if ($atom ne '' and !grep { $atom =~ /^\Q$_\E+$/ } ('&','|','-','+')) { # throw away & and |, not allowed in tsquery, and not really useful anyway
743 # $class_node->add_phrase( $atom ) if ($atom =~ s/^$required_re//o);
744 # $class_node->add_unphrase( $atom ) if ($prefix eq '!');
746 $class_node->add_fts_atom( $atom, suffix => $truncate, prefix => $prefix, node => $class_node );
747 $struct->joiner( '&' );
756 scalar(@{$struct->query_nodes}) == 0 &&
757 scalar(@{$struct->filters}) == 0 &&
760 return $struct if !wantarray;
761 return ($struct, $remainder);
764 sub find_class_index {
768 my ($class_part, @field_parts) = split '\|', $class;
769 $class_part ||= $class;
771 for my $idx ( 0 .. scalar(@$query) - 1 ) {
772 next unless ref($$query[$idx]);
773 return $idx if ( $$query[$idx]{requested_class} && $class eq $$query[$idx]{requested_class} );
776 push(@$query, { classname => $class_part, (@field_parts ? (fields => \@field_parts) : ()), requested_class => $class, ftsquery => [], phrases => [] });
783 $self->{core_limit} = $l if ($l);
784 return $self->{core_limit};
790 $self->{superpage} = $l if ($l);
791 return $self->{superpage};
797 $self->{superpage_size} = $l if ($l);
798 return $self->{superpage_size};
802 #-------------------------------
803 package QueryParser::_util;
805 # At this level, joiners are always & or |. This is not
806 # the external, configurable representation of joiners that
807 # defaults to # && and ||.
811 return (not ref $str and ($str eq '&' or $str eq '|'));
814 sub default_joiner { '&' }
816 # 0 for different, 1 for the same.
817 sub compare_abstract_atoms {
818 my ($left, $right) = @_;
820 foreach (qw/prefix suffix content/) {
821 no warnings; # undef can stand in for '' here
822 return 0 unless $left->{$_} eq $right->{$_};
828 sub fake_abstract_atom_from_phrase {
829 my ($phrase, $neg) = @_;
834 $QueryParser::parser_config{QueryParser}{operators}{disallowed} .
839 "type" => "atom", "prefix" => $prefix, "suffix" => '"',
844 sub find_arrays_in_abstract {
848 foreach my $key (keys %$hash) {
849 if (ref $hash->{$key} eq "ARRAY") {
850 push @arrays, $hash->{$key};
851 foreach (@{$hash->{$key}}) {
852 push @arrays, find_arrays_in_abstract($_);
860 #-------------------------------
861 package QueryParser::Canonicalize; # not OO
863 sub _abstract_query2str_filter {
865 my $qpconfig = $parser_config{QueryParser};
869 $f->{negate} ? $qpconfig->{operators}{disallowed} : "",
871 join(",", @{$f->{args}})
875 sub _abstract_query2str_modifier {
877 my $qpconfig = $parser_config{QueryParser};
879 return $qpconfig->{operators}{modifier} . $f;
882 # This should produce an equivalent query to the original, given an
884 sub abstract_query2str_impl {
885 my ($abstract_query, $depth) = @_;
887 my $qpconfig = $parser_config{QueryParser};
889 my $gs = $qpconfig->{operators}{group_start};
890 my $ge = $qpconfig->{operators}{group_end};
891 my $and = $qpconfig->{operators}{and};
892 my $or = $qpconfig->{operators}{or};
895 $q .= $gs if $abstract_query->{type} and $abstract_query->{type} eq "query_plan" and $depth;
897 if (exists $abstract_query->{type}) {
898 if ($abstract_query->{type} eq 'query_plan') {
899 $q .= join(" ", map { _abstract_query2str_filter($_) } @{$abstract_query->{filters}}) if
900 exists $abstract_query->{filters};
903 $q .= join(" ", map { _abstract_query2str_modifier($_) } @{$abstract_query->{modifiers}}) if
904 exists $abstract_query->{modifiers};
905 } elsif ($abstract_query->{type} eq 'node') {
906 if ($abstract_query->{alias}) {
907 $q .= " " . $abstract_query->{alias};
908 $q .= "|$_" foreach @{$abstract_query->{alias_fields}};
910 $q .= " " . $abstract_query->{class};
911 $q .= "|$_" foreach @{$abstract_query->{fields}};
914 } elsif ($abstract_query->{type} eq 'atom') {
915 my $prefix = $abstract_query->{prefix} || '';
916 $prefix = $qpconfig->{operators}{disallowed} if $prefix eq '!';
918 ($abstract_query->{content} || '') .
919 ($abstract_query->{suffix} || '');
920 } elsif ($abstract_query->{type} eq 'facet') {
921 # facet syntax [ # ] is hardcoded I guess?
922 my $prefix = $abstract_query->{negate} ? $qpconfig->{operators}{disallowed} : '';
923 $q .= $prefix . $abstract_query->{name} . "[" .
924 join(" # ", @{$abstract_query->{values}}) . "]";
928 if (exists $abstract_query->{children}) {
929 my $op = (keys(%{$abstract_query->{children}}))[0];
931 " " . ($op eq '&' ? $and : $or) . " ",
933 abstract_query2str_impl($_, $depth + 1)
934 } @{$abstract_query->{children}{$op}}
936 } elsif ($abstract_query->{'&'} or $abstract_query->{'|'}) {
937 my $op = (keys(%{$abstract_query}))[0];
939 " " . ($op eq '&' ? $and : $or) . " ",
941 abstract_query2str_impl($_, $depth + 1)
942 } @{$abstract_query->{$op}}
947 $q .= $ge if $abstract_query->{type} and $abstract_query->{type} eq "query_plan" and $depth;
952 #-------------------------------
953 package QueryParser::query_plan;
957 return undef unless ref($self);
958 return $self->{QueryParser};
963 $pkg = ref($pkg) || $pkg;
964 my %args = (query => [], joiner => '&', @_);
966 return bless \%args => $pkg;
971 my $pkg = ref($self) || $self;
972 my $node = do{$pkg.'::node'}->new( plan => $self, @_ );
973 $self->add_node( $node );
979 my $pkg = ref($self) || $self;
984 my $node = do{$pkg.'::facet'}->new( plan => $self, name => $name, 'values' => $args, negate => $negate );
985 $self->add_node( $node );
992 my $pkg = ref($self) || $self;
997 my $node = do{$pkg.'::filter'}->new( plan => $self, name => $name, args => $args, negate => $negate );
998 $self->add_filter( $node );
1004 sub _merge_filters {
1005 my $left_filter = shift;
1006 my $right_filter = shift;
1009 return undef unless $left_filter or $right_filter;
1010 return $right_filter unless $left_filter;
1011 return $left_filter unless $right_filter;
1013 my $args = $left_filter->{args} || [];
1016 push(@$args, @{$right_filter->{args}});
1019 # find the intersect values
1021 map { $new_vals{$_} = 1 } @{$right_filter->{args} || []};
1022 $args = [ grep { $new_vals{$_} } @$args ];
1025 $left_filter->{args} = $args;
1026 return $left_filter;
1029 sub collapse_filters {
1033 # start by merging any filters at this level.
1034 # like-level filters are always ORed together
1037 my @cur_filters = grep {$_->name eq $name } @{ $self->filters };
1039 $cur_filter = shift @cur_filters;
1040 my $args = $cur_filter->{args} || [];
1041 $cur_filter = _merge_filters($cur_filter, $_, '|') for @cur_filters;
1044 # next gather the collapsed filters from sub-plans and
1045 # merge them with our own
1047 my @subquery = @{$self->{query}};
1050 my $blob = shift @subquery;
1051 shift @subquery; # joiner
1052 next unless $blob->isa('QueryParser::query_plan');
1053 my $sub_filter = $blob->collapse_filters($name);
1054 $cur_filter = _merge_filters($cur_filter, $sub_filter, $self->joiner);
1057 if ($self->QueryParser->debug) {
1058 my @args = ($cur_filter and $cur_filter->{args}) ? @{$cur_filter->{args}} : ();
1059 warn "collapse_filters($name) => [@args]\n";
1067 my $needle = shift;;
1068 return undef unless ($needle);
1070 my $filter = $self->collapse_filters($needle);
1072 warn "find_filter($needle) => " .
1073 (($filter and $filter->{args}) ? "@{$filter->{args}}" : '[]') . "\n"
1074 if $self->QueryParser->debug;
1076 return $filter ? ($filter) : ();
1081 my $needle = shift;;
1082 return undef unless ($needle);
1083 return grep { $_->name eq $needle } @{ $self->modifiers };
1088 my $pkg = ref($self) || $self;
1091 my $node = do{$pkg.'::modifier'}->new( $name );
1092 $self->add_modifier( $node );
1099 my $requested_class = shift;
1102 for my $n (@{$self->{query}}) {
1103 next unless (ref($n) && $n->isa( 'QueryParser::query_plan::node' ));
1104 if ($n->requested_class eq $requested_class) {
1111 $node = $self->new_node;
1112 $node->requested_class( $requested_class );
1118 sub remove_last_node {
1120 my $requested_class = shift;
1122 my $old = pop(@{$self->query_nodes});
1123 pop(@{$self->query_nodes}) if (@{$self->query_nodes});
1130 return $self->{query};
1137 $self->{query} ||= [];
1138 push(@{$self->{query}}, $self->joiner) if (@{$self->{query}});
1139 push(@{$self->{query}}, $node);
1147 return $self->{level} ? 0 : 1;
1152 return $self->{level};
1159 $self->{joiner} = $joiner if ($joiner);
1160 return $self->{joiner};
1165 $self->{modifiers} ||= [];
1166 return $self->{modifiers};
1171 my $modifier = shift;
1173 $self->{modifiers} ||= [];
1174 $self->{modifiers} = [ grep {$_->name ne $modifier->name} @{$self->{modifiers}} ];
1176 push(@{$self->{modifiers}}, $modifier);
1183 $self->{facets} ||= [];
1184 return $self->{facets};
1191 $self->{facets} ||= [];
1192 $self->{facets} = [ grep {$_->name ne $facet->name} @{$self->{facets}} ];
1194 push(@{$self->{facets}}, $facet);
1201 $self->{filters} ||= [];
1202 return $self->{filters};
1209 $self->{filters} ||= [];
1211 push(@{$self->{filters}}, $filter);
1216 # %opts supports two options at this time:
1218 # If true, do not do anything to the phrases and unphrases
1219 # fields on any discovered nodes.
1221 # If true, also return the query parser config as part of the blob.
1222 # This will get set back to 0 before recursion to avoid repetition.
1223 sub to_abstract_query {
1227 my $pkg = ref $self->QueryParser || $self->QueryParser;
1229 my $abstract_query = {
1230 type => "query_plan",
1231 filters => [map { $_->to_abstract_query } @{$self->filters}],
1232 modifiers => [map { $_->to_abstract_query } @{$self->modifiers}]
1235 if ($opts{with_config}) {
1236 $opts{with_config} = 0;
1237 $abstract_query->{config} = $QueryParser::parser_config{$pkg};
1242 for my $qnode (@{$self->query_nodes}) {
1243 # Remember: qnode can be a joiner string, a node, or another query_plan
1245 if (QueryParser::_util::is_joiner($qnode)) {
1246 if ($abstract_query->{children}) {
1247 my $open_joiner = (keys(%{$abstract_query->{children}}))[0];
1248 next if $open_joiner eq $qnode;
1250 my $oldroot = $abstract_query->{children};
1252 $abstract_query->{children} = {$qnode => $kids};
1254 $abstract_query->{children} = {$qnode => $kids};
1257 push @$kids, $qnode->to_abstract_query(%opts);
1261 $abstract_query->{children} ||= { QueryParser::_util::default_joiner() => $kids };
1262 return $abstract_query;
1266 #-------------------------------
1267 package QueryParser::query_plan::node;
1269 $Data::Dumper::Indent = 0;
1273 $pkg = ref($pkg) || $pkg;
1276 return bless \%args => $pkg;
1281 my $pkg = ref($self) || $self;
1282 return do{$pkg.'::atom'}->new( @_ );
1285 sub requested_class { # also split into classname, fields and alias
1291 my (undef, $alias) = split '#', $class;
1293 $class =~ s/#[^|]+//;
1294 ($alias, @afields) = split '\|', $alias;
1297 my @fields = @afields;
1298 my ($class_part, @field_parts) = split '\|', $class;
1299 for my $f (@field_parts) {
1300 push(@fields, $f) unless (grep { $f eq $_ } @fields);
1303 $class_part ||= $class;
1305 $self->{requested_class} = $class;
1306 $self->{alias} = $alias if $alias;
1307 $self->{alias_fields} = \@afields if $alias;
1308 $self->{classname} = $class_part;
1309 $self->{fields} = \@fields;
1312 return $self->{requested_class};
1319 $self->{plan} = $plan if ($plan);
1320 return $self->{plan};
1327 $self->{alias} = $alias if ($alias);
1328 return $self->{alias};
1335 $self->{alias_fields} = $alias if ($alias);
1336 return $self->{alias_fields};
1343 $self->{classname} = $class if ($class);
1344 return $self->{classname};
1351 $self->{fields} ||= [];
1352 $self->{fields} = \@fields if (@fields);
1353 return $self->{fields};
1360 $self->{phrases} ||= [];
1361 $self->{phrases} = \@phrases if (@phrases);
1362 return $self->{phrases};
1369 $self->{unphrases} ||= [];
1370 $self->{unphrases} = \@phrases if (@phrases);
1371 return $self->{unphrases};
1378 push(@{$self->phrases}, $phrase);
1387 push(@{$self->unphrases}, $phrase);
1394 my @query_atoms = @_;
1396 $self->{query_atoms} ||= [];
1397 $self->{query_atoms} = \@query_atoms if (@query_atoms);
1398 return $self->{query_atoms};
1406 my $content = $atom;
1409 $atom = $self->new_atom( content => $content, @parts );
1412 push(@{$self->query_atoms}, $self->plan->joiner) if (@{$self->query_atoms});
1413 push(@{$self->query_atoms}, $atom);
1418 sub add_dummy_atom {
1422 my $atom = $self->new_atom( @parts, dummy => 1 );
1424 push(@{$self->query_atoms}, $self->plan->joiner) if (@{$self->query_atoms});
1425 push(@{$self->query_atoms}, $atom);
1430 # This will find up to one occurence of @$short_list within @$long_list, and
1431 # replace it with the single atom $replacement.
1432 sub replace_phrase_in_abstract_query {
1433 my ($self, $short_list, $long_list, $replacement) = @_;
1437 my $goal = scalar @$short_list;
1439 for (my $i = 0; $i < scalar (@$long_list); $i++) {
1440 my $right = $long_list->[$i];
1442 if (QueryParser::_util::compare_abstract_atoms(
1443 $short_list->[scalar @already], $right
1446 } elsif (scalar @already) {
1451 if (scalar @already == $goal) {
1452 splice @$long_list, $already[0], scalar(@already), $replacement;
1461 sub to_abstract_query {
1465 my $pkg = ref $self->plan->QueryParser || $self->plan->QueryParser;
1467 my $abstract_query = {
1469 "alias" => $self->alias,
1470 "alias_fields" => $self->alias_fields,
1471 "class" => $self->classname,
1472 "fields" => $self->fields
1477 for my $qatom (@{$self->query_atoms}) {
1478 if (QueryParser::_util::is_joiner($qatom)) {
1479 if ($abstract_query->{children}) {
1480 my $open_joiner = (keys(%{$abstract_query->{children}}))[0];
1481 next if $open_joiner eq $qatom;
1483 my $oldroot = $abstract_query->{children};
1485 $abstract_query->{children} = {$qatom => $kids};
1487 $abstract_query->{children} = {$qatom => $kids};
1490 push @$kids, $qatom->to_abstract_query;
1494 if ($self->{phrases} and not $opts{no_phrases}) {
1495 for my $phrase (@{$self->{phrases}}) {
1496 # Phrases appear duplication in a real QP tree, and we don't want
1497 # that duplication in our abstract query. So for all our phrases,
1498 # break them into atoms as QP would, and remove any matching
1499 # sequences of atoms from our abstract query.
1501 my $tmptree = $self->{plan}->{QueryParser}->new(query => '"'.$phrase.'"')->parse->parse_tree;
1503 # For a well-behaved phrase, we should now have only one node
1504 # in the $tmptree query plan, and that node should have an
1505 # orderly list of atoms and joiners.
1507 if ($tmptree->{query} and scalar(@{$tmptree->{query}}) == 1) {
1511 $tmplist = $tmptree->{query}->[0]->to_abstract_query(
1513 )->{children}->{'&'}->[0]->{children}->{'&'};
1518 QueryParser::_util::find_arrays_in_abstract($abstract_query->{children})
1520 last if $self->replace_phrase_in_abstract_query(
1523 QueryParser::_util::fake_abstract_atom_from_phrase($phrase)
1531 # Do the same as the preceding block for unphrases (negated phrases).
1532 if ($self->{unphrases} and not $opts{no_phrases}) {
1533 for my $phrase (@{$self->{unphrases}}) {
1534 my $tmptree = $self->{plan}->{QueryParser}->new(
1535 query => $QueryParser::parser_config{$pkg}{operators}{disallowed}.
1537 )->parse->parse_tree;
1540 if ($tmptree->{query} and scalar(@{$tmptree->{query}}) == 1) {
1544 $tmplist = $tmptree->{query}->[0]->to_abstract_query(
1546 )->{children}->{'&'}->[0]->{children}->{'&'};
1551 QueryParser::_util::find_arrays_in_abstract($abstract_query->{children})
1553 last if $self->replace_phrase_in_abstract_query(
1556 QueryParser::_util::fake_abstract_atom_from_phrase($phrase, 1)
1564 $abstract_query->{children} ||= { QueryParser::_util::default_joiner() => $kids };
1565 return $abstract_query;
1568 #-------------------------------
1569 package QueryParser::query_plan::node::atom;
1573 $pkg = ref($pkg) || $pkg;
1576 return bless \%args => $pkg;
1581 return undef unless (ref $self);
1582 return $self->{node};
1587 return undef unless (ref $self);
1588 return $self->{content};
1593 return undef unless (ref $self);
1594 return $self->{prefix};
1599 return undef unless (ref $self);
1600 return $self->{suffix};
1603 sub to_abstract_query {
1607 (map { $_ => $self->$_ } qw/prefix suffix content/),
1611 #-------------------------------
1612 package QueryParser::query_plan::filter;
1616 $pkg = ref($pkg) || $pkg;
1619 return bless \%args => $pkg;
1624 return $self->{plan};
1629 return $self->{name};
1634 return $self->{negate};
1639 return $self->{args};
1642 sub to_abstract_query {
1646 map { $_ => $self->$_ } qw/name negate args/
1650 #-------------------------------
1651 package QueryParser::query_plan::facet;
1655 $pkg = ref($pkg) || $pkg;
1658 return bless \%args => $pkg;
1663 return $self->{plan};
1668 return $self->{name};
1673 return $self->{negate};
1678 return $self->{'values'};
1681 sub to_abstract_query {
1685 (map { $_ => $self->$_ } qw/name negate values/),
1690 #-------------------------------
1691 package QueryParser::query_plan::modifier;
1695 $pkg = ref($pkg) || $pkg;
1696 my $modifier = shift;
1699 return bless { name => $modifier, negate => $negate } => $pkg;
1704 return $self->{name};
1709 return $self->{negate};
1712 sub to_abstract_query {