4 package OpenILS::QueryParser;
9 OpenILS::QueryParser - basic QueryParser class
13 use OpenILS::QueryParser;
14 my $QParser = OpenILS::QueryParser->new(%args);
18 Main entrypoint into the QueryParser functionality.
24 # Note that the first key must match the name of the package.
25 our %parser_config = (
26 'OpenILS::QueryParser' => {
46 return OpenILS::QueryParser::Canonicalize::abstract_query2str_impl(
47 $self->parse_tree->to_abstract_query(@_)
52 =head2 facet_class_count
54 $count = $QParser->facet_class_count();
57 sub facet_class_count {
59 return @{$self->facet_classes};
62 =head2 search_class_count
64 $count = $QParser->search_class_count();
67 sub search_class_count {
69 return @{$self->search_classes};
74 $count = $QParser->filter_count();
79 return @{$self->filters};
84 $count = $QParser->modifier_count();
89 return @{$self->modifiers};
94 $data = $QParser->custom_data($class);
99 $class = ref($class) || $class;
101 $parser_config{$class}{custom_data} ||= {};
102 return $parser_config{$class}{custom_data};
107 $operators = $QParser->operators();
109 Returns hashref of the configured operators.
114 $class = ref($class) || $class;
116 $parser_config{$class}{operators} ||= {};
117 return $parser_config{$class}{operators};
120 sub allow_nested_modifiers {
123 $class = ref($class) || $class;
125 $parser_config{$class}{allow_nested_modifiers} = $v if (defined $v);
126 return $parser_config{$class}{allow_nested_modifiers};
131 $filters = $QParser->filters();
133 Returns arrayref of the configured filters.
138 $class = ref($class) || $class;
140 $parser_config{$class}{filters} ||= [];
141 return $parser_config{$class}{filters};
144 =head2 filter_callbacks
146 $filter_callbacks = $QParser->filter_callbacks();
148 Returns hashref of the configured filter callbacks.
151 sub filter_callbacks {
153 $class = ref($class) || $class;
155 $parser_config{$class}{filter_callbacks} ||= {};
156 return $parser_config{$class}{filter_callbacks};
161 $modifiers = $QParser->modifiers();
163 Returns arrayref of the configured modifiers.
168 $class = ref($class) || $class;
170 $parser_config{$class}{modifiers} ||= [];
171 return $parser_config{$class}{modifiers};
176 $QParser = OpenILS::QueryParser->new(%args);
178 Creates a new QueryParser object.
183 $class = ref($class) || $class;
187 my $self = bless {} => $class;
189 for my $o (keys %{OpenILS::QueryParser->operators}) {
190 $class->operator($o => OpenILS::QueryParser->operator($o)) unless ($class->operator($o));
193 for my $opt ( keys %opts) {
194 $self->$opt( $opts{$opt} ) if ($self->can($opt));
202 $query_plan = $QParser->new_plan();
204 Create a new query plan.
209 my $pkg = ref($self) || $self;
210 return do{$pkg.'::query_plan'}->new( QueryParser => $self, @_ );
213 =head2 add_search_filter
215 $QParser->add_search_filter($filter, [$callback]);
217 Adds a filter with the specified name and an optional callback to the
218 QueryParser configuration.
221 sub add_search_filter {
223 $pkg = ref($pkg) || $pkg;
225 my $callback = shift;
227 return $filter if (grep { $_ eq $filter } @{$pkg->filters});
228 push @{$pkg->filters}, $filter;
229 $pkg->filter_callbacks->{$filter} = $callback if ($callback);
233 =head2 add_search_modifier
235 $QParser->add_search_modifier($modifier);
237 Adds a modifier with the specified name to the QueryParser configuration.
240 sub add_search_modifier {
242 $pkg = ref($pkg) || $pkg;
243 my $modifier = shift;
245 return $modifier if (grep { $_ eq $modifier } @{$pkg->modifiers});
246 push @{$pkg->modifiers}, $modifier;
250 =head2 add_facet_class
252 $QParser->add_facet_class($facet_class);
254 Adds a facet class with the specified name to the QueryParser configuration.
257 sub add_facet_class {
259 $pkg = ref($pkg) || $pkg;
262 return $class if (grep { $_ eq $class } @{$pkg->facet_classes});
264 push @{$pkg->facet_classes}, $class;
265 $pkg->facet_fields->{$class} = [];
270 =head2 add_search_class
272 $QParser->add_search_class($class);
274 Adds a search class with the specified name to the QueryParser configuration.
277 sub add_search_class {
279 $pkg = ref($pkg) || $pkg;
282 return $class if (grep { $_ eq $class } @{$pkg->search_classes});
284 push @{$pkg->search_classes}, $class;
285 $pkg->search_fields->{$class} = [];
286 $pkg->default_search_class( $pkg->search_classes->[0] ) if (@{$pkg->search_classes} == 1);
291 =head2 add_search_modifier
293 $op = $QParser->operator($operator, [$newvalue]);
295 Retrieves or sets value for the specified operator. Valid operators and
296 their defaults are as follows:
304 =item * group_start => (
306 =item * group_end => )
308 =item * required => +
310 =item * disallowed => -
312 =item * modifier => #
320 $class = ref($class) || $class;
324 return unless ($opname);
326 $parser_config{$class}{operators} ||= {};
327 $parser_config{$class}{operators}{$opname} = $op if ($op);
329 return $parser_config{$class}{operators}{$opname};
334 $classes = $QParser->facet_classes([\@newclasses]);
336 Returns arrayref of all configured facet classes after optionally
337 replacing configuration.
342 $class = ref($class) || $class;
345 $parser_config{$class}{facet_classes} ||= [];
346 $parser_config{$class}{facet_classes} = $classes if (ref($classes) && @$classes);
347 return $parser_config{$class}{facet_classes};
350 =head2 search_classes
352 $classes = $QParser->search_classes([\@newclasses]);
354 Returns arrayref of all configured search classes after optionally
355 replacing the previous configuration.
360 $class = ref($class) || $class;
363 $parser_config{$class}{classes} ||= [];
364 $parser_config{$class}{classes} = $classes if (ref($classes) && @$classes);
365 return $parser_config{$class}{classes};
368 =head2 add_query_normalizer
370 $function = $QParser->add_query_normalizer($class, $field, $func, [\@params]);
374 sub add_query_normalizer {
376 $pkg = ref($pkg) || $pkg;
380 my $params = shift || [];
382 # do not add if function AND params are identical to existing member
383 return $func if (grep {
384 $_->{function} eq $func and
385 to_json($_->{params}) eq to_json($params)
386 } @{$pkg->query_normalizers->{$class}->{$field}});
388 push(@{$pkg->query_normalizers->{$class}->{$field}}, { function => $func, params => $params });
393 =head2 query_normalizers
395 $normalizers = $QParser->query_normalizers($class, $field);
397 Returns a list of normalizers associated with the specified search class
401 sub query_normalizers {
403 $pkg = ref($pkg) || $pkg;
408 $parser_config{$pkg}{normalizers} ||= {};
411 $parser_config{$pkg}{normalizers}{$class}{$field} ||= [];
412 return $parser_config{$pkg}{normalizers}{$class}{$field};
414 return $parser_config{$pkg}{normalizers}{$class};
418 return $parser_config{$pkg}{normalizers};
421 =head2 add_filter_normalizer
423 $normalizer = $QParser->add_filter_normalizer($filter, $func, [\@params]);
425 Adds a normalizer function to the specified filter.
428 sub add_filter_normalizer {
430 $pkg = ref($pkg) || $pkg;
433 my $params = shift || [];
435 return $func if (grep { $_ eq $func } @{$pkg->filter_normalizers->{$filter}});
437 push(@{$pkg->filter_normalizers->{$filter}}, { function => $func, params => $params });
442 =head2 filter_normalizers
444 $normalizers = $QParser->filter_normalizers($filter);
446 Return arrayref of normalizer functions associated with the specified filter.
449 sub filter_normalizers {
451 $pkg = ref($pkg) || $pkg;
455 $parser_config{$pkg}{filter_normalizers} ||= {};
457 $parser_config{$pkg}{filter_normalizers}{$filter} ||= [];
458 return $parser_config{$pkg}{filter_normalizers}{$filter};
461 return $parser_config{$pkg}{filter_normalizers};
464 =head2 default_search_class
466 $default_class = $QParser->default_search_class([$class]);
468 Set or return the default search class.
471 sub default_search_class {
473 $pkg = ref($pkg) || $pkg;
475 $OpenILS::QueryParser::parser_config{$pkg}{default_class} = $pkg->add_search_class( $class ) if $class;
477 return $OpenILS::QueryParser::parser_config{$pkg}{default_class};
480 =head2 remove_facet_class
482 $QParser->remove_facet_class($class);
484 Remove the specified facet class from the configuration.
487 sub remove_facet_class {
489 $pkg = ref($pkg) || $pkg;
492 return $class if (!grep { $_ eq $class } @{$pkg->facet_classes});
494 $pkg->facet_classes( [ grep { $_ ne $class } @{$pkg->facet_classes} ] );
495 delete $OpenILS::QueryParser::parser_config{$pkg}{facet_fields}{$class};
500 =head2 remove_search_class
502 $QParser->remove_search_class($class);
504 Remove the specified search class from the configuration.
507 sub remove_search_class {
509 $pkg = ref($pkg) || $pkg;
512 return $class if (!grep { $_ eq $class } @{$pkg->search_classes});
514 $pkg->search_classes( [ grep { $_ ne $class } @{$pkg->search_classes} ] );
515 delete $OpenILS::QueryParser::parser_config{$pkg}{fields}{$class};
520 =head2 add_facet_field
522 $QParser->add_facet_field($class, $field);
524 Adds the specified field (and facet class if it doesn't already exist)
525 to the configuration.
528 sub add_facet_field {
530 $pkg = ref($pkg) || $pkg;
534 $pkg->add_facet_class( $class );
536 return { $class => $field } if (grep { $_ eq $field } @{$pkg->facet_fields->{$class}});
538 push @{$pkg->facet_fields->{$class}}, $field;
540 return { $class => $field };
545 $fields = $QParser->facet_fields($class);
547 Returns arrayref with list of fields for specified facet class.
552 $class = ref($class) || $class;
554 $parser_config{$class}{facet_fields} ||= {};
555 return $parser_config{$class}{facet_fields};
558 =head2 add_search_field
560 $QParser->add_search_field($class, $field);
562 Adds the specified field (and facet class if it doesn't already exist)
563 to the configuration.
566 sub add_search_field {
568 $pkg = ref($pkg) || $pkg;
572 $pkg->add_search_class( $class );
574 return { $class => $field } if (grep { $_ eq $field } @{$pkg->search_fields->{$class}});
576 push @{$pkg->search_fields->{$class}}, $field;
578 return { $class => $field };
583 $fields = $QParser->search_fields();
585 Returns arrayref with list of configured search fields.
590 $class = ref($class) || $class;
592 $parser_config{$class}{fields} ||= {};
593 return $parser_config{$class}{fields};
596 =head2 add_search_class_alias
598 $QParser->add_search_class_alias($class, $alias);
601 sub add_search_class_alias {
603 $pkg = ref($pkg) || $pkg;
607 $pkg->add_search_class( $class );
609 return { $class => $alias } if (grep { $_ eq $alias } @{$pkg->search_class_aliases->{$class}});
611 push @{$pkg->search_class_aliases->{$class}}, $alias;
613 return { $class => $alias };
616 =head2 search_class_aliases
618 $aliases = $QParser->search_class_aliases($class);
621 sub search_class_aliases {
623 $class = ref($class) || $class;
625 $parser_config{$class}{class_map} ||= {};
626 return $parser_config{$class}{class_map};
629 =head2 add_search_field_alias
631 $QParser->add_search_field_alias($class, $field, $alias);
634 sub add_search_field_alias {
636 $pkg = ref($pkg) || $pkg;
641 return { $class => { $field => $alias } } if (grep { $_ eq $alias } @{$pkg->search_field_aliases->{$class}{$field}});
643 push @{$pkg->search_field_aliases->{$class}{$field}}, $alias;
645 return { $class => { $field => $alias } };
648 =head2 search_field_aliases
650 $aliases = $QParser->search_field_aliases();
653 sub search_field_aliases {
655 $class = ref($class) || $class;
657 $parser_config{$class}{field_alias_map} ||= {};
658 return $parser_config{$class}{field_alias_map};
661 =head2 remove_facet_field
663 $QParser->remove_facet_field($class, $field);
666 sub remove_facet_field {
668 $pkg = ref($pkg) || $pkg;
672 return { $class => $field } if (!$pkg->facet_fields->{$class} || !grep { $_ eq $field } @{$pkg->facet_fields->{$class}});
674 $pkg->facet_fields->{$class} = [ grep { $_ ne $field } @{$pkg->facet_fields->{$class}} ];
676 return { $class => $field };
679 =head2 remove_search_field
681 $QParser->remove_search_field($class, $field);
684 sub remove_search_field {
686 $pkg = ref($pkg) || $pkg;
690 return { $class => $field } if (!$pkg->search_fields->{$class} || !grep { $_ eq $field } @{$pkg->search_fields->{$class}});
692 $pkg->search_fields->{$class} = [ grep { $_ ne $field } @{$pkg->search_fields->{$class}} ];
694 return { $class => $field };
697 =head2 remove_search_field_alias
699 $QParser->remove_search_field_alias($class, $field, $alias);
702 sub remove_search_field_alias {
704 $pkg = ref($pkg) || $pkg;
709 return { $class => { $field => $alias } } if (!$pkg->search_field_aliases->{$class}{$field} || !grep { $_ eq $alias } @{$pkg->search_field_aliases->{$class}{$field}});
711 $pkg->search_field_aliases->{$class}{$field} = [ grep { $_ ne $alias } @{$pkg->search_field_aliases->{$class}{$field}} ];
713 return { $class => { $field => $alias } };
716 =head2 remove_search_class_alias
718 $QParser->remove_search_class_alias($class, $alias);
721 sub remove_search_class_alias {
723 $pkg = ref($pkg) || $pkg;
727 return { $class => $alias } if (!$pkg->search_class_aliases->{$class} || !grep { $_ eq $alias } @{$pkg->search_class_aliases->{$class}});
729 $pkg->search_class_aliases->{$class} = [ grep { $_ ne $alias } @{$pkg->search_class_aliases->{$class}} ];
731 return { $class => $alias };
736 $debug = $QParser->debug([$debug]);
738 Return or set whether debugging output is enabled.
744 $self->{_debug} = $q if (defined $q);
745 return $self->{_debug};
750 $query = $QParser->query([$query]);
752 Return or set the query.
758 $self->{_query} = " $q " if (defined $q);
759 return $self->{_query};
764 $parse_tree = $QParser->parse_tree([$parse_tree]);
766 Return or set the parse tree associated with the QueryParser.
772 $self->{_parse_tree} = $q if (defined $q);
773 return $self->{_parse_tree};
779 $self->{_top} = $q if (defined $q);
780 return $self->{_top};
785 $QParser->parse([$query]);
787 Parse the specified query, or the query already associated with the QueryParser
793 my $pkg = ref($self) || $self;
794 warn " ** parse package is $pkg\n" if $self->debug;
797 # $self->query( shift() )
801 undef $self->{_parse_tree};
803 $self->decompose( $self->query( shift() ) );
805 if ($self->floating_plan) {
806 $self->floating_plan->add_node( $self->parse_tree );
807 $self->parse_tree( $self->floating_plan );
810 $self->parse_tree->plan_level(0);
817 ($struct, $remainder) = $QParser->decompose($querystring, [$current_class], [$recursing], [$phrase_helper]);
819 This routine does the heavy work of parsing the query string recursively.
820 Returns the top level query plan, or the query plan from a lower level plus
821 the portion of the query string that needs to be processed at a higher level.
824 our $last_class = '';
831 my $pkg = ref($self) || $self;
835 my $current_class = shift || $self->default_search_class;
837 my $recursing = shift || 0;
838 my $phrase_helper = shift || 0;
840 # Build the search class+field uber-regexp
841 my $search_class_re = '^\s*(';
844 warn ' 'x$recursing." ** decompose package is $pkg\n" if $self->debug;
847 for my $class ( keys %{$pkg->search_field_aliases} ) {
848 warn ' 'x$recursing." *** ... Looking for search fields in $class\n" if $self->debug;
850 for my $field ( keys %{$pkg->search_field_aliases->{$class}} ) {
851 warn ' 'x$recursing." *** ... Looking for aliases of $field\n" if $self->debug;
853 for my $alias ( @{$pkg->search_field_aliases->{$class}{$field}} ) {
854 next unless ($alias);
855 my $aliasr = qr/$alias/;
856 s/(^|\s+)$aliasr\|/$1$class\|$field#$alias\|/g;
857 s/(^|\s+)$aliasr[:=]/$1$class\|$field#$alias:/g;
858 warn ' 'x$recursing." *** Rewriting: $alias ($aliasr) as $class\|$field\n" if $self->debug;
862 $search_class_re .= '|' unless ($first_class);
864 $search_class_re .= $class . '(?:[|#][^:|]+)*';
865 $seen_classes{$class} = 1;
868 for my $class ( keys %{$pkg->search_class_aliases} ) {
870 for my $alias ( @{$pkg->search_class_aliases->{$class}} ) {
871 next unless ($alias);
872 my $aliasr = qr/$alias/;
873 s/(^|[^|])\b$aliasr\|/$1$class#$alias\|/g;
874 s/(^|[^|])\b$aliasr[:=]/$1$class#$alias:/g;
875 warn ' 'x$recursing." *** Rewriting: $alias ($aliasr) as $class\n" if $self->debug;
878 if (!$seen_classes{$class}) {
879 $search_class_re .= '|' unless ($first_class);
882 $search_class_re .= $class . '(?:[|#][^:|]+)*';
883 $seen_classes{$class} = 1;
886 $search_class_re .= '):';
888 warn ' 'x$recursing." ** Rewritten query: $_\n" if $self->debug;
889 warn ' 'x$recursing." ** Search class RE: $search_class_re\n" if $self->debug;
891 my $required_op = $pkg->operator('required');
892 my $required_re = qr/\Q$required_op\E/;
894 my $disallowed_op = $pkg->operator('disallowed');
895 my $disallowed_re = qr/\Q$disallowed_op\E/;
897 my $negated_op = $pkg->operator('negated');
898 my $negated_re = qr/\Q$negated_op\E/;
900 my $and_op = $pkg->operator('and');
901 my $and_re = qr/^\s*\Q$and_op\E/;
903 my $or_op = $pkg->operator('or');
904 my $or_re = qr/^\s*\Q$or_op\E/;
906 my $group_start = $pkg->operator('group_start');
907 my $group_start_re = qr/^\s*($negated_re|$disallowed_re)?\Q$group_start\E/;
909 my $group_end = $pkg->operator('group_end');
910 my $group_end_re = qr/^\s*\Q$group_end\E/;
912 my $float_start = $pkg->operator('float_start');
913 my $float_start_re = qr/^\s*\Q$float_start\E/;
915 my $float_end = $pkg->operator('float_end');
916 my $float_end_re = qr/^\s*\Q$float_end\E/;
918 my $modifier_tag = $pkg->operator('modifier');
919 my $modifier_tag_re = qr/^\s*\Q$modifier_tag\E/;
921 # Group start/end normally are ( and ), but can be overridden.
922 # We thus include ( and ) specifically due to filters, as well as : for classes.
923 my $phrase_cleanup_re = qr/\s*(\Q$required_op\E|\Q$disallowed_op\E|\Q$and_op\E|\Q$or_op\E|\Q$group_start\E|\Q$group_end\E|\Q$float_start\E|\Q$float_end\E|\Q$modifier_tag\E|\Q$negated_op\E|:|\(|\))/;
925 # Build the filter and modifier uber-regexps
926 my $facet_re = '^\s*(-?)((?:' . join( '|', @{$pkg->facet_classes}) . ')(?:\|\w+)*)\[(.+?)\]';
927 warn ' 'x$recursing." ** Facet RE: $facet_re\n" if $self->debug;
929 my $filter_re = '^\s*(-?)(' . join( '|', @{$pkg->filters}) . ')\(([^()]+)\)';
930 my $filter_as_class_re = '^\s*(-?)(' . join( '|', @{$pkg->filters}) . '):\s*(\S+)';
932 my $modifier_re = '^\s*'.$modifier_tag_re.'(' . join( '|', @{$pkg->modifiers}) . ')\b';
933 my $modifier_as_class_re = '^\s*(' . join( '|', @{$pkg->modifiers}) . '):\s*(\S+)';
935 my $struct = shift || $self->new_plan( level => $recursing );
936 $self->parse_tree( $struct ) if (!$self->parse_tree);
940 while (!$remainder) {
941 warn ' 'x$recursing."Start of the loop. last_type: $last_type, joiner: ".$struct->joiner.", struct: $struct\n" if $self->debug;
942 if ($last_type eq 'FEND' and $fstart and $fstart != $struct) { # fall back further
945 } elsif ($last_type eq 'FEND') {
950 if (/^\s*$/) { # end of an explicit group
951 local $last_type = '';
953 } elsif (/$float_end_re/) { # end of an explicit group
954 warn ' 'x$recursing."Encountered explicit float end, remainder: $'\n" if $self->debug;
962 } elsif (/$group_end_re/) { # end of an explicit group
963 warn ' 'x$recursing."Encountered explicit group end, remainder: $'\n" if $self->debug;
968 local $last_type = '';
969 } elsif ($self->filter_count && /$filter_re/) { # found a filter
970 warn ' 'x$recursing."Encountered search filter: $1$2 set to $3\n" if $self->debug;
972 my $negate = ($1 eq $pkg->operator('disallowed')) ? 1 : 0;
976 my $params = [ split '[,]+', $3 ];
978 if ($pkg->filter_callbacks->{$filter}) {
979 my $replacement = $pkg->filter_callbacks->{$filter}->($self, $struct, $filter, $params, $negate);
980 $_ = "$replacement $_" if ($replacement);
982 $struct->new_filter( $filter => $params, $negate );
986 local $last_type = '';
987 } elsif ($self->filter_count && /$filter_as_class_re/) { # found a filter
988 warn ' 'x$recursing."Encountered search filter: $1$2 set to $3\n" if $self->debug;
990 my $negate = ($1 eq $pkg->operator('disallowed')) ? 1 : 0;
994 my $params = [ split '[,]+', $3 ];
996 if ($pkg->filter_callbacks->{$filter}) {
997 my $replacement = $pkg->filter_callbacks->{$filter}->($self, $struct, $filter, $params, $negate);
998 $_ = "$replacement $_" if ($replacement);
1000 $struct->new_filter( $filter => $params, $negate );
1003 local $last_type = '';
1004 } elsif ($self->modifier_count && /$modifier_re/) { # found a modifier
1005 warn ' 'x$recursing."Encountered search modifier: $1\n" if $self->debug;
1008 if (!($struct->top_plan || $parser_config{$pkg}->{allow_nested_modifiers})) {
1009 warn ' 'x$recursing." Search modifiers only allowed at the top level of the query\n" if $self->debug;
1011 $struct->new_modifier($1);
1014 local $last_type = '';
1015 } elsif ($self->modifier_count && /$modifier_as_class_re/) { # found a modifier
1016 warn ' 'x$recursing."Encountered search modifier: $1\n" if $self->debug;
1021 if (!($struct->top_plan || $parser_config{$pkg}->{allow_nested_modifiers})) {
1022 warn ' 'x$recursing." Search modifiers only allowed at the top level of the query\n" if $self->debug;
1023 } elsif ($2 =~ /^[ty1]/i) {
1024 $struct->new_modifier($mod);
1027 local $last_type = '';
1028 } elsif (/$float_start_re/) { # start of an explicit float
1029 warn ' 'x$recursing."Encountered explicit float start\n" if $self->debug;
1033 $last_class = $current_class;
1034 $current_class = undef;
1036 $self->floating_plan( $self->new_plan( floating => 1 ) ) if (!$self->floating_plan);
1038 # pass the floating_plan struct to be modified by the float'ed chunk
1039 my ($floating_plan, $subremainder) = $self->new( debug => $self->debug )->decompose( $', undef, undef, undef, $self->floating_plan);
1041 warn ' 'x$recursing."Remainder after explicit float: $_\n" if $self->debug;
1043 $current_class = $last_class;
1046 } elsif (/$group_start_re/) { # start of an explicit group
1047 warn ' 'x$recursing."Encountered explicit group start\n" if $self->debug;
1049 my ($substruct, $subremainder) = $self->decompose( $', $current_class, $recursing + 1 );
1050 $substruct->negate(1) if ($substruct && $negate);
1051 $struct->add_node( $substruct ) if ($substruct);
1053 warn ' 'x$recursing."Query remainder after bool group: $_\n" if $self->debug;
1055 local $last_type = '';
1057 } elsif (/$and_re/) { # ANDed expression
1059 warn ' 'x$recursing."Encountered AND\n" if $self->debug;
1060 do {warn ' 'x$recursing."!!! Already doing the bool dance for AND\n" if $self->debug; next} if ($last_type eq 'AND');
1061 do {warn ' 'x$recursing."!!! Already doing the bool dance for OR\n" if $self->debug; next} if ($last_type eq 'OR');
1062 local $last_type = 'AND';
1064 warn ' 'x$recursing."Saving LHS, building RHS\n" if $self->debug;
1066 #my ($RHS, $subremainder) = $self->decompose( "$group_start $_ $group_end", $current_class, $recursing + 1 );
1067 my ($RHS, $subremainder) = $self->decompose( $_, $current_class, $recursing + 1 );
1070 warn ' 'x$recursing."RHS built\n" if $self->debug;
1071 warn ' 'x$recursing."Post-AND remainder: $subremainder\n" if $self->debug;
1073 my $wrapper = $self->new_plan( level => $recursing + 1 );
1075 if ($LHS->floating) {
1076 $wrapper->{query} = $LHS->{query};
1077 my $outer_wrapper = $self->new_plan( level => $recursing + 1 );
1078 $outer_wrapper->add_node($_) for ($wrapper,$RHS);
1079 $LHS->{query} = [$outer_wrapper];
1082 $wrapper->add_node($_) for ($LHS, $RHS);
1083 $wrapper->plan_level($wrapper->plan_level); # reset levels all the way down
1084 $struct = $self->new_plan( level => $recursing );
1085 $struct->add_node($wrapper);
1088 $self->parse_tree( $struct ) if ($self->parse_tree == $LHS);
1090 local $last_type = '';
1091 } elsif (/$or_re/) { # ORed expression
1093 warn ' 'x$recursing."Encountered OR\n" if $self->debug;
1094 do {warn ' 'x$recursing."!!! Already doing the bool dance for AND\n" if $self->debug; next} if ($last_type eq 'AND');
1095 do {warn ' 'x$recursing."!!! Already doing the bool dance for OR\n" if $self->debug; next} if ($last_type eq 'OR');
1096 local $last_type = 'OR';
1098 warn ' 'x$recursing."Saving LHS, building RHS\n" if $self->debug;
1100 #my ($RHS, $subremainder) = $self->decompose( "$group_start $_ $group_end", $current_class, $recursing + 1 );
1101 my ($RHS, $subremainder) = $self->decompose( $_, $current_class, $recursing + 2 );
1104 warn ' 'x$recursing."RHS built\n" if $self->debug;
1105 warn ' 'x$recursing."Post-OR remainder: $subremainder\n" if $self->debug;
1107 my $wrapper = $self->new_plan( level => $recursing + 1, joiner => '|' );
1109 if ($LHS->floating) {
1110 $wrapper->{query} = $LHS->{query};
1111 my $outer_wrapper = $self->new_plan( level => $recursing + 1, joiner => '|' );
1112 $outer_wrapper->add_node($_) for ($wrapper,$RHS);
1113 $LHS->{query} = [$outer_wrapper];
1116 $wrapper->add_node($_) for ($LHS, $RHS);
1117 $wrapper->plan_level($wrapper->plan_level); # reset levels all the way down
1118 $struct = $self->new_plan( level => $recursing );
1119 $struct->add_node($wrapper);
1122 $self->parse_tree( $struct ) if ($self->parse_tree == $LHS);
1124 local $last_type = '';
1125 } elsif ($self->facet_class_count && /$facet_re/) { # changing current class
1126 warn ' 'x$recursing."Encountered facet: $1$2 => $3\n" if $self->debug;
1128 my $negate = ($1 eq $pkg->operator('disallowed')) ? 1 : 0;
1130 my $facet_value = [ split '\s*#\s*', $3 ];
1131 $struct->new_facet( $facet => $facet_value, $negate );
1134 local $last_type = '';
1135 } elsif ($self->search_class_count && /$search_class_re/) { # changing current class
1137 if ($last_type eq 'CLASS') {
1138 $struct->remove_last_node( $current_class );
1139 warn ' 'x$recursing."Encountered class change with no searches!\n" if $self->debug;
1142 warn ' 'x$recursing."Encountered class change: $1\n" if $self->debug;
1144 $current_class = $struct->classed_node( $1 )->requested_class();
1147 local $last_type = 'CLASS';
1148 } elsif (/^\s*($required_re|$disallowed_re|$negated_re)?"([^"]+)"/) { # phrase, always anded
1149 warn ' 'x$recursing.'Encountered' . ($1 ? " ['$1' modified]" : '') . " phrase: $2\n" if $self->debug;
1151 my $req_ness = $1 || '';
1152 $req_ness = $disallowed_op if ($req_ness eq $negated_op);
1155 if (!$phrase_helper) {
1156 warn ' 'x$recursing."Recursing into decompose with the phrase as a subquery\n" if $self->debug;
1158 my ($substruct, $subremainder) = $self->decompose( qq/$req_ness"$phrase"/, $current_class, $recursing + 1, 1 );
1159 $struct->add_node( $substruct ) if ($substruct);
1162 warn ' 'x$recursing."Directly parsing the phrase subquery\n" if $self->debug;
1163 $struct->joiner( '&' );
1165 my $class_node = $struct->classed_node($current_class);
1167 if ($req_ness eq $disallowed_op) {
1168 $class_node->negate(1);
1170 $class_node->add_phrase( $phrase );
1172 # Save $' before we clean up $phrase
1175 # Cleanup the phrase to make it so that we don't parse things in it as anything other than atoms
1176 $phrase =~ s/$phrase_cleanup_re/ /g;
1182 local $last_type = '';
1184 } elsif (/^\s*($required_re|$disallowed_re)([^${group_end}${float_end}\s"]+)/) { # convert require/disallow word to {un}phrase
1185 warn ' 'x$recursing."Encountered required atom (mini phrase), transforming for phrase parse: $1\n" if $self->debug;
1187 $_ = $1 . '"' . $2 . '"' . $';
1189 local $last_type = '';
1190 } elsif (/^\s*([^${group_end}${float_end}\s]+)/o) { # atom
1191 warn ' 'x$recursing."Encountered atom: $1\n" if $self->debug;
1192 warn ' 'x$recursing."Remainder: $'\n" if $self->debug;
1198 local $last_type = '';
1200 my $class_node = $struct->classed_node($current_class);
1202 my $prefix = ($atom =~ s/^$negated_re//o) ? '!' : '';
1203 my $truncate = ($atom =~ s/\*$//o) ? '*' : '';
1205 if ($atom ne '' and !grep { $atom =~ /^\Q$_\E+$/ } ('&','|')) { # throw away & and |, not allowed in tsquery, and not really useful anyway
1206 # $class_node->add_phrase( $atom ) if ($atom =~ s/^$required_re//o);
1208 $class_node->add_fts_atom( $atom, suffix => $truncate, prefix => $prefix, node => $class_node );
1209 $struct->joiner( '&' );
1212 local $last_type = '';
1220 scalar(@{$struct->query_nodes}) == 0 &&
1221 scalar(@{$struct->filters}) == 0 &&
1224 return $struct if !wantarray;
1225 return ($struct, $remainder);
1228 =head2 find_class_index
1230 $index = $QParser->find_class_index($class, $query);
1233 sub find_class_index {
1237 my ($class_part, @field_parts) = split '\|', $class;
1238 $class_part ||= $class;
1240 for my $idx ( 0 .. scalar(@$query) - 1 ) {
1241 next unless ref($$query[$idx]);
1242 return $idx if ( $$query[$idx]{requested_class} && $class eq $$query[$idx]{requested_class} );
1245 push(@$query, { classname => $class_part, (@field_parts ? (fields => \@field_parts) : ()), requested_class => $class, ftsquery => [], phrases => [] });
1251 $limit = $QParser->core_limit([$limit]);
1253 Return and/or set the core_limit.
1259 $self->{core_limit} = $l if ($l);
1260 return $self->{core_limit};
1265 $superpage = $QParser->superpage([$superpage]);
1267 Return and/or set the superpage.
1273 $self->{superpage} = $l if ($l);
1274 return $self->{superpage};
1277 =head2 superpage_size
1279 $size = $QParser->superpage_size([$size]);
1281 Return and/or set the superpage size.
1284 sub superpage_size {
1287 $self->{superpage_size} = $l if ($l);
1288 return $self->{superpage_size};
1292 #-------------------------------
1293 package OpenILS::QueryParser::_util;
1295 # At this level, joiners are always & or |. This is not
1296 # the external, configurable representation of joiners that
1297 # defaults to # && and ||.
1301 return (not ref $str and ($str eq '&' or $str eq '|'));
1304 sub default_joiner { '&' }
1306 # 0 for different, 1 for the same.
1307 sub compare_abstract_atoms {
1308 my ($left, $right) = @_;
1310 foreach (qw/prefix suffix content/) {
1311 no warnings; # undef can stand in for '' here
1312 return 0 unless $left->{$_} eq $right->{$_};
1318 sub fake_abstract_atom_from_phrase {
1321 my $qp_class = shift || 'OpenILS::QueryParser';
1326 $OpenILS::QueryParser::parser_config{$qp_class}{operators}{disallowed} .
1331 "type" => "atom", "prefix" => $prefix, "suffix" => '"',
1332 "content" => $phrase
1336 sub find_arrays_in_abstract {
1340 foreach my $key (keys %$hash) {
1341 if (ref $hash->{$key} eq "ARRAY") {
1342 push @arrays, $hash->{$key};
1343 foreach (@{$hash->{$key}}) {
1344 push @arrays, find_arrays_in_abstract($_);
1352 #-------------------------------
1353 package OpenILS::QueryParser::Canonicalize; # not OO
1356 sub _abstract_query2str_filter {
1358 my $qp_class = shift || 'OpenILS::QueryParser';
1359 my $qpconfig = $OpenILS::QueryParser::parser_config{$qp_class};
1363 $f->{negate} ? $qpconfig->{operators}{disallowed} : "",
1365 join(",", @{$f->{args}})
1369 sub _abstract_query2str_modifier {
1371 my $qp_class = shift || 'OpenILS::QueryParser';
1372 my $qpconfig = $OpenILS::QueryParser::parser_config{$qp_class};
1374 return $qpconfig->{operators}{modifier} . $f;
1378 my $children = shift;
1379 my $op = (keys %$children)[0];
1380 return @{$$children{$op}};
1384 # This should produce an equivalent query to the original, given an
1386 sub abstract_query2str_impl {
1387 my $abstract_query = shift;
1388 my $depth = shift || 0;
1390 my $qp_class ||= shift || 'OpenILS::QueryParser';
1391 my $force_qp_node = shift || 0;
1392 my $qpconfig = $OpenILS::QueryParser::parser_config{$qp_class};
1394 my $fs = $qpconfig->{operators}{float_start};
1395 my $fe = $qpconfig->{operators}{float_end};
1396 my $gs = $qpconfig->{operators}{group_start};
1397 my $ge = $qpconfig->{operators}{group_end};
1398 my $and = $qpconfig->{operators}{and};
1399 my $or = $qpconfig->{operators}{or};
1400 my $ng = $qpconfig->{operators}{negated};
1407 if (exists $abstract_query->{type}) {
1408 if ($abstract_query->{type} eq 'query_plan') {
1409 $q .= join(" ", map { _abstract_query2str_filter($_, $qp_class) } @{$abstract_query->{filters}}) if
1410 exists $abstract_query->{filters};
1412 $q .= ($q ? ' ' : '') . join(" ", map { _abstract_query2str_modifier($_, $qp_class) } @{$abstract_query->{modifiers}}) if
1413 exists $abstract_query->{modifiers};
1415 $size = _kid_list($abstract_query->{children});
1416 if ($abstract_query->{negate}) {
1420 $isnode = 1 if ($size > 1 and ($force_qp_node or $depth));
1421 #warn "size: $size, depth: $depth, isnode: $isnode, AQ: ".Dumper($abstract_query);
1422 } elsif ($abstract_query->{type} eq 'node') {
1423 if ($abstract_query->{alias}) {
1424 $q .= ($q ? ' ' : '') . $abstract_query->{alias};
1425 $q .= "|$_" foreach @{$abstract_query->{alias_fields}};
1427 $q .= ($q ? ' ' : '') . $abstract_query->{class};
1428 $q .= "|$_" foreach @{$abstract_query->{fields}};
1432 } elsif ($abstract_query->{type} eq 'atom') {
1433 my $prefix = $abstract_query->{prefix} || '';
1434 $prefix = $qpconfig->{operators}{negated} if $prefix eq '!';
1435 $q .= ($q ? ' ' : '') . $prefix .
1436 ($abstract_query->{content} || '') .
1437 ($abstract_query->{suffix} || '');
1438 } elsif ($abstract_query->{type} eq 'facet') {
1439 # facet syntax [ # ] is hardcoded I guess?
1440 my $prefix = $abstract_query->{negate} ? $qpconfig->{operators}{disallowed} : '';
1441 $q .= ($q ? ' ' : '') . $prefix . $abstract_query->{name} . "[" .
1442 join(" # ", @{$abstract_query->{values}}) . "]";
1446 my $next_depth = int($size > 1);
1448 if (exists $abstract_query->{children}) {
1450 my $op = (keys(%{$abstract_query->{children}}))[0];
1452 if ($abstract_query->{floating}) { # always the top node!
1453 my $sub_node = pop @{$abstract_query->{children}{$op}};
1455 $abstract_query->{floating} = 0;
1456 $q = $fs . " " . abstract_query2str_impl($abstract_query,0,$qp_class, 1) . $fe. " ";
1458 $abstract_query = $sub_node;
1461 if ($abstract_query && exists $abstract_query->{children}) {
1462 $op = (keys(%{$abstract_query->{children}}))[0];
1463 $q .= ($q ? ' ' : '') . join(
1464 ($op eq '&' ? ' ' : " $or "),
1466 my $x = abstract_query2str_impl($_, $depth + $next_depth, $qp_class, $force_qp_node); $x =~ s/^\s+//; $x =~ s/\s+$//; $x;
1467 } @{$abstract_query->{children}{$op}}
1470 } elsif ($abstract_query->{'&'} or $abstract_query->{'|'}) {
1471 my $op = (keys(%{$abstract_query}))[0];
1472 $q .= ($q ? ' ' : '') . join(
1473 ($op eq '&' ? ' ' : " $or "),
1475 my $x = abstract_query2str_impl($_, $depth + $next_depth, $qp_class, $force_qp_node); $x =~ s/^\s+//; $x =~ s/\s+$//; $x;
1476 } @{$abstract_query->{$op}}
1480 $q = "$gs$q$ge" if ($isnode);
1481 $q = $negate . $q if ($q);;
1486 #-------------------------------
1487 package OpenILS::QueryParser::query_plan;
1491 return unless ref($self);
1492 return $self->{QueryParser};
1497 $pkg = ref($pkg) || $pkg;
1498 my %args = (query => [], joiner => '&', @_);
1500 return bless \%args => $pkg;
1505 my $pkg = ref($self) || $self;
1506 my $node = do{$pkg.'::node'}->new( plan => $self, @_ );
1507 $self->add_node( $node );
1513 my $pkg = ref($self) || $self;
1518 my $node = do{$pkg.'::facet'}->new( plan => $self, name => $name, 'values' => $args, negate => $negate );
1519 $self->add_node( $node );
1526 my $pkg = ref($self) || $self;
1531 my $node = do{$pkg.'::filter'}->new( plan => $self, name => $name, args => $args, negate => $negate );
1532 $self->add_filter( $node );
1538 sub _merge_filters {
1539 my $left_filter = shift;
1540 my $right_filter = shift;
1543 return unless $left_filter or $right_filter;
1544 return $right_filter unless $left_filter;
1545 return $left_filter unless $right_filter;
1547 my $args = $left_filter->{args} || [];
1550 push(@$args, @{$right_filter->{args}});
1553 # find the intersect values
1555 map { $new_vals{$_} = 1 } @{$right_filter->{args} || []};
1556 $args = [ grep { $new_vals{$_} } @$args ];
1559 $left_filter->{args} = $args;
1560 return $left_filter;
1563 sub collapse_filters {
1567 # start by merging any filters at this level.
1568 # like-level filters are always ORed together
1571 my @cur_filters = grep {$_->name eq $name } @{ $self->filters };
1573 $cur_filter = shift @cur_filters;
1574 my $args = $cur_filter->{args} || [];
1575 $cur_filter = _merge_filters($cur_filter, $_, '|') for @cur_filters;
1578 # next gather the collapsed filters from sub-plans and
1579 # merge them with our own
1581 my @subquery = @{$self->{query}};
1584 my $blob = shift @subquery;
1585 shift @subquery; # joiner
1586 next unless $blob->isa('OpenILS::QueryParser::query_plan');
1587 my $sub_filter = $blob->collapse_filters($name);
1588 $cur_filter = _merge_filters($cur_filter, $sub_filter, $self->joiner);
1591 if ($self->QueryParser->debug) {
1592 my @args = ($cur_filter and $cur_filter->{args}) ? @{$cur_filter->{args}} : ();
1593 warn "collapse_filters($name) => [@args]\n";
1601 my $needle = shift;;
1602 return unless ($needle);
1604 my $filter = $self->collapse_filters($needle);
1606 warn "find_filter($needle) => " .
1607 (($filter and $filter->{args}) ? "@{$filter->{args}}" : '[]') . "\n"
1608 if $self->QueryParser->debug;
1610 return $filter ? ($filter) : ();
1615 my $needle = shift;;
1616 return unless ($needle);
1617 return grep { $_->name eq $needle } @{ $self->modifiers };
1622 my $pkg = ref($self) || $self;
1625 my $node = do{$pkg.'::modifier'}->new( $name );
1626 $self->add_modifier( $node );
1633 my $requested_class = shift;
1636 for my $n (@{$self->{query}}) {
1637 next unless (ref($n) && $n->isa( 'OpenILS::QueryParser::query_plan::node' ));
1638 if ($n->requested_class eq $requested_class) {
1645 $node = $self->new_node;
1646 $node->requested_class( $requested_class );
1652 sub remove_last_node {
1654 my $requested_class = shift;
1656 my $old = pop(@{$self->query_nodes});
1657 pop(@{$self->query_nodes}) if (@{$self->query_nodes});
1664 return $self->{query};
1670 $self->{floating} = $f if (defined $f);
1671 return $self->{floating};
1678 $self->{query} ||= [];
1679 push(@{$self->{query}}, $self->joiner) if (@{$self->{query}});
1680 push(@{$self->{query}}, $node);
1688 return $self->{level} ? 0 : 1;
1695 if (defined $level) {
1696 $self->{level} = $level;
1697 for (@{$self->query_nodes}) {
1698 $_->plan_level($level + 1) if (ref and $_->isa('OpenILS::QueryParser::query_plan'));
1702 return $self->{level};
1709 $self->{joiner} = $joiner if ($joiner);
1710 return $self->{joiner};
1715 $self->{modifiers} ||= [];
1716 return $self->{modifiers};
1721 my $modifier = shift;
1723 $self->{modifiers} ||= [];
1724 $self->{modifiers} = [ grep {$_->name ne $modifier->name} @{$self->{modifiers}} ];
1726 push(@{$self->{modifiers}}, $modifier);
1733 $self->{facets} ||= [];
1734 return $self->{facets};
1741 $self->{facets} ||= [];
1742 $self->{facets} = [ grep {$_->name ne $facet->name} @{$self->{facets}} ];
1744 push(@{$self->{facets}}, $facet);
1751 $self->{filters} ||= [];
1752 return $self->{filters};
1759 $self->{filters} ||= [];
1761 push(@{$self->{filters}}, $filter);
1770 $self->{negate} = $negate if (defined $negate);
1772 return $self->{negate};
1775 # %opts supports two options at this time:
1777 # If true, do not do anything to the phrases
1778 # fields on any discovered nodes.
1780 # If true, also return the query parser config as part of the blob.
1781 # This will get set back to 0 before recursion to avoid repetition.
1782 sub to_abstract_query {
1786 my $pkg = ref $self->QueryParser || $self->QueryParser;
1788 my $abstract_query = {
1789 type => "query_plan",
1790 floating => $self->floating,
1791 level => $self->plan_level,
1792 filters => [map { $_->to_abstract_query } @{$self->filters}],
1793 modifiers => [map { $_->to_abstract_query } @{$self->modifiers}],
1794 negate => $self->negate
1797 if ($opts{with_config}) {
1798 $opts{with_config} = 0;
1799 $abstract_query->{config} = $OpenILS::QueryParser::parser_config{$pkg};
1804 for my $qnode (@{$self->query_nodes}) {
1805 # Remember: qnode can be a joiner string, a node, or another query_plan
1807 if (OpenILS::QueryParser::_util::is_joiner($qnode)) {
1808 if ($abstract_query->{children}) {
1809 my $open_joiner = (keys(%{$abstract_query->{children}}))[0];
1810 next if $open_joiner eq $qnode;
1812 my $oldroot = $abstract_query->{children};
1814 $abstract_query->{children} = {$qnode => $kids};
1816 $abstract_query->{children} = {$qnode => $kids};
1819 push @$kids, $qnode->to_abstract_query(%opts);
1823 $abstract_query->{children} ||= { OpenILS::QueryParser::_util::default_joiner() => $kids };
1824 return $abstract_query;
1828 #-------------------------------
1829 package OpenILS::QueryParser::query_plan::node;
1831 $Data::Dumper::Indent = 0;
1835 $pkg = ref($pkg) || $pkg;
1838 return bless \%args => $pkg;
1843 my $pkg = ref($self) || $self;
1844 return do{$pkg.'::atom'}->new( @_ );
1847 sub requested_class { # also split into classname, fields and alias
1853 my (undef, $alias) = split '#', $class;
1855 $class =~ s/#[^|]+//;
1856 ($alias, @afields) = split '\|', $alias;
1859 my @fields = @afields;
1860 my ($class_part, @field_parts) = split '\|', $class;
1861 for my $f (@field_parts) {
1862 push(@fields, $f) unless (grep { $f eq $_ } @fields);
1865 $class_part ||= $class;
1867 $self->{requested_class} = $class;
1868 $self->{alias} = $alias if $alias;
1869 $self->{alias_fields} = \@afields if $alias;
1870 $self->{classname} = $class_part;
1871 $self->{fields} = \@fields;
1874 return $self->{requested_class};
1881 $self->{plan} = $plan if ($plan);
1882 return $self->{plan};
1889 $self->{alias} = $alias if ($alias);
1890 return $self->{alias};
1897 $self->{alias_fields} = $alias if ($alias);
1898 return $self->{alias_fields};
1905 $self->{classname} = $class if ($class);
1906 return $self->{classname};
1913 $self->{fields} ||= [];
1914 $self->{fields} = \@fields if (@fields);
1915 return $self->{fields};
1922 $self->{phrases} ||= [];
1923 $self->{phrases} = \@phrases if (@phrases);
1924 return $self->{phrases};
1931 push(@{$self->phrases}, $phrase);
1940 $self->{negate} = $negate if (defined $negate);
1942 return $self->{negate};
1947 my @query_atoms = @_;
1949 $self->{query_atoms} ||= [];
1950 $self->{query_atoms} = \@query_atoms if (@query_atoms);
1951 return $self->{query_atoms};
1959 my $content = $atom;
1962 $atom = $self->new_atom( content => $content, @parts );
1965 push(@{$self->query_atoms}, $self->plan->joiner) if (@{$self->query_atoms});
1966 push(@{$self->query_atoms}, $atom);
1971 sub add_dummy_atom {
1975 my $atom = $self->new_atom( @parts, dummy => 1 );
1977 push(@{$self->query_atoms}, $self->plan->joiner) if (@{$self->query_atoms});
1978 push(@{$self->query_atoms}, $atom);
1983 # This will find up to one occurence of @$short_list within @$long_list, and
1984 # replace it with the single atom $replacement.
1985 sub replace_phrase_in_abstract_query {
1986 my ($self, $short_list, $long_list, $replacement) = @_;
1990 my $goal = scalar @$short_list;
1992 for (my $i = 0; $i < scalar (@$long_list); $i++) {
1993 my $right = $long_list->[$i];
1995 if (OpenILS::QueryParser::_util::compare_abstract_atoms(
1996 $short_list->[scalar @already], $right
1999 } elsif (scalar @already) {
2004 if (scalar @already == $goal) {
2005 splice @$long_list, $already[0], scalar(@already), $replacement;
2014 sub to_abstract_query {
2018 my $pkg = ref $self->plan->QueryParser || $self->plan->QueryParser;
2020 my $abstract_query = {
2022 "alias" => $self->alias,
2023 "alias_fields" => $self->alias_fields,
2024 "class" => $self->classname,
2025 "fields" => $self->fields
2030 for my $qatom (@{$self->query_atoms}) {
2031 if (OpenILS::QueryParser::_util::is_joiner($qatom)) {
2032 if ($abstract_query->{children}) {
2033 my $open_joiner = (keys(%{$abstract_query->{children}}))[0];
2034 next if $open_joiner eq $qatom;
2036 my $oldroot = $abstract_query->{children};
2038 $abstract_query->{children} = {$qatom => $kids};
2040 $abstract_query->{children} = {$qatom => $kids};
2043 push @$kids, $qatom->to_abstract_query;
2047 $abstract_query->{children} ||= { OpenILS::QueryParser::_util::default_joiner() => $kids };
2049 if ($self->{phrases} and not $opts{no_phrases}) {
2050 for my $phrase (@{$self->{phrases}}) {
2051 # Phrases appear duplication in a real QP tree, and we don't want
2052 # that duplication in our abstract query. So for all our phrases,
2053 # break them into atoms as QP would, and remove any matching
2054 # sequences of atoms from our abstract query.
2056 my $tmp_prefix = '';
2057 $tmp_prefix = $OpenILS::QueryParser::parser_config{$pkg}{operators}{disallowed} if ($self->{negate});
2059 my $tmptree = $self->{plan}->{QueryParser}->new(query => $tmp_prefix.'"'.$phrase.'"')->parse->parse_tree;
2061 # For a well-behaved phrase, we should now have only one node
2062 # in the $tmptree query plan, and that node should have an
2063 # orderly list of atoms and joiners.
2065 if ($tmptree->{query} and scalar(@{$tmptree->{query}}) == 1) {
2069 $tmplist = $tmptree->{query}->[0]->to_abstract_query(
2071 )->{children}->{'&'}->[0]->{children}->{'&'};
2076 OpenILS::QueryParser::_util::find_arrays_in_abstract($abstract_query->{children})
2078 last if $self->replace_phrase_in_abstract_query(
2081 OpenILS::QueryParser::_util::fake_abstract_atom_from_phrase($phrase, $self->{negate}, $pkg)
2089 $abstract_query->{children} ||= { OpenILS::QueryParser::_util::default_joiner() => $kids };
2090 return $abstract_query;
2093 #-------------------------------
2094 package OpenILS::QueryParser::query_plan::node::atom;
2098 $pkg = ref($pkg) || $pkg;
2101 return bless \%args => $pkg;
2106 return unless (ref $self);
2107 return $self->{node};
2112 return unless (ref $self);
2113 return $self->{content};
2118 return unless (ref $self);
2119 return $self->{prefix};
2124 return unless (ref $self);
2125 return $self->{suffix};
2128 sub to_abstract_query {
2132 (map { $_ => $self->$_ } qw/prefix suffix content/),
2136 #-------------------------------
2137 package OpenILS::QueryParser::query_plan::filter;
2141 $pkg = ref($pkg) || $pkg;
2144 return bless \%args => $pkg;
2149 return $self->{plan};
2154 return $self->{name};
2159 return $self->{negate};
2164 return $self->{args};
2167 sub to_abstract_query {
2171 map { $_ => $self->$_ } qw/name negate args/
2175 #-------------------------------
2176 package OpenILS::QueryParser::query_plan::facet;
2180 $pkg = ref($pkg) || $pkg;
2183 return bless \%args => $pkg;
2188 return $self->{plan};
2193 return $self->{name};
2198 return $self->{negate};
2203 return $self->{'values'};
2206 sub to_abstract_query {
2210 (map { $_ => $self->$_ } qw/name negate values/),
2215 #-------------------------------
2216 package OpenILS::QueryParser::query_plan::modifier;
2220 $pkg = ref($pkg) || $pkg;
2221 my $modifier = shift;
2224 return bless { name => $modifier, negate => $negate } => $pkg;
2229 return $self->{name};
2234 return $self->{negate};
2237 sub to_abstract_query {