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