Silence uninit var warnings from query normalizer
[working/Evergreen.git] / Open-ILS / src / perlmods / lib / OpenILS / Application / Storage / Driver / Pg / QueryParser.pm
1 use strict;
2 use warnings;
3
4 package OpenILS::Application::Storage::Driver::Pg::QueryParser;
5 use OpenILS::Application::Storage::QueryParser;
6 use base 'QueryParser';
7 use OpenSRF::Utils qw/:datetime/;
8 use OpenSRF::Utils::JSON;
9 use OpenILS::Application::AppUtils;
10 use OpenILS::Utils::CStoreEditor;
11 my $U = 'OpenILS::Application::AppUtils';
12
13 my ${spc} = ' ' x 2;
14 sub subquery_callback {
15     my ($invocant, $self, $struct, $filter, $params, $negate) = @_;
16
17     return sprintf(' ((%s)) ',
18         join(
19             ') || (',
20             map {
21                 $_->query_text
22             } @{
23                 OpenILS::Utils::CStoreEditor
24                     ->new
25                     ->search_actor_search_query({ id => $params })
26             }
27         )
28     );
29 }
30
31 sub filter_group_entry_callback {
32     my ($invocant, $self, $struct, $filter, $params, $negate) = @_;
33
34     return sprintf(' saved_query(%s)', 
35         join(
36             ',', 
37             map {
38                 $_->query
39             } @{
40                 OpenILS::Utils::CStoreEditor
41                     ->new
42                     ->search_actor_search_filter_group_entry({ id => $params })
43             }
44         )
45     );
46 }
47
48 sub format_callback {
49     my ($invocant, $self, $struct, $filter, $params, $negate) = @_;
50
51     my $return = '';
52     my $negate_flag = ($negate ? '-' : '');
53     my @returns;
54     for my $param (@$params) {
55         my ($t,$f) = split('-', $param);
56         my $treturn = '';
57         $treturn .= 'item_type(' . join(',',split('', $t)) . ')' if ($t);
58         $treturn .= ' ' if ($t and $f);
59         $treturn .= 'item_form(' . join(',',split('', $f)) . ')' if ($f);
60         $treturn = '(' . $treturn . ')' if ($t and $f);
61         push(@returns, $treturn) if $treturn;
62     }
63     $return = join(' || ', @returns);
64     $return = '(' . $return . ')' if(@returns > 1);
65     $return = $negate_flag.$return if($return);
66     return $return;
67 }
68
69 sub quote_value {
70     my $self = shift;
71     my $value = shift;
72
73     if ($value =~ /^\d/) { # may have to use non-$ quoting
74         $value =~ s/'/''/g;
75         $value =~ s/\\/\\\\/g;
76         return "E'$value'";
77     }
78     return "\$_$$\$$value\$_$$\$";
79 }
80
81 sub quote_phrase_value {
82     my $self = shift;
83     my $value = shift;
84     my $wb = shift;
85
86     my $left_anchored = '';
87     my $right_anchored = '';
88     $left_anchored  = $1 if $value =~ m/^([*\^])/;
89     $right_anchored = $1 if $value =~ m/([*\$])$/;
90     $value =~ s/^[*\^]//   if $left_anchored;
91     $value =~ s/[*\$]$//  if $right_anchored;
92     $value = quotemeta($value);
93     $value = '^' . $value if $left_anchored eq '^';
94     $value = "$value\$"   if $right_anchored eq '$';
95     $value = '[[:<:]]' . $value if $wb && !$left_anchored;
96     $value .= '[[:>:]]' if $wb && !$right_anchored;
97     return $self->quote_value($value);
98 }
99
100 sub init {
101     my $class = shift;
102 }
103
104 sub default_preferred_language {
105     my $self = shift;
106     my $lang = shift;
107
108     $self->custom_data->{default_preferred_language} = $lang if ($lang);
109     return $self->custom_data->{default_preferred_language};
110 }
111
112 sub default_preferred_language_multiplier {
113     my $self = shift;
114     my $lang = shift;
115
116     $self->custom_data->{default_preferred_language_multiplier} = $lang if ($lang);
117     return $self->custom_data->{default_preferred_language_multiplier};
118 }
119
120 sub simple_plan {
121     my $self = shift;
122
123     return 0 unless $self->parse_tree;
124     return 0 if @{$self->parse_tree->filters};
125     return 0 if @{$self->parse_tree->modifiers};
126     for my $node ( @{ $self->parse_tree->query_nodes } ) {
127         return 0 if (!ref($node) && $node eq '|');
128         next unless (ref($node));
129         return 0 if ($node->isa('QueryParser::query_plan'));
130     }
131
132     return 1;
133 }
134
135 sub toSQL {
136     my $self = shift;
137     return $self->parse_tree->toSQL;
138 }
139
140 sub dynamic_filters {
141     my $self = shift;
142     my $new = shift;
143
144     $self->custom_data->{dynamic_filters} ||= [];
145     push(@{$self->custom_data->{dynamic_filters}}, $new) if ($new);
146     return $self->custom_data->{dynamic_filters};
147 }
148
149 sub dynamic_sorters {
150     my $self = shift;
151     my $new = shift;
152
153     $self->custom_data->{dynamic_sorters} ||= [];
154     push(@{$self->custom_data->{dynamic_sorters}}, $new) if ($new);
155     return $self->custom_data->{dynamic_sorters};
156 }
157
158 sub facet_field_id_map {
159     my $self = shift;
160     my $map = shift;
161
162     $self->custom_data->{facet_field_id_map} ||= {};
163     $self->custom_data->{facet_field_id_map} = $map if ($map);
164     return $self->custom_data->{facet_field_id_map};
165 }
166
167 sub add_facet_field_id_map {
168     my $self = shift;
169     my $class = shift;
170     my $field = shift;
171     my $id = shift;
172     my $weight = shift;
173
174     $self->add_facet_field( $class => $field );
175     $self->facet_field_id_map->{by_id}{$id} = { classname => $class, field => $field, weight => $weight };
176     $self->facet_field_id_map->{by_class}{$class}{$field} = $id;
177
178     return {
179         by_id => { $id => { classname => $class, field => $field, weight => $weight } },
180         by_class => { $class => { $field => $id } }
181     };
182 }
183
184 sub facet_field_class_by_id {
185     my $self = shift;
186     my $id = shift;
187
188     return $self->facet_field_id_map->{by_id}{$id};
189 }
190
191 sub facet_field_ids_by_class {
192     my $self = shift;
193     my $class = shift;
194     my $field = shift;
195
196     return undef unless ($class);
197
198     if ($field) {
199         return [$self->facet_field_id_map->{by_class}{$class}{$field}];
200     }
201
202     return [values( %{ $self->facet_field_id_map->{by_class}{$class} } )];
203 }
204
205 sub search_field_id_map {
206     my $self = shift;
207     my $map = shift;
208
209     $self->custom_data->{search_field_id_map} ||= {};
210     $self->custom_data->{search_field_id_map} = $map if ($map);
211     return $self->custom_data->{search_field_id_map};
212 }
213
214 sub add_search_field_id_map {
215     my $self = shift;
216     my $class = shift;
217     my $field = shift;
218     my $id = shift;
219     my $weight = shift;
220     my $combined = shift;
221
222     $self->add_search_field( $class => $field );
223     $self->search_field_id_map->{by_id}{$id} = { classname => $class, field => $field, weight => $weight };
224     $self->search_field_id_map->{by_class}{$class}{$field} = $id;
225
226     return {
227         by_id => { $id => { classname => $class, field => $field, weight => $weight } },
228         by_class => { $class => { $field => $id } }
229     };
230 }
231
232 sub search_field_class_by_id {
233     my $self = shift;
234     my $id = shift;
235
236     return $self->search_field_id_map->{by_id}{$id};
237 }
238
239 sub search_field_ids_by_class {
240     my $self = shift;
241     my $class = shift;
242     my $field = shift;
243
244     return undef unless ($class);
245
246     if ($field) {
247         return [$self->search_field_id_map->{by_class}{$class}{$field}];
248     }
249
250     return [values( %{ $self->search_field_id_map->{by_class}{$class} } )];
251 }
252
253 sub relevance_bumps {
254     my $self = shift;
255     my $bumps = shift;
256
257     $self->custom_data->{rel_bumps} ||= {};
258     $self->custom_data->{rel_bumps} = $bumps if ($bumps);
259     return $self->custom_data->{rel_bumps};
260 }
261
262 sub find_relevance_bumps {
263     my $self = shift;
264     my $class = shift;
265     my $field = shift;
266
267     return $self->relevance_bumps->{$class}{$field};
268 }
269
270 sub add_relevance_bump {
271     my $self = shift;
272     my $class = shift;
273     my $field = shift;
274     my $type = shift;
275     my $multiplier = shift;
276     my $active = shift;
277
278     if (defined($active) and $active eq 'f') {
279         $active = 0;
280     } else {
281         $active = 1;
282     }
283
284     $self->relevance_bumps->{$class}{$field}{$type} = { multiplier => $multiplier, active => $active };
285
286     return { $class => { $field => { $type => { multiplier => $multiplier, active => $active } } } };
287 }
288
289 sub search_class_weights {
290     my $self = shift;
291     my $class = shift;
292     my $a_weight = shift;
293     my $b_weight = shift;
294     my $c_weight = shift;
295     my $d_weight = shift;
296
297     $self->custom_data->{class_weights} ||= {};
298     # Note: This reverses the A-D order, putting D first, because that is how the call actually works in PG
299     $self->custom_data->{class_weights}->{$class} ||= [0.1, 0.2, 0.4, 1.0];
300     $self->custom_data->{class_weights}->{$class} = [$d_weight, $c_weight, $b_weight, $a_weight] if $a_weight;
301     return $self->custom_data->{class_weights}->{$class};
302 }
303
304 sub search_class_combined {
305     my $self = shift;
306     my $class = shift;
307     my $c = shift;
308
309     $self->custom_data->{class_combined} ||= {};
310     # Note: This reverses the A-D order, putting D first, because that is how the call actually works in PG
311     $self->custom_data->{class_combined}->{$class} ||= 0;
312     $self->custom_data->{class_combined}->{$class} = 1 if $c && $c =~ /^(?:t|y|1)/i;
313     return $self->custom_data->{class_combined}->{$class};
314 }
315
316 sub class_ts_config {
317     my $self = shift;
318     my $class = shift;
319     my $lang = shift || 'DEFAULT';
320     my $always = shift;
321     my $ts_config = shift;
322
323     $self->custom_data->{class_ts_config} ||= {};
324     $self->custom_data->{class_ts_config}->{$class} ||= {};
325     $self->custom_data->{class_ts_config}->{$class}->{$lang} ||= {};
326     $self->custom_data->{class_ts_config}->{$class}->{$lang}->{normal} ||= [];
327     $self->custom_data->{class_ts_config}->{$class}->{$lang}->{always} ||= [];
328     $self->custom_data->{class_ts_config}->{$class}->{'DEFAULT'} ||= {};
329     $self->custom_data->{class_ts_config}->{$class}->{'DEFAULT'}->{normal} ||= [];
330     $self->custom_data->{class_ts_config}->{$class}->{'DEFAULT'}->{always} ||= [];
331
332     if ($ts_config) {
333         push @{$self->custom_data->{class_ts_config}->{$class}->{$lang}->{normal}}, $ts_config unless $always;
334         push @{$self->custom_data->{class_ts_config}->{$class}->{$lang}->{always}}, $ts_config if $always;
335     }
336
337     my $return = [];
338     push @$return, @{$self->custom_data->{class_ts_config}->{$class}->{$lang}->{always}};
339     push @$return, @{$self->custom_data->{class_ts_config}->{$class}->{$lang}->{normal}} unless $always;
340     if($lang ne 'DEFAULT') {
341         push @$return, @{$self->custom_data->{class_ts_config}->{$class}->{'DEFAULT'}->{always}};
342         push @$return, @{$self->custom_data->{class_ts_config}->{$class}->{'DEFAULT'}->{normal}} unless $always;
343     }
344     return $return;
345 }
346
347 sub field_ts_config {
348     my $self = shift;
349     my $class = shift;
350     my $field = shift;
351     my $lang = shift || 'DEFAULT';
352     my $ts_config = shift;
353
354     $self->custom_data->{field_ts_config} ||= {};
355     $self->custom_data->{field_ts_config}->{$class} ||= {};
356     $self->custom_data->{field_ts_config}->{$class}->{$field} ||= {};
357     $self->custom_data->{field_ts_config}->{$class}->{$field}->{$lang} ||= [];
358     $self->custom_data->{field_ts_config}->{$class}->{$field}->{'DEFAULT'} ||= [];
359
360     if ($ts_config) {
361         push @{$self->custom_data->{field_ts_config}->{$class}->{$field}->{$lang}}, $ts_config;
362     }
363
364     my $return = [];
365     push @$return, @{$self->custom_data->{field_ts_config}->{$class}->{$field}->{$lang}};
366     if($lang ne 'DEFAULT') {
367         push @$return, @{$self->custom_data->{field_ts_config}->{$class}->{$field}->{'DEFAULT'}};
368     }
369     # Make it easy on us: Grab any "always" for the class here. If we have none we grab them all.
370     push @$return, @{$self->class_ts_config($class, $lang, scalar(@$return))};
371     return $return;
372 }
373
374 sub initialize_search_field_id_map {
375     my $self = shift;
376     my $cmf_list = shift;
377
378     for my $cmf (@$cmf_list) {
379         __PACKAGE__->add_search_field_id_map( $cmf->field_class, $cmf->name, $cmf->id, $cmf->weight ) if ($U->is_true($cmf->search_field));
380         __PACKAGE__->add_facet_field_id_map( $cmf->field_class, $cmf->name, $cmf->id, $cmf->weight ) if ($U->is_true($cmf->facet_field));
381     }
382
383     return $self->search_field_id_map;
384 }
385
386 sub initialize_aliases {
387     my $self = shift;
388     my $cmsa_list = shift;
389
390     for my $cmsa (@$cmsa_list) {
391         if (!$cmsa->field) {
392             __PACKAGE__->add_search_class_alias( $cmsa->field_class, $cmsa->alias );
393         } else {
394             my $c = $self->search_field_class_by_id( $cmsa->field );
395             __PACKAGE__->add_search_field_alias( $cmsa->field_class, $c->{field}, $cmsa->alias );
396         }
397     }
398 }
399
400 sub initialize_relevance_bumps {
401     my $self = shift;
402     my $sra_list = shift;
403
404     for my $sra (@$sra_list) {
405         my $c = $self->search_field_class_by_id( $sra->field );
406         __PACKAGE__->add_relevance_bump( $c->{classname}, $c->{field}, $sra->bump_type, $sra->multiplier, $sra->active );
407     }
408
409     return $self->relevance_bumps;
410 }
411
412 sub initialize_query_normalizers {
413     my $self = shift;
414     my $tree = shift; # open-ils.cstore.direct.config.metabib_field_index_norm_map.search.atomic { "id" : { "!=" : null } }, { "flesh" : 1, "flesh_fields" : { "cmfinm" : ["norm"] }, "order_by" : [{ "class" : "cmfinm", "field" : "pos" }] }
415
416     for my $cmfinm ( @$tree ) {
417         my $field_info = $self->search_field_class_by_id( $cmfinm->field );
418         next unless $field_info;
419         __PACKAGE__->add_query_normalizer( $field_info->{classname}, $field_info->{field}, $cmfinm->norm->func, OpenSRF::Utils::JSON->JSON2perl($cmfinm->params) );
420     }
421 }
422
423 sub initialize_dynamic_filters {
424     my $self = shift;
425     my $list = shift; # open-ils.cstore.direct.config.record_attr_definition.search.atomic { "id" : { "!=" : null } }
426
427     for my $crad ( @$list ) {
428         __PACKAGE__->dynamic_filters( __PACKAGE__->add_search_filter( $crad->name ) ) if ($U->is_true($crad->filter));
429         __PACKAGE__->dynamic_sorters( $crad->name ) if ($U->is_true($crad->sorter));
430     }
431 }
432
433 sub initialize_filter_normalizers {
434     my $self = shift;
435     my $tree = shift; # open-ils.cstore.direct.config.record_attr_index_norm_map.search.atomic { "id" : { "!=" : null } }, { "flesh" : 1, "flesh_fields" : { "crainm" : ["norm"] }, "order_by" : [{ "class" : "crainm", "field" : "pos" }] }
436
437     for my $crainm ( @$tree ) {
438         __PACKAGE__->add_filter_normalizer( $crainm->attr, $crainm->norm->func, OpenSRF::Utils::JSON->JSON2perl($crainm->params) );
439     }
440 }
441
442 sub initialize_search_class_weights {
443     my $self = shift;
444     my $classes = shift;
445
446     for my $search_class (@$classes) {
447         __PACKAGE__->search_class_weights( $search_class->name, $search_class->a_weight, $search_class->b_weight, $search_class->c_weight, $search_class->d_weight );
448         __PACKAGE__->search_class_combined( $search_class->name, $search_class->combined );
449     }
450 }
451
452 sub initialize_class_ts_config {
453     my $self = shift;
454     my $class_entries = shift;
455
456     for my $search_class_entry (@$class_entries) {
457         __PACKAGE__->class_ts_config($search_class_entry->field_class,$search_class_entry->search_lang,$U->is_true($search_class_entry->always),$search_class_entry->ts_config);
458     }
459 }
460
461 sub initialize_field_ts_config {
462     my $self = shift;
463     my $field_entries = shift;
464     my $field_objects = shift;
465     my %field_hash = map { $_->id => $_ } @$field_objects;
466
467     for my $search_field_entry (@$field_entries) {
468         my $field_object = $field_hash{$search_field_entry->metabib_field};
469         __PACKAGE__->field_ts_config($field_object->field_class,$field_object->name,$search_field_entry->search_lang,$search_field_entry->ts_config);
470     }
471 }
472
473 our $_complete = 0;
474 sub initialization_complete {
475     return $_complete;
476 }
477
478 sub initialize {
479     my $self = shift;
480     my %args = @_;
481
482     return $_complete if ($_complete);
483
484     # tsearch rank normalization adjustments. see http://www.postgresql.org/docs/9.0/interactive/textsearch-controls.html#TEXTSEARCH-RANKING for details
485     $self->custom_data->{rank_cd_weight_map} = {
486         CD_logDocumentLength    => 1,
487         CD_documentLength       => 2,
488         CD_meanHarmonic         => 4,
489         CD_uniqueWords          => 8,
490         CD_logUniqueWords       => 16,
491         CD_selfPlusOne          => 32
492     };
493
494     $self->add_search_modifier( $_ ) for (keys %{ $self->custom_data->{rank_cd_weight_map} });
495
496     $self->initialize_search_field_id_map( $args{config_metabib_field} )
497         if ($args{config_metabib_field});
498
499     $self->initialize_aliases( $args{config_metabib_search_alias} )
500         if ($args{config_metabib_search_alias});
501
502     $self->initialize_relevance_bumps( $args{search_relevance_adjustment} )
503         if ($args{search_relevance_adjustment});
504
505     $self->initialize_query_normalizers( $args{config_metabib_field_index_norm_map} )
506         if ($args{config_metabib_field_index_norm_map});
507
508     $self->initialize_dynamic_filters( $args{config_record_attr_definition} )
509         if ($args{config_record_attr_definition});
510
511     $self->initialize_filter_normalizers( $args{config_record_attr_index_norm_map} )
512         if ($args{config_record_attr_index_norm_map});
513
514     $self->initialize_search_class_weights( $args{config_metabib_class} )
515         if ($args{config_metabib_class});
516
517     $self->initialize_class_ts_config( $args{config_metabib_class_ts_map} )
518         if ($args{config_metabib_class_ts_map});
519
520     $self->initialize_field_ts_config( $args{config_metabib_field_ts_map}, $args{config_metabib_field} )
521         if ($args{config_metabib_field_ts_map} && $args{config_metabib_field});
522
523     $_complete = 1 if (
524         $args{config_metabib_field_index_norm_map} &&
525         $args{search_relevance_adjustment} &&
526         $args{config_metabib_search_alias} &&
527         $args{config_metabib_field} &&
528         $args{config_record_attr_definition}
529     );
530
531     return $_complete;
532 }
533
534 sub TEST_SETUP {
535     
536     __PACKAGE__->allow_nested_modifiers(1);
537
538     __PACKAGE__->add_search_field_id_map( series => seriestitle => 1 => 1 );
539
540     __PACKAGE__->add_search_field_id_map( series => seriestitle => 1 => 1 );
541     __PACKAGE__->add_relevance_bump( series => seriestitle => first_word => 1.5 );
542     __PACKAGE__->add_relevance_bump( series => seriestitle => full_match => 20 );
543     
544     __PACKAGE__->add_search_field_id_map( title => abbreviated => 2 => 1 );
545     __PACKAGE__->add_relevance_bump( title => abbreviated => first_word => 1.5 );
546     __PACKAGE__->add_relevance_bump( title => abbreviated => full_match => 20 );
547     
548     __PACKAGE__->add_search_field_id_map( title => translated => 3 => 1 );
549     __PACKAGE__->add_relevance_bump( title => translated => first_word => 1.5 );
550     __PACKAGE__->add_relevance_bump( title => translated => full_match => 20 );
551     
552     __PACKAGE__->add_search_field_id_map( title => proper => 6 => 1 );
553     __PACKAGE__->add_query_normalizer( title => proper => 'search_normalize' );
554     __PACKAGE__->add_relevance_bump( title => proper => first_word => 1.5 );
555     __PACKAGE__->add_relevance_bump( title => proper => full_match => 20 );
556     __PACKAGE__->add_relevance_bump( title => proper => word_order => 10 );
557     
558     __PACKAGE__->add_search_field_id_map( author => corporate => 7 => 1 );
559     __PACKAGE__->add_relevance_bump( author => corporate => first_word => 1.5 );
560     __PACKAGE__->add_relevance_bump( author => corporate => full_match => 20 );
561     
562     __PACKAGE__->add_facet_field_id_map( author => personal => 8 => 1 );
563
564     __PACKAGE__->add_search_field_id_map( author => personal => 8 => 1 );
565     __PACKAGE__->add_relevance_bump( author => personal => first_word => 1.5 );
566     __PACKAGE__->add_relevance_bump( author => personal => full_match => 20 );
567     __PACKAGE__->add_query_normalizer( author => personal => 'search_normalize' );
568     __PACKAGE__->add_query_normalizer( author => personal => 'split_date_range' );
569     
570     __PACKAGE__->add_facet_field_id_map( subject => topic => 14 => 1 );
571
572     __PACKAGE__->add_search_field_id_map( subject => topic => 14 => 1 );
573     __PACKAGE__->add_relevance_bump( subject => topic => first_word => 1 );
574     __PACKAGE__->add_relevance_bump( subject => topic => full_match => 1 );
575     
576     __PACKAGE__->add_search_field_id_map( subject => complete => 16 => 1 );
577     __PACKAGE__->add_relevance_bump( subject => complete => first_word => 1 );
578     __PACKAGE__->add_relevance_bump( subject => complete => full_match => 1 );
579     
580     __PACKAGE__->add_search_field_id_map( keyword => keyword => 15 => 1 );
581     __PACKAGE__->add_relevance_bump( keyword => keyword => first_word => 1 );
582     __PACKAGE__->add_relevance_bump( keyword => keyword => full_match => 1 );
583     
584     __PACKAGE__->class_ts_config( 'series', undef, 1, 'english_nostop' );
585     __PACKAGE__->class_ts_config( 'title', undef, 1, 'english_nostop' );
586     __PACKAGE__->class_ts_config( 'author', undef, 1, 'english_nostop' );
587     __PACKAGE__->class_ts_config( 'subject', undef, 1, 'english_nostop' );
588     __PACKAGE__->class_ts_config( 'keyword', undef, 1, 'english_nostop' );
589     __PACKAGE__->class_ts_config( 'series', undef, 1, 'simple' );
590     __PACKAGE__->class_ts_config( 'title', undef, 1, 'simple' );
591     __PACKAGE__->class_ts_config( 'author', undef, 1, 'simple' );
592     __PACKAGE__->class_ts_config( 'subject', undef, 1, 'simple' );
593     __PACKAGE__->class_ts_config( 'keyword', undef, 1, 'simple' );
594
595     # French! To test language limiters
596     __PACKAGE__->class_ts_config( 'series', 'fre', 1, 'french_nostop' );
597     __PACKAGE__->class_ts_config( 'title', 'fre', 1, 'french_nostop' );
598     __PACKAGE__->class_ts_config( 'author', 'fre', 1, 'french_nostop' );
599     __PACKAGE__->class_ts_config( 'subject', 'fre', 1, 'french_nostop' );
600     __PACKAGE__->class_ts_config( 'keyword', 'fre', 1, 'french_nostop' );
601
602     # Not a default config by any means, but good for some testing
603     __PACKAGE__->field_ts_config( 'author', 'personal', 'eng', 'english' );
604     __PACKAGE__->field_ts_config( 'author', 'personal', 'fre', 'french' );
605     
606     __PACKAGE__->add_search_class_alias( keyword => 'kw' );
607     __PACKAGE__->add_search_class_alias( title => 'ti' );
608     __PACKAGE__->add_search_class_alias( author => 'au' );
609     __PACKAGE__->add_search_class_alias( author => 'name' );
610     __PACKAGE__->add_search_class_alias( author => 'dc.contributor' );
611     __PACKAGE__->add_search_class_alias( subject => 'su' );
612     __PACKAGE__->add_search_class_alias( subject => 'bib.subject(?:Title|Place|Occupation)' );
613     __PACKAGE__->add_search_class_alias( series => 'se' );
614     __PACKAGE__->add_search_class_alias( keyword => 'dc.identifier' );
615     
616     __PACKAGE__->add_query_normalizer( author => corporate => 'search_normalize' );
617     __PACKAGE__->add_query_normalizer( keyword => keyword => 'search_normalize' );
618     
619     __PACKAGE__->add_search_field_alias( subject => name => 'bib.subjectName' );
620     
621 }
622
623 __PACKAGE__->default_search_class( 'keyword' );
624
625 # implements EG-specific stored subqueries
626 __PACKAGE__->add_search_filter( 'saved_query', sub { return __PACKAGE__->subquery_callback(@_) } );
627 __PACKAGE__->add_search_filter( 'filter_group_entry', sub { return __PACKAGE__->filter_group_entry_callback(@_) } );
628
629 # will be retained simply for back-compat
630 __PACKAGE__->add_search_filter( 'format', sub { return __PACKAGE__->format_callback(@_) } );
631
632 # grumble grumble, special cases against date1 and date2
633 __PACKAGE__->add_search_filter( 'before' );
634 __PACKAGE__->add_search_filter( 'after' );
635 __PACKAGE__->add_search_filter( 'between' );
636 __PACKAGE__->add_search_filter( 'during' );
637
638 # various filters for limiting in various ways
639 __PACKAGE__->add_search_filter( 'edit_date' );
640 __PACKAGE__->add_search_filter( 'create_date' );
641 __PACKAGE__->add_search_filter( 'statuses' );
642 __PACKAGE__->add_search_filter( 'locations' );
643 __PACKAGE__->add_search_filter( 'location_groups' );
644 __PACKAGE__->add_search_filter( 'bib_source' );
645 __PACKAGE__->add_search_filter( 'site' );
646 __PACKAGE__->add_search_filter( 'pref_ou' );
647 __PACKAGE__->add_search_filter( 'lasso' );
648 __PACKAGE__->add_search_filter( 'my_lasso' );
649 __PACKAGE__->add_search_filter( 'depth' );
650 __PACKAGE__->add_search_filter( 'language' );
651 __PACKAGE__->add_search_filter( 'offset' );
652 __PACKAGE__->add_search_filter( 'limit' );
653 __PACKAGE__->add_search_filter( 'check_limit' );
654 __PACKAGE__->add_search_filter( 'skip_check' );
655 __PACKAGE__->add_search_filter( 'superpage' );
656 __PACKAGE__->add_search_filter( 'superpage_size' );
657 __PACKAGE__->add_search_filter( 'estimation_strategy' );
658 __PACKAGE__->add_search_modifier( 'available' );
659 __PACKAGE__->add_search_modifier( 'staff' );
660 __PACKAGE__->add_search_modifier( 'deleted' );
661 __PACKAGE__->add_search_modifier( 'lucky' );
662
663 # Start from container data (bre, acn, acp): container(bre,bookbag,123,deadb33fdeadb33fdeadb33fdeadb33f)
664 __PACKAGE__->add_search_filter( 'container' );
665
666 # Start from a list of record ids, either bre or metarecords, depending on the #metabib modifier
667 __PACKAGE__->add_search_filter( 'record_list' );
668
669 # used internally, but generally not user-settable
670 __PACKAGE__->add_search_filter( 'preferred_language' );
671 __PACKAGE__->add_search_filter( 'preferred_language_weight' );
672 __PACKAGE__->add_search_filter( 'preferred_language_multiplier' );
673 __PACKAGE__->add_search_filter( 'core_limit' );
674
675 # XXX Valid values to be supplied by SVF
676 __PACKAGE__->add_search_filter( 'sort' );
677
678 # modifies core query, not configurable
679 __PACKAGE__->add_search_modifier( 'descending' );
680 __PACKAGE__->add_search_modifier( 'ascending' );
681 __PACKAGE__->add_search_modifier( 'nullsfirst' );
682 __PACKAGE__->add_search_modifier( 'nullslast' );
683 __PACKAGE__->add_search_modifier( 'metarecord' );
684 __PACKAGE__->add_search_modifier( 'metabib' );
685
686
687 #-------------------------------
688 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan;
689 use base 'QueryParser::query_plan';
690 use OpenSRF::Utils::Logger qw($logger);
691 use OpenSRF::Utils qw/:datetime/;
692 use Data::Dumper;
693 use OpenILS::Application::AppUtils;
694 my $apputils = "OpenILS::Application::AppUtils";
695
696
697 sub toSQL {
698     my $self = shift;
699
700     my %filters;
701
702     for my $f ( qw/preferred_language preferred_language_multiplier preferred_language_weight core_limit check_limit skip_check superpage superpage_size/ ) {
703         my $col = $f;
704         $col = 'preferred_language_multiplier' if ($f eq 'preferred_language_weight');
705         my ($filter) = $self->find_filter($f);
706         if ($filter and @{$filter->args}) {
707             $filters{$col} = $filter->args->[0];
708         }
709     }
710
711     $self->QueryParser->superpage($filters{superpage}) if ($filters{superpage});
712     $self->QueryParser->superpage_size($filters{superpage_size}) if ($filters{superpage_size});
713     $self->QueryParser->core_limit($filters{core_limit}) if ($filters{core_limit});
714
715     $logger->debug("Query plan:\n".Dumper($self));
716
717     my $flat_plan = $self->flatten;
718
719     # generate the relevance ranking
720     my $rel = '1'; # Default to something simple in case rank_list is empty.
721     if (@{$$flat_plan{rank_list}}) {
722         $rel = "AVG(\n"
723              . ${spc} x 5 ."("
724              . join(")\n" . ${spc} x 5 . "+ (", @{$$flat_plan{rank_list}})
725              . ")\n"
726              . ${spc} x 4 . ")+1";
727     }
728
729     # find any supplied sort option
730     my ($sort_filter) = $self->find_filter('sort');
731     if ($sort_filter) {
732         $sort_filter = $sort_filter->args->[0];
733     } else {
734         $sort_filter = 'rel';
735     }
736
737     if (($filters{preferred_language} || $self->QueryParser->default_preferred_language) && ($filters{preferred_language_multiplier} || $self->QueryParser->default_preferred_language_multiplier)) {
738         my $pl = $self->QueryParser->quote_value( $filters{preferred_language} ? $filters{preferred_language} : $self->QueryParser->default_preferred_language );
739         my $plw = $filters{preferred_language_multiplier} ? $filters{preferred_language_multiplier} : $self->QueryParser->default_preferred_language_multiplier;
740         $rel = "($rel * COALESCE( NULLIF( FIRST(mrd.attrs \@> hstore('item_lang', $pl)), FALSE )::INT * $plw, 1))";
741     }
742     $rel = "1.0/($rel)::NUMERIC";
743
744     my $mra_join = 'INNER JOIN metabib.record_attr mrd ON m.source = mrd.id';
745
746     my $bre_join = '';
747     if ($self->find_modifier('deleted')) {
748         $bre_join = 'INNER JOIN biblio.record_entry bre ON m.source = bre.id AND bre.deleted';
749         # The above suffices for filters too when the #deleted modifier
750         # is in use.
751     } elsif ($$flat_plan{uses_bre}) {
752         $bre_join = 'INNER JOIN biblio.record_entry bre ON m.source = bre.id';
753     }
754     
755     my $rank = $rel;
756
757     my $desc = 'ASC';
758     $desc = 'DESC' if ($self->find_modifier('descending'));
759
760     my $nullpos = 'NULLS LAST';
761     $nullpos = 'NULLS FIRST' if ($self->find_modifier('nullsfirst'));
762
763     if (grep {$_ eq $sort_filter} @{$self->QueryParser->dynamic_sorters}) {
764         $rank = "FIRST(mrd.attrs->'$sort_filter')"
765     } elsif ($sort_filter eq 'create_date') {
766         $rank = "FIRST((SELECT create_date FROM biblio.record_entry rbr WHERE rbr.id = m.source))";
767     } elsif ($sort_filter eq 'edit_date') {
768         $rank = "FIRST((SELECT edit_date FROM biblio.record_entry rbr WHERE rbr.id = m.source))";
769     } else {
770         # default to rel ranking
771         $rank = $rel;
772     }
773
774     my $key = 'm.source';
775     $key = 'm.metarecord' if (grep {$_->name eq 'metarecord' or $_->name eq 'metabib'} @{$self->modifiers});
776
777     my $core_limit = $self->QueryParser->core_limit || 25000;
778     $core_limit = 1 if($self->find_modifier('lucky'));
779
780     my $flat_where = $$flat_plan{where};
781     if ($flat_where ne '') {
782         $flat_where = "AND (\n" . ${spc} x 5 . $flat_where . "\n" . ${spc} x 4 . ")";
783     }
784     my $with = $$flat_plan{with};
785     $with= "\nWITH $with" if $with;
786
787     # Need an array for query parser db function; this gives a better plan
788     # than the ARRAY_AGG(DISTINCT m.source) option as of PostgreSQL 9.1
789     my $agg_records = 'ARRAY[m.source] AS records';
790     if ($key =~ /metarecord/) {
791         # metarecord searches still require the ARRAY_AGG approach
792         $agg_records = 'ARRAY_AGG(DISTINCT m.source) AS records';
793     }
794
795     my $sql = <<SQL;
796 $with
797 SELECT  $key AS id,
798         $agg_records,
799         $rel AS rel,
800         $rank AS rank, 
801         FIRST(mrd.attrs->'date1') AS tie_break
802   FROM  metabib.metarecord_source_map m
803         $$flat_plan{from}
804         $mra_join
805         $bre_join
806   WHERE 1=1
807         $flat_where
808   GROUP BY 1
809   ORDER BY 4 $desc $nullpos, 5 DESC $nullpos, 3 DESC
810   LIMIT $core_limit
811 SQL
812
813     warn $sql if $self->QueryParser->debug;
814     return $sql;
815
816 }
817
818 sub flatten {
819     my $self = shift;
820
821     my $from = shift || '';
822     my $where = shift || '';
823     my $with = '';
824     my $uses_bre = 0;
825
826     my @rank_list;
827     for my $node ( @{$self->query_nodes} ) {
828
829         if (ref($node)) {
830             if ($node->isa( 'QueryParser::query_plan::node' )) {
831
832                 unless (@{$node->only_atoms}) {
833                     push @rank_list, '1';
834                     $where .= 'TRUE';
835                     next;
836                 }
837
838                 my $table = $node->table;
839                 my $ctable = $node->combined_table;
840                 my $talias = $node->table_alias;
841
842                 my $node_rank = 'COALESCE(' . $node->rank . " * ${talias}.weight, 0.0)";
843
844                 $from .= "\n" . ${spc} x 4 ."LEFT JOIN (\n"
845                       . ${spc} x 5 . "SELECT fe.*, fe_weight.weight, ${talias}_xq.tsq, ${talias}_xq.tsq_rank /* search */\n"
846                       . ${spc} x 6 . "FROM  $table AS fe";
847                 $from .= "\n" . ${spc} x 7 . "JOIN config.metabib_field AS fe_weight ON (fe_weight.id = fe.field)";
848
849                 my @bump_fields;
850                 my @field_ids;
851                 if (@{$node->fields} > 0) {
852                     @bump_fields = @{$node->fields};
853
854                     @field_ids = grep defined, (
855                         map {
856                             $self->QueryParser->search_field_ids_by_class(
857                                 $node->classname, $_
858                             )->[0]
859                         } @bump_fields
860                     );
861                 } else {
862                     @bump_fields = @{$self->QueryParser->search_fields->{$node->classname}};
863                 }
864
865                 if ($node->dummy_count < @{$node->only_atoms} ) {
866                     $with .= ",\n     " if $with;
867                     $with .= "${talias}_xq AS (SELECT ". $node->tsquery ." AS tsq,". $node->tsquery_rank ." AS tsq_rank )";
868                     if ($node->combined_search) {
869                         $from .= "\n" . ${spc} x 6 . "JOIN $ctable AS com ON (com.record = fe.source";
870                         if (@field_ids) {
871                             $from .= " AND com.metabib_field IN (" . join(',',@field_ids) . "))";
872                         } else {
873                             $from .= " AND com.metabib_field IS NULL)";
874                         }
875                         $from .= "\n" . ${spc} x 6 . "JOIN ${talias}_xq ON (com.index_vector @@ ${talias}_xq.tsq)";
876                     } else {
877                         $from .= "\n" . ${spc} x 6 . "JOIN ${talias}_xq ON (fe.index_vector @@ ${talias}_xq.tsq)";
878                     }
879                 } else {
880                     $from .= "\n" . ${spc} x 6 . ", (SELECT NULL::tsquery AS tsq, NULL:tsquery AS tsq_rank ) AS ${talias}_xq";
881                 }
882
883                 if (@field_ids) {
884                     $from .= "\n" . ${spc} x 6 . "WHERE fe_weight.id IN  (" .
885                         join(',', @field_ids) . ")";
886                 }
887
888                 $from .= "\n" . ${spc} x 4 . ") AS $talias ON (m.source = ${talias}.source)";
889
890                 my %used_bumps;
891                 my @bumps;
892                 my @bumpmults;
893                 for my $field ( @bump_fields ) {
894                     my $bumps = $self->QueryParser->find_relevance_bumps( $node->classname => $field );
895                     for my $b (keys %$bumps) {
896                         next if (!$$bumps{$b}{active});
897                         next if ($used_bumps{$b});
898                         $used_bumps{$b} = 1;
899
900                         next if ($$bumps{$b}{multiplier} == 1); # optimization to remove unneeded bumps
901                         push @bumps, $b;
902                         push @bumpmults, $$bumps{$b}{multiplier};
903                     }
904                 }
905
906                 if(scalar @bumps > 0 && scalar @{$node->only_positive_atoms} > 0) {
907                     # Note: Previous rank function used search_normalize outright. Duplicating that here.
908                     $node_rank .= "\n" . ${spc} x 5 . "* evergreen.rel_bump(('{' || quote_literal(search_normalize(";
909                     $node_rank .= join(")) || ',' || quote_literal(search_normalize(",map { $self->QueryParser->quote_phrase_value($_->content) } @{$node->only_positive_atoms});
910                     $node_rank .= ")) || '}')::TEXT[], " . $node->table_alias . ".value, '{" . join(",",@bumps) . "}'::TEXT[], '{" . join(",",@bumpmults) . "}'::NUMERIC[])";
911                 }
912
913                 my $NOT = '';
914                 $NOT = 'NOT ' if $node->negate;
915
916                 $where .= "$NOT(" . $talias . ".id IS NOT NULL";
917                 if (@{$node->phrases}) {
918                     $where .= ' AND ' . join(' AND ', map {
919                         "${talias}.value ~* ".$self->QueryParser->quote_phrase_value($_, 1)
920                     } @{$node->phrases});
921                 } else {
922                     for my $atom (@{$node->only_real_atoms}) {
923                         next unless $atom->{content} && $atom->{content} =~ /(^\^|\$$)/;
924                         $where .= " AND ${talias}.value ~* ".$self->QueryParser->quote_phrase_value($atom->{content});
925                     }
926                 }
927                 $where .= ')';
928
929                 push @rank_list, $node_rank;
930
931             } elsif ($node->isa( 'QueryParser::query_plan::facet' )) {
932
933                 my $talias = $node->table_alias;
934
935                 my @field_ids;
936                 if (@{$node->fields} > 0) {
937                     push(@field_ids, $self->QueryParser->facet_field_ids_by_class( $node->classname, $_ )->[0]) for (@{$node->fields});
938                 } else {
939                     @field_ids = @{ $self->QueryParser->facet_field_ids_by_class( $node->classname ) };
940                 }
941
942                 my $join_type = ($node->negate or !$self->top_plan) ? 'LEFT' : 'INNER';
943                 $from .= "\n${spc}$join_type JOIN /* facet */ metabib.facet_entry $talias ON (\n"
944                       . ${spc} x 2 . "m.source = ${talias}.source\n"
945                       . ${spc} x 2 . "AND SUBSTRING(${talias}.value,1,1024) IN ("
946                       . join(",", map { $self->QueryParser->quote_value($_) } @{$node->values}) . ")\n"
947                       . ${spc} x 2 ."AND ${talias}.field IN (". join(',', @field_ids) . ")\n"
948                       . "${spc})";
949
950                 if ($join_type != 'INNER') {
951                     my $NOT = $node->negate ? '' : ' NOT';
952                     $where .= "${talias}.id IS$NOT NULL";
953                 } elsif ($where ne '') {
954                     # Strip extra joiner
955                     $where =~ s/(\s|\n)+(AND|OR)\s$//;
956                 }
957
958             } else {
959                 my $subnode = $node->flatten;
960
961                 # strip the trailing bool from the previous loop if there is 
962                 # nothing to add to the where within this loop.
963                 if ($$subnode{where} eq '') {
964                     $where =~ s/(\s|\n)+(AND|OR)\s$//;
965                 }
966
967                 push(@rank_list, @{$$subnode{rank_list}});
968                 $from .= $$subnode{from};
969
970                 my $NOT = '';
971                 $NOT = 'NOT ' if $node->negate;
972
973                 if ($$subnode{where} ne '') {
974                     $where .= "$NOT(\n"
975                            . ${spc} x ($self->plan_level + 6) . $$subnode{where} . "\n"
976                            . ${spc} x ($self->plan_level + 5) . ')';
977                 }
978
979                 if ($$subnode{with}) {
980                     $with .= ",\n     " if $with;
981                     $with .= $$subnode{with};
982                 }
983
984                 $uses_bre = $$subnode{uses_bre};
985             }
986         } else {
987
988             warn "flatten(): appending WHERE bool to: $where\n" if $self->QueryParser->debug;
989
990             if ($where ne '') {
991                 $where .= "\n" . ${spc} x ( $self->plan_level + 5 ) . 'AND ' if ($node eq '&');
992                 $where .= "\n" . ${spc} x ( $self->plan_level + 5 ) . 'OR ' if ($node eq '|');
993             }
994         }
995     }
996
997     my $joiner = "\n" . ${spc} x ( $self->plan_level + 5 ) . ($self->joiner eq '&' ? 'AND ' : 'OR ');
998     # for each dynamic filter, build more of the WHERE clause
999     for my $filter (@{$self->filters}) {
1000         my $NOT = $filter->negate ? 'NOT ' : '';
1001         if (grep { $_ eq $filter->name } @{ $self->QueryParser->dynamic_filters }) {
1002
1003             warn "flatten(): processing dynamic filter ". $filter->name ."\n"
1004                 if $self->QueryParser->debug;
1005
1006             # bool joiner for intra-plan nodes/filters
1007             $where .= $joiner if $where ne '';
1008
1009             my @fargs = @{$filter->args};
1010             my $fname = $filter->name;
1011             $fname = 'item_lang' if $fname eq 'language'; #XXX filter aliases 
1012
1013             $where .= sprintf(
1014                 "${NOT}COALESCE((mrd.attrs->'%s') IN (%s), false)", $fname, 
1015                 join(',', map { $self->QueryParser->quote_value($_) } @fargs)
1016             );
1017
1018             warn "flatten(): filter where => $where\n"
1019                 if $self->QueryParser->debug;
1020         } else {
1021             if ($filter->name eq 'before') {
1022                 if (@{$filter->args} == 1) {
1023                     $where .= $joiner if $where ne '';
1024                     $where .= "${NOT}COALESCE((mrd.attrs->'date1') <= "
1025                            . $self->QueryParser->quote_value($filter->args->[0])
1026                            . ", false)";
1027                 }
1028             } elsif ($filter->name eq 'after') {
1029                 if (@{$filter->args} == 1) {
1030                     $where .= $joiner if $where ne '';
1031                     $where .= "${NOT}COALESCE((mrd.attrs->'date1') >= "
1032                            . $self->QueryParser->quote_value($filter->args->[0])
1033                            . ", false)";
1034                 }
1035             } elsif ($filter->name eq 'during') {
1036                 if (@{$filter->args} == 1) {
1037                     $where .= $joiner if $where ne '';
1038                     $where .= "${NOT}COALESCE("
1039                            . $self->QueryParser->quote_value($filter->args->[0])
1040                            . " BETWEEN (mrd.attrs->'date1') AND (mrd.attrs->'date2'), false)";
1041                 }
1042             } elsif ($filter->name eq 'between') {
1043                 if (@{$filter->args} == 2) {
1044                     $where .= $joiner if $where ne '';
1045                     $where .= "${NOT}COALESCE((mrd.attrs->'date1') BETWEEN "
1046                            . $self->QueryParser->quote_value($filter->args->[0])
1047                            . " AND "
1048                            . $self->QueryParser->quote_value($filter->args->[1])
1049                            . ", false)";
1050                 }
1051             } elsif ($filter->name eq 'container') {
1052                 if (@{$filter->args} >= 3) {
1053                     my ($class, $ctype, $cid, $token) = @{$filter->args};
1054                     my $perm_join = '';
1055                     my $rec_join = '';
1056                     my $rec_field = 'ci.target_biblio_record_entry';
1057                     if ($class eq 'bre') {
1058                         $class = 'biblio_record_entry';
1059                     } elsif ($class eq 'acn') {
1060                         $class = 'call_number';
1061                         $rec_field = 'cn.record';
1062                         $rec_join = 'JOIN asset.call_number cn ON (ci.target_call_number = cn.id)';
1063                     } elsif ($class eq 'acp') {
1064                         $class = 'copy';
1065                         $rec_field = 'cn.record';
1066                         $rec_join = 'JOIN asset.copy cp ON (ci.target_copy = cp.id) JOIN asset.call_number cn ON (cp.call_number = cn.id)';
1067                     } else {
1068                         $class = undef;
1069                     }
1070
1071                     if ($class) {
1072                         my ($u,$e) = $apputils->checksesperm($token) if ($token);
1073                         $perm_join = ' OR c.owner = ' . $u->id if ($u && !$e);
1074
1075                         my $filter_alias = "$filter";
1076                         $filter_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
1077                         $filter_alias =~ s/\|/_/go;
1078
1079                         $with .= ",\n     " if $with;
1080                         $with .= "container_${filter_alias} AS (\n";
1081                         $with .= "       SELECT $rec_field AS record FROM container.${class}_bucket_item ci\n"
1082                                . "             JOIN container.${class}_bucket c ON (c.id = ci.bucket) $rec_join\n"
1083                                . "       WHERE c.btype = " . $self->QueryParser->quote_value($ctype) . "\n"
1084                                . "             AND c.id = " . $self->QueryParser->quote_value($cid) . "\n"
1085                                . "             AND (c.pub IS TRUE$perm_join)\n";
1086                         if ($class eq 'copy') {
1087                             $with .= "       UNION\n"
1088                                    . "       SELECT pr.peer_record AS record FROM container.copy_bucket_item ci\n"
1089                                    . "             JOIN container.copy_bucket c ON (c.id = ci.bucket)\n"
1090                                    . "             JOIN biblio.peer_bib_copy_map pr ON ci.target_copy = pr.target_copy\n"
1091                                    . "       WHERE c.btype = " . $self->QueryParser->quote_value($ctype) . "\n"
1092                                    . "             AND c.id = " . $self->QueryParser->quote_value($cid) . "\n"
1093                                    . "             AND (c.pub IS TRUE$perm_join)\n";
1094                         }
1095                         $with .= "     )";
1096
1097                         $from .= "\n" . ${spc} x 3 . "LEFT JOIN container_${filter_alias} ON container_${filter_alias}.record = m.source";
1098
1099                         my $spcdepth = $self->plan_level + 5;
1100
1101                         $where .= $joiner if $where ne '';
1102                         $where .= "${NOT}(container_${filter_alias} IS NOT NULL)";
1103                     }
1104                 }
1105             } elsif ($filter->name eq 'record_list') {
1106                 if (@{$filter->args} > 0) {
1107                     my $key = 'm.source';
1108                     $key = 'm.metarecord' if (grep {$_->name eq 'metarecord' or $_->name eq 'metabib'} @{$self->QueryParser->parse_tree->modifiers});
1109                     $where .= $joiner if $where ne '';
1110                     $where .= "$key ${NOT}IN (" . join(',', map { $self->QueryParser->quote_value($_) } @{$filter->args}) . ')';
1111                 }
1112
1113             } elsif ($filter->name eq 'edit_date' or $filter->name eq 'create_date') {
1114                 # bre.create_date and bre.edit_date filtering
1115                 my $datefilter = $filter->name;
1116
1117                 $uses_bre = 1;
1118
1119                 if ($filter && $filter->args && scalar(@{$filter->args}) > 0 && scalar(@{$filter->args}) < 3) {
1120                     my ($cstart, $cend) = @{$filter->args};
1121         
1122                     if (!$cstart and !$cend) {
1123                         # useless use of filter
1124                     } elsif (!$cstart or $cstart eq '-infinity') { # no start supplied
1125                         if ($cend eq 'infinity') {
1126                             # useless use of filter
1127                         } else {
1128                             # "before $cend"
1129                             $cend = cleanse_ISO8601($cend);
1130                             $where .= $joiner if $where ne '';
1131                             $where .= "bre.$datefilter <= \$_$$\$$cend\$_$$\$";
1132                         }
1133             
1134                     } elsif (!$cend or $cend eq 'infinity') { # no end supplied
1135                         if ($cstart eq '-infinity') {
1136                             # useless use of filter
1137                         } else { # "after $cstart"
1138                             $cstart = cleanse_ISO8601($cstart);
1139                             $where .= $joiner if $where ne '';
1140                             $where .= "bre.$datefilter >= \$_$$\$$cstart\$_$$\$";
1141                         }
1142                     } else { # both supplied
1143                         # "between $cstart and $cend"
1144                         $cstart = cleanse_ISO8601($cstart);
1145                         $cend = cleanse_ISO8601($cend);
1146                         $where .= $joiner if $where ne '';
1147                         $where .= "bre.$datefilter BETWEEN \$_$$\$$cstart\$_$$\$ AND \$_$$\$$cend\$_$$\$";
1148                     }
1149                 }
1150             } elsif ($filter->name eq 'bib_source') {
1151                 $uses_bre = 1;
1152
1153                 if (@{$filter->args} > 0) {
1154                     $where .= $joiner if $where ne '';
1155                     $where .= "${NOT}COALESCE(bre.source IN ("
1156                            . join(',', map { $self->QueryParser->quote_value($_) } @{ $filter->args })
1157                            . "), false)";
1158                 }
1159             }
1160         }
1161     }
1162     warn "flatten(): full filter where => $where\n" if $self->QueryParser->debug;
1163
1164     return { rank_list => \@rank_list, from => $from, where => $where,  with => $with, uses_bre => $uses_bre };
1165 }
1166
1167
1168 #-------------------------------
1169 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::filter;
1170 use base 'QueryParser::query_plan::filter';
1171
1172 #-------------------------------
1173 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::facet;
1174 use base 'QueryParser::query_plan::facet';
1175
1176 sub classname {
1177     my $self = shift;
1178     my ($classname) = split '\|', $self->name;
1179     return $classname;
1180 }
1181
1182 sub fields {
1183     my $self = shift;
1184     my ($classname,@fields) = split '\|', $self->name;
1185     return \@fields;
1186 }
1187
1188 sub table_alias {
1189     my $self = shift;
1190
1191     my $table_alias = "$self";
1192     $table_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
1193     $table_alias .= '_' . $self->name;
1194     $table_alias =~ s/\|/_/go;
1195
1196     return $table_alias;
1197 }
1198
1199
1200 #-------------------------------
1201 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::modifier;
1202 use base 'QueryParser::query_plan::modifier';
1203
1204 #-------------------------------
1205 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::node::atom;
1206 use base 'QueryParser::query_plan::node::atom';
1207
1208 sub sql {
1209     my $self = shift;
1210     my $sql = shift;
1211
1212     $self->{sql} = $sql if ($sql);
1213
1214     return $self->{sql} if ($self->{sql});
1215     return $self->buildSQL;
1216 }
1217
1218 sub buildSQL {
1219     my $self = shift;
1220
1221     my $classname = $self->node->classname;
1222
1223     return $self->sql("to_tsquery('$classname','')") if $self->{dummy};
1224
1225     my $normalizers = $self->node->plan->QueryParser->query_normalizers( $classname );
1226     my $fields = $self->node->fields;
1227
1228     my $lang;
1229     my $filter = $self->node->plan->find_filter('preferred_language');
1230     $lang ||= $filter->args->[0] if ($filter && $filter->args);
1231     $lang ||= $self->node->plan->QueryParser->default_preferred_language;
1232     my $ts_configs = [];
1233
1234     if (@{$self->node->phrases}) {
1235         # We assume we want 'simple' for phrases. Gives us less to match against later.
1236         $ts_configs = ['simple'];
1237     } else {
1238         if (!@$fields) {
1239             $ts_configs = $self->node->plan->QueryParser->class_ts_config($classname, $lang);
1240         } else {
1241             for my $field (@$fields) {
1242                 push @$ts_configs, @{$self->node->plan->QueryParser->field_ts_config($classname, $field, $lang)};
1243             }
1244         }
1245         $ts_configs = [keys %{{map { $_ => 1 } @$ts_configs}}];
1246     }
1247
1248     # Assume we want exact if none otherwise provided.
1249     # Because we can reasonably expect this to exist
1250     $ts_configs = ['simple'] unless (scalar @$ts_configs);
1251
1252     $fields = $self->node->plan->QueryParser->search_fields->{$classname} if (!@$fields);
1253
1254     my %norms;
1255     my $pos = 0;
1256     for my $field (@$fields) {
1257         for my $nfield (keys %$normalizers) {
1258             for my $nizer ( @{$$normalizers{$nfield}} ) {
1259                 if ($field eq $nfield) {
1260                     my $param_string = OpenSRF::Utils::JSON->perl2JSON($nizer->{params});
1261                     if (!exists($norms{$nizer->{function}.$param_string})) {
1262                         $norms{$nizer->{function}.$param_string} = {p=>$pos++,n=>$nizer};
1263                     }
1264                 }
1265             }
1266         }
1267     }
1268
1269     my $sql = $self->node->plan->QueryParser->quote_value($self->content);
1270
1271     for my $n ( map { $$_{n} } sort { $$a{p} <=> $$b{p} } values %norms ) {
1272         $sql = join(', ', $sql, map { $self->node->plan->QueryParser->quote_value($_) } @{ $n->{params} });
1273         $sql = $n->{function}."($sql)";
1274     }
1275
1276     my $prefix = $self->prefix || '';
1277     my $suffix = $self->suffix || '';
1278     my $joiner = ' || ';
1279     $joiner = ' && ' if $self->prefix eq '!'; # Negative atoms should be "none of the variants" instead of "any of the variants"
1280
1281     $prefix = "'$prefix' ||" if $prefix;
1282     my $suffix_op = '';
1283     my $suffix_after = '';
1284
1285     $suffix_op = ":$suffix" if $suffix;
1286     $suffix_after = "|| '$suffix_op'" if $suffix;
1287
1288     my @sql_set = ();
1289     for my $ts_config (@$ts_configs) {
1290         push @sql_set, "to_tsquery('$ts_config', COALESCE(NULLIF($prefix '(' || btrim(regexp_replace($sql,E'(?:\\\\s+|:)','$suffix_op&','g'),'&|') $suffix_after || ')', '()'), ''))";
1291     }
1292
1293     $sql = join($joiner, @sql_set);
1294     $sql = '(' . $sql . ')' if (scalar(@$ts_configs) > 1);
1295
1296     return $self->sql($sql);
1297 }
1298
1299 #-------------------------------
1300 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::node;
1301 use base 'QueryParser::query_plan::node';
1302
1303 sub only_atoms {
1304     my $self = shift;
1305
1306     $self->{dummy_count} = 0;
1307
1308     my $atoms = $self->query_atoms;
1309     my @only_atoms;
1310     for my $a (@$atoms) {
1311         push(@only_atoms, $a) if (ref($a) && $a->isa('QueryParser::query_plan::node::atom'));
1312         $self->{dummy_count}++ if (ref($a) && $a->{dummy});
1313     }
1314
1315     return \@only_atoms;
1316 }
1317
1318 sub only_real_atoms {
1319     my $self = shift;
1320
1321     my $atoms = $self->query_atoms;
1322     my @only_real_atoms;
1323     for my $a (@$atoms) {
1324         push(@only_real_atoms, $a) if (ref($a) && $a->isa('QueryParser::query_plan::node::atom') && !($a->{dummy}));
1325     }
1326
1327     return \@only_real_atoms;
1328 }
1329
1330 sub only_positive_atoms {
1331     my $self = shift;
1332
1333     my $atoms = $self->query_atoms;
1334     my @only_positive_atoms;
1335     for my $a (@$atoms) {
1336         push(@only_positive_atoms, $a) if (ref($a) && $a->isa('QueryParser::query_plan::node::atom') && !($a->{dummy}) && ($a->{prefix} ne '!'));
1337     }
1338
1339     return \@only_positive_atoms;
1340 }
1341
1342 sub dummy_count {
1343     my $self = shift;
1344     return $self->{dummy_count};
1345 }
1346
1347 sub table {
1348     my $self = shift;
1349     my $table = shift;
1350     $self->{table} = $table if ($table);
1351     return $self->{table} if $self->{table};
1352     return $self->table( 'metabib.' . $self->classname . '_field_entry' );
1353 }
1354
1355 sub combined_table {
1356     my $self = shift;
1357     my $ctable = shift;
1358     $self->{ctable} = $ctable if ($ctable);
1359     return $self->{ctable} if $self->{ctable};
1360     return $self->combined_table( 'metabib.combined_' . $self->classname . '_field_entry' );
1361 }
1362
1363 sub combined_search {
1364     my $self = shift;
1365     return $self->plan->QueryParser->search_class_combined($self->classname);
1366 }
1367
1368 sub table_alias {
1369     my $self = shift;
1370     my $table_alias = shift;
1371     $self->{table_alias} = $table_alias if ($table_alias);
1372     return $self->{table_alias} if ($self->{table_alias});
1373
1374     $table_alias = "$self";
1375     $table_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
1376     $table_alias .= '_' . $self->requested_class;
1377     $table_alias =~ s/\|/_/go;
1378
1379     return $self->table_alias( $table_alias );
1380 }
1381
1382 sub tsquery {
1383     my $self = shift;
1384     return $self->{tsquery} if ($self->{tsquery});
1385
1386     for my $atom (@{$self->query_atoms}) {
1387         if (ref($atom)) {
1388             $self->{tsquery} .= "\n" . ${spc} x 3 . $atom->sql;
1389         } else {
1390             $self->{tsquery} .= $atom x 2;
1391         }
1392     }
1393
1394     return $self->{tsquery};
1395 }
1396
1397 sub tsquery_rank {
1398     my $self = shift;
1399     return $self->{tsquery_rank} if ($self->{tsquery_rank});
1400     my @atomlines;
1401
1402     for my $atom (@{$self->only_positive_atoms}) {
1403         push @atomlines, "\n" . ${spc} x 3 . $atom->sql;
1404     }
1405     $self->{tsquery_rank} = join(' ||', @atomlines);
1406     $self->{tsquery_rank} = 'NULL::tsquery' unless $self->{tsquery_rank};
1407     return $self->{tsquery_rank};
1408 }
1409
1410 sub rank {
1411     my $self = shift;
1412     return $self->{rank} if ($self->{rank});
1413
1414     my $rank_norm_map = $self->plan->QueryParser->custom_data->{rank_cd_weight_map};
1415
1416     my $cover_density = 0;
1417     for my $norm ( keys %$rank_norm_map) {
1418         $cover_density += $$rank_norm_map{$norm} if ($self->plan->find_modifier($norm));
1419     }
1420
1421     my $weights = join(', ', @{$self->plan->QueryParser->search_class_weights($self->classname)});
1422
1423     return $self->{rank} = "ts_rank_cd('{" . $weights . "}', " . $self->table_alias . '.index_vector, ' . $self->table_alias . ".tsq_rank, $cover_density)";
1424 }
1425
1426
1427 1;
1428