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