a9309319d7e2d40db1224fc77a5558075f9ef609
[working/Evergreen.git] / Open-ILS / src / perlmods / lib / OpenILS / Application / Storage / Driver / Pg / QueryParser.pm
1 package OpenILS::Application::Storage::Driver::Pg::QueryParser;
2 use OpenILS::Application::Storage::QueryParser;
3 use base 'QueryParser';
4 use OpenSRF::Utils::JSON;
5 use OpenILS::Application::AppUtils;
6 my $U = 'OpenILS::Application::AppUtils';
7
8 sub quote_value {
9     my $self = shift;
10     my $value = shift;
11
12     if ($value =~ /^\d/) { # may have to use non-$ quoting
13         $value =~ s/'/''/g;
14         $value =~ s/\\/\\\\/g;
15         return "E'$value'";
16     }
17     return "\$_$$\$$value\$_$$\$";
18 }
19
20 sub quote_phrase_value {
21     my $self = shift;
22     my $value = shift;
23
24     my $left_anchored  = $value =~ m/^\^/;
25     my $right_anchored = $value =~ m/\$$/;
26     $value =~ s/\^//   if $left_anchored;
27     $value =~ s/\$$//  if $right_anchored;
28     $value =~ quotemeta($value);
29     $value = '^' . $value if $left_anchored;
30     $value = "$value\$"   if $right_anchored;
31     return $self->quote_value($value);
32 }
33
34 sub init {
35     my $class = shift;
36 }
37
38 sub default_preferred_language {
39     my $self = shift;
40     my $lang = shift;
41
42     $self->custom_data->{default_preferred_language} = $lang if ($lang);
43     return $self->custom_data->{default_preferred_language};
44 }
45
46 sub default_preferred_language_multiplier {
47     my $self = shift;
48     my $lang = shift;
49
50     $self->custom_data->{default_preferred_language_multiplier} = $lang if ($lang);
51     return $self->custom_data->{default_preferred_language_multiplier};
52 }
53
54 sub simple_plan {
55     my $self = shift;
56
57     return 0 unless $self->parse_tree;
58     return 0 if @{$self->parse_tree->filters};
59     return 0 if @{$self->parse_tree->modifiers};
60     for my $node ( @{ $self->parse_tree->query_nodes } ) {
61         return 0 if (!ref($node) && $node eq '|');
62         next unless (ref($node));
63         return 0 if ($node->isa('QueryParser::query_plan'));
64     }
65
66     return 1;
67 }
68
69 sub toSQL {
70     my $self = shift;
71     return $self->parse_tree->toSQL;
72 }
73
74 sub dynamic_filters {
75     my $self = shift;
76     my $new = shift;
77
78     $self->custom_data->{dynamic_filters} ||= [];
79     push(@{$self->custom_data->{dynamic_filters}}, $new) if ($new);
80     return $self->custom_data->{dynamic_filters};
81 }
82
83 sub dynamic_sorters {
84     my $self = shift;
85     my $new = shift;
86
87     $self->custom_data->{dynamic_sorters} ||= [];
88     push(@{$self->custom_data->{dynamic_sorters}}, $new) if ($new);
89     return $self->custom_data->{dynamic_sorters};
90 }
91
92 sub facet_field_id_map {
93     my $self = shift;
94     my $map = shift;
95
96     $self->custom_data->{facet_field_id_map} ||= {};
97     $self->custom_data->{facet_field_id_map} = $map if ($map);
98     return $self->custom_data->{facet_field_id_map};
99 }
100
101 sub add_facet_field_id_map {
102     my $self = shift;
103     my $class = shift;
104     my $field = shift;
105     my $id = shift;
106     my $weight = shift;
107
108     $self->add_facet_field( $class => $field );
109     $self->facet_field_id_map->{by_id}{$id} = { classname => $class, field => $field, weight => $weight };
110     $self->facet_field_id_map->{by_class}{$class}{$field} = $id;
111
112     return {
113         by_id => { $id => { classname => $class, field => $field, weight => $weight } },
114         by_class => { $class => { $field => $id } }
115     };
116 }
117
118 sub facet_field_class_by_id {
119     my $self = shift;
120     my $id = shift;
121
122     return $self->facet_field_id_map->{by_id}{$id};
123 }
124
125 sub facet_field_ids_by_class {
126     my $self = shift;
127     my $class = shift;
128     my $field = shift;
129
130     return undef unless ($class);
131
132     if ($field) {
133         return [$self->facet_field_id_map->{by_class}{$class}{$field}];
134     }
135
136     return [values( %{ $self->facet_field_id_map->{by_class}{$class} } )];
137 }
138
139 sub search_field_id_map {
140     my $self = shift;
141     my $map = shift;
142
143     $self->custom_data->{search_field_id_map} ||= {};
144     $self->custom_data->{search_field_id_map} = $map if ($map);
145     return $self->custom_data->{search_field_id_map};
146 }
147
148 sub add_search_field_id_map {
149     my $self = shift;
150     my $class = shift;
151     my $field = shift;
152     my $id = shift;
153     my $weight = shift;
154
155     $self->add_search_field( $class => $field );
156     $self->search_field_id_map->{by_id}{$id} = { classname => $class, field => $field, weight => $weight };
157     $self->search_field_id_map->{by_class}{$class}{$field} = $id;
158
159     return {
160         by_id => { $id => { classname => $class, field => $field, weight => $weight } },
161         by_class => { $class => { $field => $id } }
162     };
163 }
164
165 sub search_field_class_by_id {
166     my $self = shift;
167     my $id = shift;
168
169     return $self->search_field_id_map->{by_id}{$id};
170 }
171
172 sub search_field_ids_by_class {
173     my $self = shift;
174     my $class = shift;
175     my $field = shift;
176
177     return undef unless ($class);
178
179     if ($field) {
180         return [$self->search_field_id_map->{by_class}{$class}{$field}];
181     }
182
183     return [values( %{ $self->search_field_id_map->{by_class}{$class} } )];
184 }
185
186 sub relevance_bumps {
187     my $self = shift;
188     my $bumps = shift;
189
190     $self->custom_data->{rel_bumps} ||= {};
191     $self->custom_data->{rel_bumps} = $bumps if ($bumps);
192     return $self->custom_data->{rel_bumps};
193 }
194
195 sub find_relevance_bumps {
196     my $self = shift;
197     my $class = shift;
198     my $field = shift;
199
200     return $self->relevance_bumps->{$class}{$field};
201 }
202
203 sub add_relevance_bump {
204     my $self = shift;
205     my $class = shift;
206     my $field = shift;
207     my $type = shift;
208     my $multiplier = shift;
209     my $active = shift;
210
211     $active = 1 if (!defined($active));
212
213     $self->relevance_bumps->{$class}{$field}{$type} = { multiplier => $multiplier, active => $active };
214
215     return { $class => { $field => { $type => { multiplier => $multiplier, active => $active } } } };
216 }
217
218
219 sub initialize_search_field_id_map {
220     my $self = shift;
221     my $cmf_list = shift;
222
223     for my $cmf (@$cmf_list) {
224         __PACKAGE__->add_search_field_id_map( $cmf->field_class, $cmf->name, $cmf->id, $cmf->weight ) if ($U->is_true($cmf->search_field));
225         __PACKAGE__->add_facet_field_id_map( $cmf->field_class, $cmf->name, $cmf->id, $cmf->weight ) if ($U->is_true($cmf->facet_field));
226     }
227
228     return $self->search_field_id_map;
229 }
230
231 sub initialize_aliases {
232     my $self = shift;
233     my $cmsa_list = shift;
234
235     for my $cmsa (@$cmsa_list) {
236         if (!$cmsa->field) {
237             __PACKAGE__->add_search_class_alias( $cmsa->field_class, $cmsa->alias );
238         } else {
239             my $c = $self->search_field_class_by_id( $cmsa->field );
240             __PACKAGE__->add_search_field_alias( $cmsa->field_class, $c->{field}, $cmsa->alias );
241         }
242     }
243 }
244
245 sub initialize_relevance_bumps {
246     my $self = shift;
247     my $sra_list = shift;
248
249     for my $sra (@$sra_list) {
250         my $c = $self->search_field_class_by_id( $sra->field );
251         __PACKAGE__->add_relevance_bump( $c->{classname}, $c->{field}, $sra->bump_type, $sra->multiplier );
252     }
253
254     return $self->relevance_bumps;
255 }
256
257 sub initialize_query_normalizers {
258     my $self = shift;
259     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" }] }
260
261     for my $cmfinm ( @$tree ) {
262         my $field_info = $self->search_field_class_by_id( $cmfinm->field );
263         __PACKAGE__->add_query_normalizer( $field_info->{classname}, $field_info->{field}, $cmfinm->norm->func, OpenSRF::Utils::JSON->JSON2perl($cmfinm->params) );
264     }
265 }
266
267 sub initialize_dynamic_filters {
268     my $self = shift;
269     my $list = shift; # open-ils.cstore.direct.config.record_attr_definition.search.atomic { "id" : { "!=" : null } }
270
271     for my $crad ( @$list ) {
272         __PACKAGE__->dynamic_filters( __PACKAGE__->add_search_filter( $crad->name ) ) if ($U->is_true($crad->filter));
273         __PACKAGE__->dynamic_sorters( $crad->name ) if ($U->is_true($crad->sorter));
274     }
275 }
276
277 sub initialize_filter_normalizers {
278     my $self = shift;
279     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" }] }
280
281     for my $crainm ( @$tree ) {
282         __PACKAGE__->add_filter_normalizer( $crainm->name, $crainm->norm->func, OpenSRF::Utils::JSON->JSON2perl($crainm->params) );
283     }
284 }
285
286 our $_complete = 0;
287 sub initialization_complete {
288     return $_complete;
289 }
290
291 sub initialize {
292     my $self = shift;
293     my %args = @_;
294
295     return $_complete if ($_complete);
296
297     # tsearch rank normalization adjustments. see http://www.postgresql.org/docs/9.0/interactive/textsearch-controls.html#TEXTSEARCH-RANKING for details
298     $self->custom_data->{rank_cd_weight_map} = {
299         CD_logDocumentLength    => 1,
300         CD_documentLength       => 2,
301         CD_meanHarmonic         => 4,
302         CD_uniqueWords          => 8,
303         CD_logUniqueWords       => 16,
304         CD_selfPlusOne          => 32
305     };
306
307     $self->add_search_modifier( $_ ) for (keys %{ $self->custom_data->{rank_cd_weight_map} });
308
309     $self->initialize_search_field_id_map( $args{config_metabib_field} )
310         if ($args{config_metabib_field});
311
312     $self->initialize_aliases( $args{config_metabib_search_alias} )
313         if ($args{config_metabib_search_alias});
314
315     $self->initialize_relevance_bumps( $args{search_relevance_adjustment} )
316         if ($args{search_relevance_adjustment});
317
318     $self->initialize_query_normalizers( $args{config_metabib_field_index_norm_map} )
319         if ($args{config_metabib_field_index_norm_map});
320
321     $self->initialize_dynamic_filters( $args{config_record_attr_definition} )
322         if ($args{config_record_attr_definition});
323
324     $self->initialize_filter_normalizers( $args{config_record_attr_index_norm_map} )
325         if ($args{config_record_attr_index_norm_map});
326
327     $_complete = 1 if (
328         $args{config_metabib_field_index_norm_map} &&
329         $args{search_relevance_adjustment} &&
330         $args{config_metabib_search_alias} &&
331         $args{config_metabib_field} &&
332         $args{config_record_attr_definition}
333     );
334
335     return $_complete;
336 }
337
338 sub TEST_SETUP {
339     
340     __PACKAGE__->add_search_field_id_map( series => seriestitle => 1 => 1 );
341
342     __PACKAGE__->add_search_field_id_map( series => seriestitle => 1 => 1 );
343     __PACKAGE__->add_relevance_bump( series => seriestitle => first_word => 1.5 );
344     __PACKAGE__->add_relevance_bump( series => seriestitle => full_match => 20 );
345     
346     __PACKAGE__->add_search_field_id_map( title => abbreviated => 2 => 1 );
347     __PACKAGE__->add_relevance_bump( title => abbreviated => first_word => 1.5 );
348     __PACKAGE__->add_relevance_bump( title => abbreviated => full_match => 20 );
349     
350     __PACKAGE__->add_search_field_id_map( title => translated => 3 => 1 );
351     __PACKAGE__->add_relevance_bump( title => translated => first_word => 1.5 );
352     __PACKAGE__->add_relevance_bump( title => translated => full_match => 20 );
353     
354     __PACKAGE__->add_search_field_id_map( title => proper => 6 => 1 );
355     __PACKAGE__->add_query_normalizer( title => proper => 'naco_normalize' );
356     __PACKAGE__->add_relevance_bump( title => proper => first_word => 1.5 );
357     __PACKAGE__->add_relevance_bump( title => proper => full_match => 20 );
358     __PACKAGE__->add_relevance_bump( title => proper => word_order => 10 );
359     
360     __PACKAGE__->add_search_field_id_map( author => coporate => 7 => 1 );
361     __PACKAGE__->add_relevance_bump( author => coporate => first_word => 1.5 );
362     __PACKAGE__->add_relevance_bump( author => coporate => full_match => 20 );
363     
364     __PACKAGE__->add_facet_field_id_map( author => personal => 8 => 1 );
365
366     __PACKAGE__->add_search_field_id_map( author => personal => 8 => 1 );
367     __PACKAGE__->add_relevance_bump( author => personal => first_word => 1.5 );
368     __PACKAGE__->add_relevance_bump( author => personal => full_match => 20 );
369     __PACKAGE__->add_query_normalizer( author => personal => 'naco_normalize' );
370     __PACKAGE__->add_query_normalizer( author => personal => 'split_date_range' );
371     
372     __PACKAGE__->add_facet_field_id_map( subject => topic => 14 => 1 );
373
374     __PACKAGE__->add_search_field_id_map( subject => topic => 14 => 1 );
375     __PACKAGE__->add_relevance_bump( subject => topic => first_word => 1 );
376     __PACKAGE__->add_relevance_bump( subject => topic => full_match => 1 );
377     
378     __PACKAGE__->add_search_field_id_map( subject => complete => 16 => 1 );
379     __PACKAGE__->add_relevance_bump( subject => complete => first_word => 1 );
380     __PACKAGE__->add_relevance_bump( subject => complete => full_match => 1 );
381     
382     __PACKAGE__->add_search_field_id_map( keyword => keyword => 15 => 1 );
383     __PACKAGE__->add_relevance_bump( keyword => keyword => first_word => 1 );
384     __PACKAGE__->add_relevance_bump( keyword => keyword => full_match => 1 );
385     
386     
387     __PACKAGE__->add_search_class_alias( keyword => 'kw' );
388     __PACKAGE__->add_search_class_alias( title => 'ti' );
389     __PACKAGE__->add_search_class_alias( author => 'au' );
390     __PACKAGE__->add_search_class_alias( author => 'name' );
391     __PACKAGE__->add_search_class_alias( author => 'dc.contributor' );
392     __PACKAGE__->add_search_class_alias( subject => 'su' );
393     __PACKAGE__->add_search_class_alias( subject => 'bib.subject(?:Title|Place|Occupation)' );
394     __PACKAGE__->add_search_class_alias( series => 'se' );
395     __PACKAGE__->add_search_class_alias( keyword => 'dc.identifier' );
396     
397     __PACKAGE__->add_query_normalizer( author => corporate => 'naco_normalize' );
398     __PACKAGE__->add_query_normalizer( keyword => keyword => 'naco_normalize' );
399     
400     __PACKAGE__->add_search_field_alias( subject => name => 'bib.subjectName' );
401     
402 }
403
404 __PACKAGE__->default_search_class( 'keyword' );
405
406 # will be retained simply for back-compat
407 __PACKAGE__->add_search_filter( 'format' );
408
409 # grumble grumble, special cases against date1 and date2
410 __PACKAGE__->add_search_filter( 'before' );
411 __PACKAGE__->add_search_filter( 'after' );
412 __PACKAGE__->add_search_filter( 'between' );
413 __PACKAGE__->add_search_filter( 'during' );
414
415 # used by layers above this
416 __PACKAGE__->add_search_filter( 'statuses' );
417 __PACKAGE__->add_search_filter( 'locations' );
418 __PACKAGE__->add_search_filter( 'site' );
419 __PACKAGE__->add_search_filter( 'lasso' );
420 __PACKAGE__->add_search_filter( 'my_lasso' );
421 __PACKAGE__->add_search_filter( 'depth' );
422 __PACKAGE__->add_search_filter( 'language' );
423 __PACKAGE__->add_search_filter( 'offset' );
424 __PACKAGE__->add_search_filter( 'limit' );
425 __PACKAGE__->add_search_filter( 'check_limit' );
426 __PACKAGE__->add_search_filter( 'skip_check' );
427 __PACKAGE__->add_search_filter( 'superpage' );
428 __PACKAGE__->add_search_filter( 'superpage_size' );
429 __PACKAGE__->add_search_filter( 'estimation_strategy' );
430 __PACKAGE__->add_search_modifier( 'available' );
431 __PACKAGE__->add_search_modifier( 'staff' );
432
433 # used internally, but generally not user-settable
434 __PACKAGE__->add_search_filter( 'preferred_language' );
435 __PACKAGE__->add_search_filter( 'preferred_language_weight' );
436 __PACKAGE__->add_search_filter( 'preferred_language_multiplier' );
437 __PACKAGE__->add_search_filter( 'core_limit' );
438
439 # XXX Valid values to be supplied by SVF
440 __PACKAGE__->add_search_filter( 'sort' );
441
442 # modifies core query, not configurable
443 __PACKAGE__->add_search_modifier( 'descending' );
444 __PACKAGE__->add_search_modifier( 'ascending' );
445 __PACKAGE__->add_search_modifier( 'metarecord' );
446 __PACKAGE__->add_search_modifier( 'metabib' );
447
448
449 #-------------------------------
450 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan;
451 use base 'QueryParser::query_plan';
452 use OpenSRF::Utils::Logger qw($logger);
453 use Data::Dumper;
454
455 sub toSQL {
456     my $self = shift;
457
458     my %filters;
459     my ($format) = $self->find_filter('format');
460     if ($format) {
461         my ($t,$f) = split('-', $format->args->[0]);
462         $self->new_filter( item_type => [ split '', $t ] ) if ($t);
463         $self->new_filter( item_form => [ split '', $f ] ) if ($f);
464     }
465
466     for my $f ( qw/preferred_language preferred_language_multiplier preferred_language_weight core_limit check_limit skip_check superpage superpage_size/ ) {
467         my $col = $f;
468         $col = 'preferred_language_multiplier' if ($f eq 'preferred_language_weight');
469         my ($filter) = $self->find_filter($f);
470         if ($filter and @{$filter->args}) {
471             $filters{$col} = $filter->args->[0];
472         }
473     }
474
475     $self->QueryParser->superpage($filters{superpage}) if ($filters{superpage});
476     $self->QueryParser->superpage_size($filters{superpage_size}) if ($filters{superpage_size});
477     $self->QueryParser->core_limit($filters{core_limit}) if ($filters{core_limit});
478
479     $logger->debug("Query plan:\n".Dumper($self));
480
481     my $flat_plan = $self->flatten;
482
483     # generate the relevance ranking
484     my $rel = "AVG(\n\t\t(" . join(")+\n\t\t(", @{$$flat_plan{rank_list}}) . ")\n\t)";
485
486     # find any supplied sort option
487     my ($sort_filter) = $self->find_filter('sort');
488     if ($sort_filter) {
489         $sort_filter = $sort_filter->args->[0];
490     } else {
491         $sort_filter = 'rel';
492     }
493
494     if (($filters{preferred_language} || $self->QueryParser->default_preferred_language) && ($filters{preferred_language_multiplier} || $self->QueryParser->default_preferred_language_multiplier)) {
495         my $pl = $self->QueryParser->quote_value( $filters{preferred_language} ? $filters{preferred_language} : $self->QueryParser->default_preferred_language );
496         my $plw = $filters{preferred_language_multiplier} ? $filters{preferred_language_multiplier} : $self->QueryParser->default_preferred_language_multiplier;
497         $rel = "($rel * COALESCE( NULLIF( FIRST(mrd.attrs \@> hstore('item_lang', $pl)), FALSE )::INT * $plw, 1))";
498     }
499     $rel = "1.0/($rel)::NUMERIC";
500
501     my %dyn_filters = ( '' => [] ); # the "catch-all" key
502     for my $f ( @{ $self->QueryParser->dynamic_filters } ) {
503         my $col = $f;
504         $col = 'item_lang' if ($f eq 'language'); #XXX filter aliases would address this ... booo ... later
505
506         my ($filter) = $self->find_filter($f);
507         if ($filter) {
508             my @fargs = @{$filter->args};
509
510             if (@fargs > 1) {
511                 $dyn_filters{$f} = "( " .
512                     join(
513                         " OR ",
514                         map { "mrd.attrs \@> hstore('$col', " . $self->QueryParser->quote_value($_) . ")" } @fargs
515                     ) . 
516                     " )";
517             } else {
518                 push(@{$dyn_filters{''}}, "hstore('$col', " . $self->QueryParser->quote_value($fargs[0]) . ")");
519             }
520         }
521     }
522
523     my $combined_dyn_filters = '';
524     $combined_dyn_filters .= 'AND mrd.attrs @> (' . join(' || ', @{$dyn_filters{''}}) . ') ' if (@{$dyn_filters{''}});
525     delete($dyn_filters{''});
526
527     my @dyn_filter_list = values(%dyn_filters);
528     $combined_dyn_filters .= 'AND ' . join(' AND ', @dyn_filter_list) if (@dyn_filter_list);
529     
530     my $rank = $rel;
531
532     my $desc = 'ASC';
533     $desc = 'DESC' if ($self->find_modifier('descending'));
534
535     if (grep {$_ eq $sort_filter} @{$self->QueryParser->dynamic_sorters}) {
536         $rank = "FIRST(mrd.attrs->'$sort_filter')"
537     } elsif ($sort_filter eq 'create_date') {
538         $rank = "FIRST((SELECT create_date FROM biblio.record_entry rbr WHERE rbr.id = m.source))";
539     } elsif ($sort_filter eq 'edit_date') {
540         $rank = "FIRST((SELECT edit_date FROM biblio.record_entry rbr WHERE rbr.id = m.source))";
541     } else {
542         # default to rel ranking
543         $rank = $rel;
544     }
545
546     my $key = 'm.source';
547     $key = 'm.metarecord' if (grep {$_->name eq 'metarecord' or $_->name eq 'metabib'} @{$self->modifiers});
548
549     my ($before) = $self->find_filter('before');
550     my ($after) = $self->find_filter('after');
551     my ($during) = $self->find_filter('during');
552     my ($between) = $self->find_filter('between');
553
554     if ($before and @{$before->args} == 1) {
555         $before = "AND (mrd.attrs->'date1') <= " . $self->QueryParser->quote_value($before->args->[0]);
556     } else {
557         $before = '';
558     }
559
560     if ($after and @{$after->args} == 1) {
561         $after = "AND (mrd.attrs->'date1') >= " . $self->QueryParser->quote_value($after->args->[0]);
562     } else {
563         $after = '';
564     }
565
566     if ($during and @{$during->args} == 1) {
567         $during = "AND " . $self->QueryParser->quote_value($during->args->[0]) . " BETWEEN (mrd.attrs->'date1') AND (mrd.attrs->'date2')";
568     } else {
569         $during = '';
570     }
571
572     if ($between and @{$between->args} == 2) {
573         $between = "AND (mrd.attrs->'date1') BETWEEN " . $self->QueryParser->quote_value($between->args->[0]) . " AND " . $self->QueryParser->quote_value($between->args->[1]);
574     } else {
575         $between = '';
576     }
577
578     my $core_limit = $self->QueryParser->core_limit || 25000;
579
580     my $sql = <<SQL;
581 SELECT  $key AS id,
582         ARRAY_ACCUM(DISTINCT m.source) AS records,
583         $rel AS rel,
584         $rank AS rank, 
585         FIRST(mrd.attrs->'date1') AS tie_break
586   FROM  metabib.metarecord_source_map m
587         JOIN metabib.record_attr mrd ON (m.source = mrd.id)
588         $$flat_plan{from}
589   WHERE 1=1
590         $before
591         $after
592         $during
593         $between
594         $combined_dyn_filters
595         AND $$flat_plan{where}
596   GROUP BY 1
597   ORDER BY 4 $desc NULLS LAST, 5 DESC NULLS LAST, 3 DESC
598   LIMIT $core_limit
599 SQL
600
601     warn $sql if $self->QueryParser->debug;
602     return $sql;
603
604 }
605
606
607 sub rel_bump {
608     my $self = shift;
609     my $node = shift;
610     my $bump = shift;
611     my $multiplier = shift;
612
613     my $only_atoms = $node->only_atoms;
614     return '' if (!@$only_atoms);
615
616     if ($bump eq 'first_word') {
617         return " /* first_word */ COALESCE(NULLIF( (naco_normalize(".$node->table_alias.".value) ~ ('^'||naco_normalize(".$self->QueryParser->quote_value($only_atoms->[0]->content)."))), FALSE )::INT * $multiplier, 1)";
618     } elsif ($bump eq 'full_match') {
619         return " /* full_match */ COALESCE(NULLIF( (naco_normalize(".$node->table_alias.".value) ~ ('^'||".
620                     join( "||' '||", map { "naco_normalize(".$self->QueryParser->quote_value($_->content).")" } @$only_atoms )."||'\$')), FALSE )::INT * $multiplier, 1)";
621     } elsif ($bump eq 'word_order') {
622         return " /* word_order */ COALESCE(NULLIF( (naco_normalize(".$node->table_alias.".value) ~ (".
623                     join( "||'.*'||", map { "naco_normalize(".$self->QueryParser->quote_value($_->content).")" } @$only_atoms ).")), FALSE )::INT * $multiplier, 1)";
624     }
625
626     return '';
627 }
628
629 sub flatten {
630     my $self = shift;
631
632     my $from = shift || '';
633     my $where = shift || '(';
634
635     my @rank_list;
636     for my $node ( @{$self->query_nodes} ) {
637         if (ref($node)) {
638             if ($node->isa( 'QueryParser::query_plan::node' )) {
639
640                 unless (@{$node->only_atoms}) {
641                     push @rank_list, '1';
642                     $where .= 'TRUE';
643                     next;
644                 }
645
646                 my $table = $node->table;
647                 my $talias = $node->table_alias;
648
649                 my $node_rank = $node->rank . " * ${talias}.weight";
650
651                 my $core_limit = $self->QueryParser->core_limit || 25000;
652                 $from .= "\n\tLEFT JOIN (\n\t\tSELECT fe.*, fe_weight.weight, x.tsq /* search */\n\t\t  FROM  $table AS fe";
653                 $from .= "\n\t\t\tJOIN config.metabib_field AS fe_weight ON (fe_weight.id = fe.field)";
654                 $from .= "\n\t\t\tJOIN (SELECT ".$node->tsquery ." AS tsq ) AS x ON (fe.index_vector @@ x.tsq)";
655
656                 my @bump_fields;
657                 if (@{$node->fields} > 0) {
658                     @bump_fields = @{$node->fields};
659
660                     my @field_ids;
661                     push(@field_ids, $self->QueryParser->search_field_ids_by_class( $node->classname, $_ )->[0]) for (@bump_fields);
662                     $from .= "\n\t\t\tWHERE fe_weight.id IN  (". join(',', @field_ids) .")";
663
664                 } else {
665                     @bump_fields = @{$self->QueryParser->search_fields->{$node->classname}};
666                 }
667
668                 ###$from .= "\n\t\tLIMIT $core_limit";
669                 $from .= "\n\t) AS $talias ON (m.source = ${talias}.source)";
670
671
672                 my %used_bumps;
673                 for my $field ( @bump_fields ) {
674                     my $bumps = $self->QueryParser->find_relevance_bumps( $node->classname => $field );
675                     for my $b (keys %$bumps) {
676                         next if (!$$bumps{$b}{active});
677                         next if ($used_bumps{$b});
678                         $used_bumps{$b} = 1;
679
680                         next if ($$bumps{$b}{multiplier} == 1); # optimization to remove unneeded bumps
681
682                         my $bump_case = $self->rel_bump( $node, $b, $$bumps{$b}{multiplier} );
683                         $node_rank .= "\n\t\t\t\t * " . $bump_case if ($bump_case);
684                     }
685                 }
686
687                 $where .= '(' . $talias . ".id IS NOT NULL";
688                 $where .= ' AND ' . join(' AND ', map {"${talias}.value ~* ".$self->QueryParser->quote_phrase_value($_)} @{$node->phrases}) if (@{$node->phrases});
689                 $where .= ')';
690
691                 push @rank_list, $node_rank;
692
693             } elsif ($node->isa( 'QueryParser::query_plan::facet' )) {
694
695                 my $table = $node->table;
696                 my $talias = $node->table_alias;
697
698                 my @field_ids;
699                 if (@{$node->fields} > 0) {
700                     push(@field_ids, $self->QueryParser->facet_field_ids_by_class( $node->classname, $_ )->[0]) for (@{$node->fields});
701                 } else {
702                     @field_ids = @{ $self->QueryParser->facet_field_ids_by_class( $node->classname ) };
703                 }
704
705                 $from .= "\n\tJOIN /* facet */ metabib.facet_entry $talias ON (\n\t\tm.source = ${talias}.source\n\t\t".
706                          "AND SUBSTRING(${talias}.value,1,1024) IN (" . join(",", map { $self->QueryParser->quote_value($_) } @{$node->values}) . ")\n\t\t".
707                          "AND ${talias}.field IN (". join(',', @field_ids) . ")\n\t)";
708
709                 $where .= 'TRUE';
710
711             } else {
712                 my $subnode = $node->flatten;
713
714                 push(@rank_list, @{$$subnode{rank_list}});
715                 $from .= $$subnode{from};
716                 $where .= "($$subnode{where})";
717             }
718         } else {
719             $where .= ' AND ' if ($node eq '&');
720             $where .= ' OR ' if ($node eq '|');
721             # ... stitching the WHERE together ...
722         }
723     }
724
725     return { rank_list => \@rank_list, from => $from, where => $where.')' };
726
727 }
728
729
730 #-------------------------------
731 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::filter;
732 use base 'QueryParser::query_plan::filter';
733
734 #-------------------------------
735 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::facet;
736 use base 'QueryParser::query_plan::facet';
737
738 sub classname {
739     my $self = shift;
740     my ($classname) = split '\|', $self->name;
741     return $classname;
742 }
743
744 sub table {
745     my $self = shift;
746     return 'metabib.' . $self->classname . '_field_entry';
747 }
748
749 sub fields {
750     my $self = shift;
751     my ($classname,@fields) = split '\|', $self->name;
752     return \@fields;
753 }
754
755 sub table_alias {
756     my $self = shift;
757
758     my $table_alias = "$self";
759     $table_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
760     $table_alias .= '_' . $self->name;
761     $table_alias =~ s/\|/_/go;
762
763     return $table_alias;
764 }
765
766
767 #-------------------------------
768 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::modifier;
769 use base 'QueryParser::query_plan::modifier';
770
771 #-------------------------------
772 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::node::atom;
773 use base 'QueryParser::query_plan::node::atom';
774
775 sub sql {
776     my $self = shift;
777     my $sql = shift;
778
779     $self->{sql} = $sql if ($sql);
780     
781     return $self->{sql} if ($self->{sql});
782     return $self->buildSQL;
783 }
784
785 sub buildSQL {
786     my $self = shift;
787
788     my $classname = $self->node->classname;
789
790     my $normalizers = $self->node->plan->QueryParser->query_normalizers( $classname );
791     my $fields = $self->node->fields;
792
793     $fields = $self->node->plan->QueryParser->search_fields->{$classname} if (!@$fields);
794
795     my %norms;
796     my $pos = 0;
797     for my $field (@$fields) {
798         for my $nfield (keys %$normalizers) {
799             for my $nizer ( @{$$normalizers{$nfield}} ) {
800                 if ($field eq $nfield) {
801                     if (!exists($norms{$nizer->{function}})) {
802                         $norms{$nizer->{function}} = {p=>$pos++,n=>$nizer};
803                     }
804                 }
805             }
806         }
807     }
808
809     my $sql = $self->node->plan->QueryParser->quote_value($self->content);
810
811     for my $n ( map { $$_{n} } sort { $$a{p} <=> $$b{p} } values %norms ) {
812         $sql = join(', ', $sql, map { $self->node->plan->QueryParser->quote_value($_) } @{ $n->{params} });
813         $sql = $n->{function}."($sql)";
814     }
815
816     my $prefix = $self->prefix || '';
817     my $suffix = $self->suffix || '';
818
819     $prefix = "'$prefix' ||" if $prefix;
820     my $suffix_op = ":$suffix" if $suffix;
821     my $suffix_after = "|| '$suffix_op'" if $suffix;
822
823     $sql = "to_tsquery('$classname', COALESCE(NULLIF($prefix '(' || btrim(regexp_replace($sql,E'(?:\\\\s+|:)','$suffix_op&','g'),'&|') $suffix_after || ')', '()'), ''))";
824
825     return $self->sql($sql);
826 }
827
828 #-------------------------------
829 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::node;
830 use base 'QueryParser::query_plan::node';
831
832 sub only_atoms {
833     my $self = shift;
834
835     my $atoms = $self->query_atoms;
836     my @only_atoms;
837     for my $a (@$atoms) {
838         push(@only_atoms, $a) if (ref($a) && $a->isa('QueryParser::query_plan::node::atom'));
839     }
840
841     return \@only_atoms;
842 }
843
844 sub table {
845     my $self = shift;
846     my $table = shift;
847     $self->{table} = $table if ($table);
848     return $self->{table} if $self->{table};
849     return $self->table( 'metabib.' . $self->classname . '_field_entry' );
850 }
851
852 sub table_alias {
853     my $self = shift;
854     my $table_alias = shift;
855     $self->{table_alias} = $table_alias if ($table_alias);
856     return $self->{table_alias} if ($self->{table_alias});
857
858     $table_alias = "$self";
859     $table_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
860     $table_alias .= '_' . $self->requested_class;
861     $table_alias =~ s/\|/_/go;
862
863     return $self->table_alias( $table_alias );
864 }
865
866 sub tsquery {
867     my $self = shift;
868     return $self->{tsquery} if ($self->{tsquery});
869
870     for my $atom (@{$self->query_atoms}) {
871         if (ref($atom)) {
872             $self->{tsquery} .= "\n\t\t\t" .$atom->sql;
873         } else {
874             $self->{tsquery} .= $atom x 2;
875         }
876     }
877
878     return $self->{tsquery};
879 }
880
881 sub rank {
882     my $self = shift;
883
884     my $rank_norm_map = $self->plan->QueryParser->custom_data->{rank_cd_weight_map};
885     
886     my $cover_density = 0;
887     for my $norm ( keys %$rank_norm_map) {
888         $cover_density += $$rank_norm_map{$norm} if ($self->plan->find_modifier($norm));
889     }
890
891     return $self->{rank} if ($self->{rank});
892     return $self->{rank} = 'rank_cd(' . $self->table_alias . '.index_vector, ' . $self->table_alias . ".tsq, $cover_density)";
893 }
894
895
896 1;
897