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