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