242799999df698ccfb9999db6a4690c235091eff
[working/Evergreen.git] / Open-ILS / src / perlmods / t / 21-QueryParser.t
1 #!perl
2
3 use strict;
4 use warnings; # FATAL => qw(all);
5 use Test::More;
6
7 BEGIN {
8         use_ok( 'OpenILS::Application::Storage::QueryParser' );
9 #    use_ok( 'OpenILS::Application::Storage::Driver::Pg::QueryParser' );
10 }
11
12 my %args = ( debug => 0 );
13 my $QParser = QueryParser->new(%args);
14 is(ref $QParser, 'QueryParser', 'Created QueryParser');
15 is($QParser->operator('and'), '&&', 'Expected and operator');
16
17 $Data::Dumper::Indent = 1;
18
19 $QParser->add_search_class_alias( keyword => 'kw' );
20 is ($QParser->search_class_count, 1, "Added one search class");
21 init_qp();
22
23 is ($QParser->search_class_count, 5, "Correct number of search classes");
24 is (scalar(@{$QParser->search_fields()->{'author'}}), 3, "Correct number of search fields for 'author' class");
25 $QParser->remove_search_field('author', 'personal');
26 is (scalar(@{$QParser->search_fields()->{'author'}}), 2, "Removed search field");
27 $QParser->remove_search_class('title');
28 is ($QParser->search_class_count, 4, "Removed search class");
29 is (scalar(@{$QParser->search_class_aliases->{'author'}}), 3, "Correct number of aliases for 'author' class");
30 $QParser->remove_search_class_alias( author => 'au' );
31 is (scalar(@{$QParser->search_class_aliases->{'author'}}), 2, "Removed alias for 'author' class");
32 is (scalar(@{$QParser->search_field_aliases->{'subject'}->{'name'}}), 2, "Correct number of search field aliases for 'subject' class");
33 $QParser->remove_search_field_alias( subject => name => 'nomen' );
34 is (scalar(@{$QParser->search_field_aliases->{'subject'}->{'name'}}), 1, "Removed search field alias");
35
36 is ($QParser->facet_class_count, 2, "Correct number of facet classes");
37 is (scalar(@{$QParser->facet_fields()->{'author'}}), 2, "Correct number of facet fields for 'author' class");
38 $QParser->remove_facet_field('author', 'personal');
39 is (scalar(@{$QParser->facet_fields()->{'author'}}), 1, "Removed facet field");
40 $QParser->remove_facet_class('author');
41 is ($QParser->facet_class_count, 1, "Removed facet class");
42
43 is ($QParser->filter_count, 28, "Correct number of filters");
44 is (scalar(@{$QParser->filter_normalizers('skip_check')}), 0, 'No filter normalizers by default');
45 $QParser->add_filter_normalizer('skip_check', \&test_filter_norm);
46 is (scalar(@{$QParser->filter_normalizers('skip_check')}), 1, 'Added filter normalizer');
47 is ($QParser->modifier_count, 8, "Correct number of modifiers");
48
49 is_deeply ($QParser->custom_data('string'), { }, "No custom data set for 'string'");
50
51 is($QParser->core_limit(25000), 25000, 'Core limit setting works');
52 is($QParser->core_limit(), 25000, 'Core limit stays set');
53
54 is($QParser->superpage(1), 1, 'Superpage setting works');
55 is($QParser->superpage(), 1, 'Superpage stays set');
56 is($QParser->superpage(0), 0, 'Superpage can be unset');
57
58 is($QParser->superpage_size(1000), 1000, 'Superpage size setting works');
59 is($QParser->superpage_size(), 1000, 'Superpage size stays set');
60
61 init_qp();
62
63 my %queries = (
64     '(keyword1 keyword2) || keyword3' => undef,
65     'keyword1 || keyword2' => undef,
66     'author:keyword1 keyword2' => undef,
67     '(keyword1) || (keyword2)' => undef,
68     'keyword1 || keyword2 || keyword3' => undef,
69     '(keyword1 || keyword2) && keyword3' => undef,
70     'keyword1 keyword2 || keyword3 keyword4' => sub {
71         my $query = shift;
72         # Unfortunately, the canonical representation of a query in master
73         # as of 2012/09/07 is not unambiguous
74         is($QParser->parse_tree()->to_abstract_query()->{children}->{'&'}, undef, "Outer-most operator in query {$query} is not AND");
75         is(ref $QParser->parse_tree()->to_abstract_query()->{children}->{'|'}, 'ARRAY', "Outer-most operator in query {$query} is OR");
76     },
77     'keyword1 keyword2 && keyword3 keyword4' => undef,
78     'keyword1 author:keyword2' => undef,
79     'au:keyword1 kw:keyword2' => undef,
80     'keyword1 pref_ou(lib)' => sub {
81         my $query = shift;
82         is($QParser->parse_tree->to_abstract_query()->{filters}->[0]->{name}, 'pref_ou', 'Generated filter for query');
83     },
84     'keyword1 #available' => sub {
85         my $query = shift;
86         is($QParser->parse_tree->to_abstract_query()->{modifiers}->[0], 'available', 'Set modifier for query');
87     },
88     '(keyword1 keyword2) || keyword3 #available' => sub {
89         my $query = shift;
90         is($QParser->parse_tree->to_abstract_query()->{modifiers}->[0], 'available', 'Set modifier for query');
91     },
92     'keyword1 testfilter(whatever)' => undef,
93     'keyword1 sort:something' => undef,
94     '"phrase1 phrase2" keyword1' => undef, # NOTE: phrases do not have a stable canonical representation, 2012-09-09
95     'keyword1 -keyword2' => undef,
96     'keyword1 +keyword2' => undef,
97 );
98
99 my $query;
100 my $testfunc;
101 while (($query, $testfunc) = each (%queries)) {
102     init_qp();
103     $QParser->parse($query);
104     # TODO: Test initial parse
105     &$testfunc($query) if ($testfunc);
106     my $canonical = clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query()));
107     $canonical = reparse($canonical);
108     init_qp();
109     $QParser->parse($canonical);
110     is(clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query())), $canonical, "Building query from canonical query is idempotent for query {$query}");
111 }
112
113 my %equivalences = (
114     'keyword1 keyword2' => 'keyword1 && keyword2',
115     'keyword1 keyword2 || keyword3 keyword4' => 'keyword1 && keyword2 || keyword3 && keyword4',
116     'keyword1 keyword2 || keyword3 keyword4' => '(keyword1 keyword2) || (keyword3 keyword4)',
117     'keyword1 keyword2 && keyword3 keyword4' => '(keyword1 && keyword2) && (keyword3 && keyword4)',
118     'keyword1 || && keyword2' => 'keyword1 || keyword2',
119     'keyword1' => 'keyword:keyword1',
120 );
121
122 my $equivalent;
123 while (($query, $equivalent) = each (%equivalences)) {
124     init_qp();
125     $QParser->parse($query);
126     my $canonical1 = reparse(clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query())));
127     init_qp();
128     $QParser->parse($equivalent);
129     my $canonical2 = reparse(clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query())));
130     is($canonical1, $canonical2, "Queries {$query} and {$equivalent} are equivalent");
131 }
132
133 my %differences = (
134     '(keyword1 keyword2) || keyword3' => 'keyword1 && (keyword2 || keyword3)',
135     'keyword1 || (keyword2 && keyword3)' => '(keyword1 || keyword2) && keyword3',
136     '(keyword1 || keyword2) && keyword3' => 'keyword1 || (keyword2 && keyword3)',
137     'keyword1 keyword2 || keyword3 keyword4' => '(keyword1 keyword2 || keyword3) keyword4', # this should fail on master, 2012-09-07
138 );
139
140
141 my $different;
142 while (($query, $different) = each (%differences)) {
143     init_qp();
144     $QParser->parse($query);
145     my $canonical1 = reparse(clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query())));
146     init_qp();
147     $QParser->parse($different);
148     my $canonical2 = reparse(clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query())));
149     isnt($canonical1, $canonical2, "Queries {$query} and {$different} are not equivalent");
150 }
151
152
153 done_testing;
154
155 sub test_filter_norm {
156     return;
157 }
158
159 sub test_filter_callback {
160     my ($QParser, $struct, $filter, $params, $negate) = @_;
161     is($filter, 'testfilter', 'Filter callback on correct filter');
162     return;
163 }
164
165 sub clean {
166     my $string = shift;
167     $string =~ s/\s+/ /g;
168     $string =~ s/ \)/\)/g;
169     $string =~ s/\( /\(/g;
170     $string =~ s/ $//g;
171     $string =~ s/^ //g;
172     
173     ($string, undef) = parse_parens($string);
174
175     $string =~ s/(^| )\(([^) ]+)\)/$2/g;
176     $string =~ s/^\(([^)]*)\)$/$1/g;
177
178     return $string;
179 }
180
181 sub parse_parens {
182     my $string = shift;
183     my $subres;
184     my $result = '';
185     while (my $nextchar = substr($string, 0, 1)) {
186         $string = substr($string, 1);
187         if ($nextchar eq '(') {
188             ($subres, $string) = parse_parens($string);
189             if ($result || ! (substr($string, 0, 1) eq ')')) {
190                 $result .= "($subres)";
191             } else {
192                 $result = $subres;
193             }
194         } elsif ($nextchar eq ')') {
195             return ($result, $string);
196         } else {
197             $result .= $nextchar;
198         }
199     }
200     return $result;
201 }
202
203 sub reparse {
204     my $canonical = shift;
205     my $repeats = $canonical =~ tr/&/&/;
206     $repeats = ($repeats / 2) + 1;
207     my $result;
208     while (--$repeats) {
209         init_qp();
210         $QParser->parse($canonical);
211         $canonical = clean(QueryParser::Canonicalize::abstract_query2str_impl($QParser->parse_tree()->to_abstract_query()));
212     }
213     return $canonical;
214 }
215
216 sub init_qp {
217     $QueryParser::parser_config{QueryParser}->{allow_nested_modifiers} = 1;
218     $QParser = QueryParser->new(%args);
219     $QParser->add_search_class_alias( title => 'ti' );
220     $QParser->add_search_class_alias( author => 'au' );
221     $QParser->add_search_class_alias( author => 'name' );
222     $QParser->add_search_class_alias( author => 'dc.contributor' );
223     $QParser->add_search_class_alias( subject => 'su' );
224     $QParser->add_search_class_alias( subject => 'bib.subject(?:Title|Place|Occupation)' );
225     $QParser->add_search_class_alias( series => 'se' );
226     $QParser->add_search_class_alias( keyword => 'dc.identifier' );
227
228     $QParser->add_query_normalizer( author => corporate => 'search_normalize' );
229     $QParser->add_query_normalizer( keyword => keyword => 'search_normalize' );
230     
231     $QParser->add_search_field_alias( subject => name => 'bib.subjectName' );
232     $QParser->add_search_field_alias( subject => name => 'nomen' );
233
234     $QParser->add_search_field( 'author' => 'personal' );
235     $QParser->add_search_field( 'author' => 'corporate' );
236     $QParser->add_search_field( 'author' => 'meeting' );
237
238     $QParser->default_search_class( 'keyword' );
239
240     # will be retained simply for back-compat
241     $QParser->add_search_filter( 'format' );
242
243     # grumble grumble, special cases against date1 and date2
244     $QParser->add_search_filter( 'before' );
245     $QParser->add_search_filter( 'after' );
246     $QParser->add_search_filter( 'between' );
247     $QParser->add_search_filter( 'during' );
248
249     # used by layers above this
250     $QParser->add_search_filter( 'statuses' );
251     $QParser->add_search_filter( 'locations' );
252     $QParser->add_search_filter( 'location_groups' );
253     $QParser->add_search_filter( 'site' );
254     $QParser->add_search_filter( 'pref_ou' );
255     $QParser->add_search_filter( 'lasso' );
256     $QParser->add_search_filter( 'my_lasso' );
257     $QParser->add_search_filter( 'depth' );
258     $QParser->add_search_filter( 'language' );
259     $QParser->add_search_filter( 'offset' );
260     $QParser->add_search_filter( 'limit' );
261     $QParser->add_search_filter( 'check_limit' );
262     $QParser->add_search_filter( 'skip_check' );
263     $QParser->add_search_filter( 'superpage' );
264     $QParser->add_search_filter( 'estimation_strategy' );
265     $QParser->add_search_modifier( 'available' );
266     $QParser->add_search_modifier( 'staff' );
267
268     # Start from container data (bre, acn, acp): container(bre,bookbag,123,deadb33fdeadb33fdeadb33fdeadb33f)
269     $QParser->add_search_filter( 'container' );
270
271     # Start from a list of record ids, either bre or metarecords, depending on the #metabib modifier
272     $QParser->add_search_filter( 'record_list' );
273
274     # used internally, but generally not user-settable
275     $QParser->add_search_filter( 'preferred_language' );
276     $QParser->add_search_filter( 'preferred_language_weight' );
277     $QParser->add_search_filter( 'preferred_language_multiplier' );
278     $QParser->add_search_filter( 'core_limit' );
279
280     # XXX Valid values to be supplied by SVF
281     $QParser->add_search_filter( 'sort' );
282
283     # modifies core query, not configurable
284     $QParser->add_search_modifier( 'descending' );
285     $QParser->add_search_modifier( 'ascending' );
286     $QParser->add_search_modifier( 'nullsfirst' );
287     $QParser->add_search_modifier( 'nullslast' );
288     $QParser->add_search_modifier( 'metarecord' );
289     $QParser->add_search_modifier( 'metabib' );
290
291     $QParser->add_facet_field( 'author' => 'personal' );
292     $QParser->add_facet_field( 'author' => 'corporate' );
293     $QParser->add_facet_field( 'subject' => 'topic' );
294     $QParser->add_facet_field( 'subject' => 'geographic' );
295
296     $QParser->add_search_filter( 'testfilter', \&test_filter_callback );
297 }