Open-ILS/src/perlmods/lib/OpenILS/Application/Storage/Driver/Pg/QueryParser.pm

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