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