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

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