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( 'lucky' );
 664
 665 # Start from container data (bre, acn, acp): container(bre,bookbag,123,deadb33fdeadb33fdeadb33fdeadb33f)
 666 __PACKAGE__->add_search_filter( 'container' );
 667
 668 # Start from a list of record ids, either bre or metarecords, depending on the #metabib modifier
 669 __PACKAGE__->add_search_filter( 'record_list' );
 670
 671 # used internally, but generally not user-settable
 672 __PACKAGE__->add_search_filter( 'preferred_language' );
 673 __PACKAGE__->add_search_filter( 'preferred_language_weight' );
 674 __PACKAGE__->add_search_filter( 'preferred_language_multiplier' );
 675 __PACKAGE__->add_search_filter( 'core_limit' );
 676
 677 # XXX Valid values to be supplied by SVF
 678 __PACKAGE__->add_search_filter( 'sort' );
 679
 680 # modifies core query, not configurable
 681 __PACKAGE__->add_search_modifier( 'descending' );
 682 __PACKAGE__->add_search_modifier( 'ascending' );
 683 __PACKAGE__->add_search_modifier( 'nullsfirst' );
 684 __PACKAGE__->add_search_modifier( 'nullslast' );
 685 __PACKAGE__->add_search_modifier( 'metarecord' );
 686 __PACKAGE__->add_search_modifier( 'metabib' );
 687
 688
 689 #-------------------------------
 690 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan;
 691 use base 'QueryParser::query_plan';
 692 use OpenSRF::Utils::Logger qw($logger);
 693 use OpenSRF::Utils qw/:datetime/;
 694 use Data::Dumper;
 695 use OpenILS::Application::AppUtils;
 696 use OpenILS::Utils::CStoreEditor;
 697 my $apputils = "OpenILS::Application::AppUtils";
 698 my $editor = OpenILS::Utils::CStoreEditor->new;
 699
 700 sub toSQL {
 701     my $self = shift;
 702
 703     my %filters;
 704
 705     for my $f ( qw/preferred_language preferred_language_multiplier preferred_language_weight core_limit check_limit skip_check superpage superpage_size/ ) {
 706         my $col = $f;
 707         $col = 'preferred_language_multiplier' if ($f eq 'preferred_language_weight');
 708         my ($filter) = $self->find_filter($f);
 709         if ($filter and @{$filter->args}) {
 710             $filters{$col} = $filter->args->[0];
 711         }
 712     }
 713     $self->new_filter( statuses => [0,7,12] ) if ($self->find_modifier('available'));
 714
 715     $self->QueryParser->superpage($filters{superpage}) if ($filters{superpage});
 716     $self->QueryParser->superpage_size($filters{superpage_size}) if ($filters{superpage_size});
 717     $self->QueryParser->core_limit($filters{core_limit}) if ($filters{core_limit});
 718
 719     $logger->debug("Query plan:\n".Dumper($self));
 720
 721     my $flat_plan = $self->flatten;
 722
 723     # generate the relevance ranking
 724     my $rel = '1'; # Default to something simple in case rank_list is empty.
 725     if (@{$$flat_plan{rank_list}}) {
 726         $rel = "AVG(\n"
 727              . ${spc} x 5 ."("
 728              . join(")\n" . ${spc} x 5 . "+ (", @{$$flat_plan{rank_list}})
 729              . ")\n"
 730              . ${spc} x 4 . ")+1";
 731     }
 732
 733     # find any supplied sort option
 734     my ($sort_filter) = $self->find_filter('sort');
 735     if ($sort_filter) {
 736         $sort_filter = $sort_filter->args->[0];
 737     } else {
 738         $sort_filter = 'rel';
 739     }
 740
 741     if (($filters{preferred_language} || $self->QueryParser->default_preferred_language) && ($filters{preferred_language_multiplier} || $self->QueryParser->default_preferred_language_multiplier)) {
 742         my $pl = $self->QueryParser->quote_value( $filters{preferred_language} ? $filters{preferred_language} : $self->QueryParser->default_preferred_language );
 743         my $plw = $filters{preferred_language_multiplier} ? $filters{preferred_language_multiplier} : $self->QueryParser->default_preferred_language_multiplier;
 744         $rel = "($rel * COALESCE( NULLIF( FIRST(mrd.attrs \@> hstore('item_lang', $pl)), FALSE )::INT * $plw, 1))";
 745     }
 746     $rel = "1.0/($rel)::NUMERIC";
 747
 748     my $rank = $rel;
 749
 750     my $desc = 'ASC';
 751     $desc = 'DESC' if ($self->find_modifier('descending'));
 752
 753     my $nullpos = 'NULLS LAST';
 754     $nullpos = 'NULLS FIRST' if ($self->find_modifier('nullsfirst'));
 755
 756     if (grep {$_ eq $sort_filter} @{$self->QueryParser->dynamic_sorters}) {
 757         $rank = "FIRST(mrd.attrs->'$sort_filter')"
 758     } elsif ($sort_filter eq 'create_date') {
 759         $rank = "FIRST((SELECT create_date FROM biblio.record_entry rbr WHERE rbr.id = m.source))";
 760     } elsif ($sort_filter eq 'edit_date') {
 761         $rank = "FIRST((SELECT edit_date FROM biblio.record_entry rbr WHERE rbr.id = m.source))";
 762     } else {
 763         # default to rel ranking
 764         $rank = $rel;
 765     }
 766
 767     my $key = 'm.source';
 768     $key = 'm.metarecord' if (grep {$_->name eq 'metarecord' or $_->name eq 'metabib'} @{$self->modifiers});
 769
 770     my $core_limit = $self->QueryParser->core_limit || 25000;
 771     $core_limit = 1 if($self->find_modifier('lucky'));
 772
 773     my $flat_where = $$flat_plan{where};
 774     if ($flat_where ne '') {
 775         $flat_where = "AND (\n" . ${spc} x 5 . $flat_where . "\n" . ${spc} x 4 . ")";
 776     }
 777
 778     my $site = $self->find_filter('site');
 779     if ($site && $site->args) {
 780         $site = $site->args->[0];
 781         if ($site && $site !~ /^(-)?\d+$/) {
 782             my $search = $editor->search_actor_org_unit({ shortname => $site });
 783             $site = @$search[0]->id if($search && @$search);
 784             $site = undef unless ($search);
 785         }
 786     } else {
 787         $site = undef;
 788     }
 789     my $lasso = $self->find_filter('lasso');
 790     if ($lasso && $lasso->args) {
 791         $lasso = $lasso->args->[0];
 792         if ($lasso && $lasso !~ /^\d+$/) {
 793             my $search = $editor->search_actor_org_lasso({ name => $lasso });
 794             $lasso = @$search[0]->id if($search && @$search);
 795             $lasso = undef unless ($search);
 796         }
 797     } else {
 798         $lasso = undef;
 799     }
 800     my $depth = $self->find_filter('depth');
 801     if ($depth && $depth->args) {
 802         $depth = $depth->args->[0];
 803         if ($depth && $depth !~ /^\d+$/) {
 804             # This *is* what metabib.pm has been doing....but it makes no sense to me. :/
 805             # Should this be looking up the depth of the OU type on the OU in question?
 806             my $search = $editor->search_actor_org_unit([{ name => $depth },{ opac_label => $depth }]);
 807             $depth = @$search[0]->id if($search && @$search);
 808             $depth = undef unless($search);
 809         }
 810     } else {
 811         $depth = undef;
 812     }
 813     my $pref_ou = $self->find_filter('pref_ou');
 814     if ($pref_ou && $pref_ou->args) {
 815         $pref_ou = $pref_ou->args->[0];
 816         if ($pref_ou && $pref_ou !~ /^(-)?\d+$/) {
 817             my $search = $editor->search_actor_org_unit({ shortname => $pref_ou });
 818             $pref_ou = @$search[0]->id if($search && @$search);
 819             $pref_ou = undef unless ($search);
 820         }
 821     } else {
 822         $pref_ou = undef;
 823     }
 824
 825     # Supposedly at some point a site of 0 and a depth will equal user lasso id.
 826     # We need OU buckets before that happens. 'my_lasso' is, I believe, the target filter for it.
 827
 828     $site = -$lasso if ($lasso);
 829
 830     # Default to the top of the org tree if we have nothing else. This would need tweaking for the user lasso bit.
 831     if (!$site) {
 832         my $search = $editor->search_actor_org_unit({ parent_ou => undef });
 833         $site = @$search[0]->id if ($search);
 834     }
 835
 836     my $depth_check = '';
 837     $depth_check = ", $depth" if ($depth);
 838
 839     my $with = '';
 840     $with .= "     search_org_list AS (\n";
 841     if ($site < 0) {
 842         # Lasso!
 843         $lasso = -$site;
 844         $with .= "       SELECT DISTINCT org_unit from actor.org_lasso_map WHERE lasso = $lasso\n";
 845     } elsif ($site > 0) {
 846         $with .= "       SELECT DISTINCT id FROM actor.org_unit_descendants($site$depth_check)\n";
 847     } else {
 848         # Placeholder for user lasso stuff.
 849     }
 850     $with .= "     ),\n";
 851     $with .= "     luri_org_list AS (\n";
 852     if ($site < 0) {
 853         # We can re-use the lasso var, we already updated it above.
 854         $with .= "       SELECT DISTINCT (actor.org_unit_ancestors(org_unit)).id from actor.org_lasso_map WHERE lasso = $lasso\n";
 855     } elsif ($site > 0) {
 856         $with .= "       SELECT DISTINCT id FROM actor.org_unit_ancestors($site)\n";
 857     } else {
 858         # Placeholder for user lasso stuff.
 859     }
 860     if ($pref_ou) {
 861         $with .= "       UNION\n";
 862         $with .= "       SELECT DISTINCT id FROM actor.org_unit_ancestors($pref_ou)\n";
 863     }
 864     $with .= "     )";
 865     $with .= ",\n     " . $$flat_plan{with} if ($$flat_plan{with});
 866
 867     # Limit stuff
 868     my $limit_where = <<"    SQL";
 869 -- Filter records based on visibility
 870         AND (
 871             cbs.transcendant IS TRUE
 872             OR
 873     SQL
 874     if ($self->find_modifier('staff')) {
 875         $limit_where .= <<"        SQL";
 876             EXISTS(
 877                 SELECT 1 FROM asset.call_number cn
 878                     JOIN asset.copy cp ON (cp.call_number = cn.id)
 879                 WHERE NOT cn.deleted
 880                     AND NOT cp.deleted
 881                     AND cp.circ_lib IN ( SELECT * FROM search_org_list )
 882                     AND cn.record = m.source
 883                 LIMIT 1
 884             )
 885             OR
 886             EXISTS(
 887                 SELECT 1 FROM biblio.peer_bib_copy_map pr
 888                     JOIN asset.copy cp ON (cp.id = pr.target_copy)
 889                 WHERE NOT cp.deleted
 890                     AND cp.circ_lib IN ( SELECT * FROM search_org_list )
 891                     AND pr.peer_record = m.source
 892                 LIMIT 1
 893             )
 894             OR (
 895                 NOT EXISTS(
 896                     SELECT 1 FROM asset.call_number cn
 897                         JOIN asset.copy cp ON (cp.call_number = cn.id)
 898                     WHERE cn.record = m.source
 899                         AND NOT cp.deleted
 900                     LIMIT 1
 901                 )
 902                 AND
 903                 NOT EXISTS(
 904                     SELECT 1 FROM biblio.peer_bib_copy_map pr
 905                         JOIN asset.copy cp ON (cp.id = pr.target_copy)
 906                     WHERE NOT cp.deleted
 907                         AND pr.peer_record = m.source
 908                     LIMIT 1
 909                 )
 910                 AND
 911                 NOT EXISTS(
 912                     SELECT 1 FROM asset.call_number acn
 913                         JOIN asset.uri_call_number_map aucnm ON acn.id = aucnm.call_number
 914                         JOIN asset.uri uri ON aucnm.uri = uri.id
 915                     WHERE NOT acn.deleted
 916                         AND uri.active
 917                         AND acn.record = m.source
 918                     LIMIT 1
 919                 )
 920             )
 921         SQL
 922     } else {
 923         $limit_where .= <<"        SQL";
 924             EXISTS(
 925                 SELECT 1 FROM asset.opac_visible_copies
 926                 WHERE circ_lib IN ( SELECT * FROM search_org_list )
 927                     AND record = m.source
 928                 LIMIT 1
 929             )
 930             OR
 931             EXISTS(
 932                 SELECT 1 FROM biblio.peer_bib_copy_map pr
 933                     JOIN asset.opac_visible_copies cp ON (cp.copy_id = pr.target_copy)
 934                 WHERE cp.circ_lib IN ( SELECT * FROM search_org_list )
 935                     AND pr.peer_record = m.source
 936                 LIMIT 1
 937             )
 938         SQL
 939     }
 940     $limit_where .= <<"    SQL";
 941             OR
 942             EXISTS(
 943                 SELECT 1 FROM asset.call_number acn
 944                     JOIN asset.uri_call_number_map aucnm ON acn.id = aucnm.call_number
 945                     JOIN asset.uri uri ON aucnm.uri = uri.id
 946                 WHERE NOT acn.deleted AND uri.active AND acn.record = m.source AND acn.owning_lib IN (
 947                     SELECT * FROM luri_org_list
 948                 )
 949                 LIMIT 1
 950             )
 951         )
 952     SQL
 953
 954     # For single records we want the record id
 955     # For metarecords we want NULL or the only record ID.
 956     my $agg_record = 'm.source AS record';
 957     if ($key =~ /metarecord/) {
 958         $agg_record = 'CASE WHEN COUNT(DISTINCT m.source) = 1 THEN FIRST(m.source) ELSE NULL END AS record';
 959     }
 960
 961     # bre.create_date and bre.edit_date filtering
 962     for my $datefilter ( qw/create_date edit_date/ ) {
 963         my $cdate = $self->find_filter($datefilter);
 964         if ($cdate && $cdate->args && scalar(@{$cdate->args}) > 0 && scalar(@{$cdate->args}) < 3) {
 965             my ($cstart, $cend) = @{$cdate->args};
 966
 967             if (!$cstart and !$cend) {
 968                 # useless use of filter
 969             } elsif (!$cstart or $cstart eq '-infinity') { # no start supplied
 970                 if ($cend eq 'infinity') {
 971                     # useless use of filter
 972                 } else {
 973                     # "before $cend"
 974                     $cend = cleanse_ISO8601($cend);
 975                     $limit_where .= <<"                    SQL";
 976             AND bre.$datefilter <= \$_$$\$$cend\$_$$\$
 977                     SQL
 978                 }
 979
 980             } elsif (!$cend or $cend eq 'infinity') { # no end supplied
 981                 if ($cstart eq '-infinity') {
 982                     # useless use of filter
 983                 } else { # "after $cstart"
 984                     $cstart = cleanse_ISO8601($cstart);
 985                     $limit_where .= <<"                    SQL";
 986             AND bre.$datefilter >= \$_$$\$$cstart\$_$$\$
 987                     SQL
 988                 }
 989             } else { # both supplied
 990                 # "between $cstart and $cend"
 991                 $cstart = cleanse_ISO8601($cstart);
 992                 $cend = cleanse_ISO8601($cend);
 993                 $limit_where .= <<"                SQL";
 994             AND bre.$datefilter BETWEEN \$_$$\$$cstart\$_$$\$ AND \$_$$\$$cend\$_$$\$
 995                 SQL
 996             }
 997         }
 998     }
 999
1000     my $sql = <<SQL;
1001 WITH
1002 $with
1003 SELECT  $key AS id,
1004         $agg_record,
1005         $rel AS rel,
1006         $rank AS rank,
1007         FIRST(mrd.attrs->'date1') AS tie_break
1008   FROM  metabib.metarecord_source_map m
1009         $$flat_plan{from}
1010         INNER JOIN metabib.record_attr mrd ON m.source = mrd.id
1011         INNER JOIN biblio.record_entry bre ON m.source = bre.id
1012         LEFT JOIN config.bib_source cbs ON bre.source = cbs.id
1013   WHERE 1=1
1014         $flat_where
1015         $limit_where
1016   GROUP BY 1
1017   ORDER BY 4 $desc $nullpos, 5 DESC $nullpos, 3 DESC
1018   LIMIT $core_limit
1019 SQL
1020
1021     warn $sql if $self->QueryParser->debug;
1022     return $sql;
1023
1024 }
1025
1026 sub flatten {
1027     my $self = shift;
1028
1029     my $from = shift || '';
1030     my $where = shift || '';
1031     my $with = '';
1032
1033     my @rank_list;
1034     for my $node ( @{$self->query_nodes} ) {
1035
1036         if (ref($node)) {
1037             if ($node->isa( 'QueryParser::query_plan::node' )) {
1038
1039                 unless (@{$node->only_atoms}) {
1040                     push @rank_list, '1';
1041                     $where .= 'TRUE';
1042                     next;
1043                 }
1044
1045                 my $table = $node->table;
1046                 my $ctable = $node->combined_table;
1047                 my $talias = $node->table_alias;
1048
1049                 my $node_rank = 'COALESCE(' . $node->rank . " * ${talias}.weight, 0.0)";
1050
1051                 $from .= "\n" . ${spc} x 4 ."LEFT JOIN (\n"
1052                       . ${spc} x 5 . "SELECT fe.*, fe_weight.weight, ${talias}_xq.tsq, ${talias}_xq.tsq_rank /* search */\n"
1053                       . ${spc} x 6 . "FROM  $table AS fe";
1054                 $from .= "\n" . ${spc} x 7 . "JOIN config.metabib_field AS fe_weight ON (fe_weight.id = fe.field)";
1055
1056                 my @bump_fields;
1057                 my @field_ids;
1058                 if (@{$node->fields} > 0) {
1059                     @bump_fields = @{$node->fields};
1060
1061                     @field_ids = grep defined, (
1062                         map {
1063                             $self->QueryParser->search_field_ids_by_class(
1064                                 $node->classname, $_
1065                             )->[0]
1066                         } @bump_fields
1067                     );
1068                 } else {
1069                     @bump_fields = @{$self->QueryParser->search_fields->{$node->classname}};
1070                 }
1071
1072                 if ($node->dummy_count < @{$node->only_atoms} ) {
1073                     $with .= ",\n     " if $with;
1074                     $with .= "${talias}_xq AS (SELECT ". $node->tsquery ." AS tsq,". $node->tsquery_rank ." AS tsq_rank )";
1075                     $from .= "\n" . ${spc} x 6 . "JOIN $ctable AS com ON (com.record = fe.source";
1076                     if (@field_ids) {
1077                         $from .= " AND com.metabib_field IN (" . join(',',@field_ids) . "))";
1078                     } else {
1079                         $from .= " AND com.metabib_field IS NULL)";
1080                     }
1081                     $from .= "\n" . ${spc} x 6 . "JOIN ${talias}_xq ON (com.index_vector @@ ${talias}_xq.tsq)";
1082                 } else {
1083                     $from .= "\n" . ${spc} x 6 . ", (SELECT NULL::tsquery AS tsq, NULL:tsquery AS tsq_rank ) AS ${talias}_xq";
1084                 }
1085
1086                 if (@field_ids) {
1087                     $from .= "\n" . ${spc} x 6 . "WHERE fe_weight.id IN  (" .
1088                         join(',', @field_ids) . ")";
1089                 }
1090
1091                 $from .= "\n" . ${spc} x 4 . ") AS $talias ON (m.source = ${talias}.source)";
1092
1093                 my %used_bumps;
1094                 my @bumps;
1095                 my @bumpmults;
1096                 for my $field ( @bump_fields ) {
1097                     my $bumps = $self->QueryParser->find_relevance_bumps( $node->classname => $field );
1098                     for my $b (keys %$bumps) {
1099                         next if (!$$bumps{$b}{active});
1100                         next if ($used_bumps{$b});
1101                         $used_bumps{$b} = 1;
1102
1103                         next if ($$bumps{$b}{multiplier} == 1); # optimization to remove unneeded bumps
1104                         push @bumps, $b;
1105                         push @bumpmults, $$bumps{$b}{multiplier};
1106                     }
1107                 }
1108
1109                 if(scalar @bumps > 0 && scalar @{$node->only_positive_atoms} > 0) {
1110                     # Note: Previous rank function used search_normalize outright. Duplicating that here.
1111                     $node_rank .= "\n" . ${spc} x 5 . "* evergreen.rel_bump(('{' || search_normalize(";
1112                     $node_rank .= join(") || ',' || search_normalize(",map { $self->QueryParser->quote_phrase_value($_->content) } @{$node->only_positive_atoms});
1113                     $node_rank .= ") || '}')::TEXT[], " . $node->table_alias . ".value, '{" . join(",",@bumps) . "}'::TEXT[], '{" . join(",",@bumpmults) . "}'::NUMERIC[])";
1114                 }
1115
1116                 my $NOT = '';
1117                 $NOT = 'NOT ' if $node->negate;
1118
1119                 $where .= "$NOT(" . $talias . ".id IS NOT NULL";
1120                 if (@{$node->phrases}) {
1121                     $where .= ' AND ' . join(' AND ', map {
1122                         "${talias}.value ~* ".$self->QueryParser->quote_phrase_value($_, 1)
1123                     } @{$node->phrases});
1124                 } else {
1125                     for my $atom (@{$node->only_real_atoms}) {
1126                         next unless $atom->{content} && $atom->{content} =~ /(^\^|\$$)/;
1127                         $where .= " AND ${talias}.value ~* ".$self->QueryParser->quote_phrase_value($atom->{content});
1128                     }
1129                 }
1130                 $where .= ')';
1131
1132                 push @rank_list, $node_rank;
1133
1134             } elsif ($node->isa( 'QueryParser::query_plan::facet' )) {
1135
1136                 my $talias = $node->table_alias;
1137
1138                 my @field_ids;
1139                 if (@{$node->fields} > 0) {
1140                     push(@field_ids, $self->QueryParser->facet_field_ids_by_class( $node->classname, $_ )->[0]) for (@{$node->fields});
1141                 } else {
1142                     @field_ids = @{ $self->QueryParser->facet_field_ids_by_class( $node->classname ) };
1143                 }
1144
1145                 my $join_type = ($node->negate or !$self->top_plan) ? 'LEFT' : 'INNER';
1146                 $from .= "\n${spc}$join_type JOIN /* facet */ metabib.facet_entry $talias ON (\n"
1147                       . ${spc} x 2 . "m.source = ${talias}.source\n"
1148                       . ${spc} x 2 . "AND SUBSTRING(${talias}.value,1,1024) IN ("
1149                       . join(",", map { $self->QueryParser->quote_value($_) } @{$node->values}) . ")\n"
1150                       . ${spc} x 2 ."AND ${talias}.field IN (". join(',', @field_ids) . ")\n"
1151                       . "${spc})";
1152
1153                 if ($join_type ne 'INNER') {
1154                     my $NOT = $node->negate ? '' : ' NOT';
1155                     $where .= "${talias}.id IS$NOT NULL";
1156                 } elsif ($where ne '') {
1157                     # Strip extra joiner
1158                     $where =~ s/(\s|\n)+(AND|OR)\s$//;
1159                 }
1160
1161             } else {
1162                 my $subnode = $node->flatten;
1163
1164                 # strip the trailing bool from the previous loop if there is
1165                 # nothing to add to the where within this loop.
1166                 if ($$subnode{where} eq '') {
1167                     $where =~ s/(\s|\n)+(AND|OR)\s$//;
1168                 }
1169
1170                 push(@rank_list, @{$$subnode{rank_list}});
1171                 $from .= $$subnode{from};
1172
1173                 my $NOT = '';
1174                 $NOT = 'NOT ' if $node->negate;
1175
1176                 if ($$subnode{where} ne '') {
1177                     $where .= "$NOT(\n"
1178                            . ${spc} x ($self->plan_level + 6) . $$subnode{where} . "\n"
1179                            . ${spc} x ($self->plan_level + 5) . ')';
1180                 }
1181
1182                 if ($$subnode{with}) {
1183                     $with .= ",\n     " if $with;
1184                     $with .= $$subnode{with};
1185                 }
1186             }
1187         } else {
1188
1189             warn "flatten(): appending WHERE bool to: $where\n" if $self->QueryParser->debug;
1190
1191             if ($where ne '') {
1192                 $where .= "\n" . ${spc} x ( $self->plan_level + 5 ) . 'AND ' if ($node eq '&');
1193                 $where .= "\n" . ${spc} x ( $self->plan_level + 5 ) . 'OR ' if ($node eq '|');
1194             }
1195         }
1196     }
1197
1198     my $joiner = "\n" . ${spc} x ( $self->plan_level + 5 ) . ($self->joiner eq '&' ? 'AND ' : 'OR ');
1199     # for each dynamic filter, build more of the WHERE clause
1200     for my $filter (@{$self->filters}) {
1201         my $NOT = $filter->negate ? 'NOT ' : '';
1202         if (grep { $_ eq $filter->name } @{ $self->QueryParser->dynamic_filters }) {
1203
1204             warn "flatten(): processing dynamic filter ". $filter->name ."\n"
1205                 if $self->QueryParser->debug;
1206
1207             # bool joiner for intra-plan nodes/filters
1208             $where .= $joiner if $where ne '';
1209
1210             my @fargs = @{$filter->args};
1211             my $fname = $filter->name;
1212             $fname = 'item_lang' if $fname eq 'language'; #XXX filter aliases
1213
1214             $where .= sprintf(
1215                 "${NOT}COALESCE((mrd.attrs->'%s') IN (%s), false)", $fname,
1216                 join(',', map { $self->QueryParser->quote_value($_) } @fargs)
1217             );
1218
1219             warn "flatten(): filter where => $where\n"
1220                 if $self->QueryParser->debug;
1221         } else {
1222             if ($filter->name eq 'before') {
1223                 if (@{$filter->args} == 1) {
1224                     $where .= $joiner if $where ne '';
1225                     $where .= "${NOT}COALESCE((mrd.attrs->'date1') <= "
1226                            . $self->QueryParser->quote_value($filter->args->[0])
1227                            . ", false)";
1228                 }
1229             } elsif ($filter->name eq 'after') {
1230                 if (@{$filter->args} == 1) {
1231                     $where .= $joiner if $where ne '';
1232                     $where .= "${NOT}COALESCE((mrd.attrs->'date1') >= "
1233                            . $self->QueryParser->quote_value($filter->args->[0])
1234                            . ", false)";
1235                 }
1236             } elsif ($filter->name eq 'during') {
1237                 if (@{$filter->args} == 1) {
1238                     $where .= $joiner if $where ne '';
1239                     $where .= "${NOT}COALESCE("
1240                            . $self->QueryParser->quote_value($filter->args->[0])
1241                            . " BETWEEN (mrd.attrs->'date1') AND (mrd.attrs->'date2'), false)";
1242                 }
1243             } elsif ($filter->name eq 'between') {
1244                 if (@{$filter->args} == 2) {
1245                     $where .= $joiner if $where ne '';
1246                     $where .= "${NOT}COALESCE((mrd.attrs->'date1') BETWEEN "
1247                            . $self->QueryParser->quote_value($filter->args->[0])
1248                            . " AND "
1249                            . $self->QueryParser->quote_value($filter->args->[1])
1250                            . ", false)";
1251                 }
1252             } elsif ($filter->name eq 'container') {
1253                 if (@{$filter->args} >= 3) {
1254                     my ($class, $ctype, $cid, $token) = @{$filter->args};
1255                     my $perm_join = '';
1256                     my $rec_join = '';
1257                     my $rec_field = 'ci.target_biblio_record_entry';
1258                     if ($class eq 'bre') {
1259                         $class = 'biblio_record_entry';
1260                     } elsif ($class eq 'acn') {
1261                         $class = 'call_number';
1262                         $rec_field = 'cn.record';
1263                         $rec_join = 'JOIN asset.call_number cn ON (ci.target_call_number = cn.id)';
1264                     } elsif ($class eq 'acp') {
1265                         $class = 'copy';
1266                         $rec_field = 'cn.record';
1267                         $rec_join = 'JOIN asset.copy cp ON (ci.target_copy = cp.id) JOIN asset.call_number cn ON (cp.call_number = cn.id)';
1268                     } else {
1269                         $class = undef;
1270                     }
1271
1272                     if ($class) {
1273                         my ($u,$e) = $apputils->checksesperm($token) if ($token);
1274                         $perm_join = ' OR c.owner = ' . $u->id if ($u && !$e);
1275
1276                         my $filter_alias = "$filter";
1277                         $filter_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
1278                         $filter_alias =~ s/\|/_/go;
1279
1280                         $with .= ",\n     " if $with;
1281                         $with .= "container_${filter_alias} AS (\n";
1282                         $with .= "       SELECT $rec_field AS record FROM container.${class}_bucket_item ci\n"
1283                                . "             JOIN container.${class}_bucket c ON (c.id = ci.bucket) $rec_join\n"
1284                                . "       WHERE c.btype = " . $self->QueryParser->quote_value($ctype) . "\n"
1285                                . "             AND c.id = " . $self->QueryParser->quote_value($cid) . "\n"
1286                                . "             AND (c.pub IS TRUE$perm_join)\n";
1287                         if ($class eq 'copy') {
1288                             $with .= "       UNION\n"
1289                                    . "       SELECT pr.peer_record AS record FROM container.copy_bucket_item ci\n"
1290                                    . "             JOIN container.copy_bucket c ON (c.id = ci.bucket)\n"
1291                                    . "             JOIN biblio.peer_bib_copy_map pr ON ci.target_copy = pr.target_copy\n"
1292                                    . "       WHERE c.btype = " . $self->QueryParser->quote_value($ctype) . "\n"
1293                                    . "             AND c.id = " . $self->QueryParser->quote_value($cid) . "\n"
1294                                    . "             AND (c.pub IS TRUE$perm_join)\n";
1295                         }
1296                         $with .= "     )";
1297
1298                         $from .= "\n" . ${spc} x 3 . "LEFT JOIN container_${filter_alias} ON container_${filter_alias}.record = m.source";
1299
1300                         my $spcdepth = $self->plan_level + 5;
1301
1302                         $where .= $joiner if $where ne '';
1303                         $where .= "${NOT}(container_${filter_alias} IS NOT NULL)";
1304                     }
1305                 }
1306             } elsif ($filter->name eq 'record_list') {
1307                 if (@{$filter->args} > 0) {
1308                     my $key = 'm.source';
1309                     $key = 'm.metarecord' if (grep {$_->name eq 'metarecord' or $_->name eq 'metabib'} @{$self->QueryParser->parse_tree->modifiers});
1310                     $where .= $joiner if $where ne '';
1311                     $where .= "$key ${NOT}IN (" . join(',', map { $self->QueryParser->quote_value($_) } @{$filter->args}) . ')';
1312                 }
1313             } elsif ($filter->name eq 'locations') {
1314                 if (@{$filter->args} > 0) {
1315                     my $spcdepth = $self->plan_level + 5;
1316                     $where .= $joiner if $where ne '';
1317                     $where .= "(\n"
1318                            . ${spc} x ($spcdepth + 1) . "${NOT}EXISTS(\n"
1319                            . ${spc} x ($spcdepth + 2) . "SELECT 1 FROM asset.call_number acn\n"
1320                            . ${spc} x ($spcdepth + 5) . "JOIN asset.copy acp ON acn.id = acp.call_number\n"
1321                            . ${spc} x ($spcdepth + 2) . "WHERE m.source = acn.record\n"
1322                            . ${spc} x ($spcdepth + 5) . "AND acp.circ_lib IN (SELECT * FROM search_org_list)\n"
1323                            . ${spc} x ($spcdepth + 5) . "AND NOT acn.deleted\n"
1324                            . ${spc} x ($spcdepth + 5) . "AND NOT acp.deleted\n"
1325                            . ${spc} x ($spcdepth + 5) . "AND acp.location IN (" . join(',', map { $self->QueryParser->quote_value($_) } @{ $filter->args }) . ")\n"
1326                            . ${spc} x ($spcdepth + 2) . "LIMIT 1\n"
1327                            . ${spc} x ($spcdepth + 1) . ")\n"
1328                            . ${spc} x ($spcdepth + 1) . ($filter->negate ? 'AND' : 'OR') . "\n"
1329                            . ${spc} x ($spcdepth + 1) . "${NOT}EXISTS(\n"
1330                            . ${spc} x ($spcdepth + 2) . "SELECT 1 FROM biblio.peer_bib_copy_map pr\n"
1331                            . ${spc} x ($spcdepth + 5) . "JOIN asset.copy acp ON pr.target_copy = acp.id\n"
1332                            . ${spc} x ($spcdepth + 2) . "WHERE m.source = pr.peer_record\n"
1333                            . ${spc} x ($spcdepth + 5) . "AND acp.circ_lib IN (SELECT * FROM search_org_list)\n"
1334                            . ${spc} x ($spcdepth + 5) . "AND NOT acp.deleted\n"
1335                            . ${spc} x ($spcdepth + 5) . "AND acp.location IN (" . join(',', map { $self->QueryParser->quote_value($_) } @{ $filter->args }) . ")\n"
1336                            . ${spc} x ($spcdepth + 2) . "LIMIT 1\n"
1337                            . ${spc} x ($spcdepth + 1) . ")\n"
1338                            . ${spc} x $spcdepth . ")";
1339                 }
1340             } elsif ($filter->name eq 'statuses') {
1341                 if (@{$filter->args} > 0) {
1342                     my $spcdepth = $self->plan_level + 5;
1343                     $where .= $joiner if $where ne '';
1344                     $where .= "(\n"
1345                            . ${spc} x ($spcdepth + 1) . "${NOT}EXISTS(\n"
1346                            . ${spc} x ($spcdepth + 2) . "SELECT 1 FROM asset.call_number acn\n"
1347                            . ${spc} x ($spcdepth + 5) . "JOIN asset.copy acp ON acn.id = acp.call_number\n"
1348                            . ${spc} x ($spcdepth + 2) . "WHERE m.source = acn.record\n"
1349                            . ${spc} x ($spcdepth + 5) . "AND acp.circ_lib IN (SELECT * FROM search_org_list)\n"
1350                            . ${spc} x ($spcdepth + 5) . "AND NOT acn.deleted\n"
1351                            . ${spc} x ($spcdepth + 5) . "AND NOT acp.deleted\n"
1352                            . ${spc} x ($spcdepth + 5) . "AND acp.status IN (" . join(',', map { $self->QueryParser->quote_value($_) } @{ $filter->args }) . ")\n"
1353                            . ${spc} x ($spcdepth + 2) . "LIMIT 1\n"
1354                            . ${spc} x ($spcdepth + 1) . ")\n"
1355                            . ${spc} x ($spcdepth + 1) . ($filter->negate ? 'AND' : 'OR') . "\n"
1356                            . ${spc} x ($spcdepth + 1) . "${NOT}EXISTS(\n"
1357                            . ${spc} x ($spcdepth + 2) . "SELECT 1 FROM biblio.peer_bib_copy_map pr\n"
1358                            . ${spc} x ($spcdepth + 5) . "JOIN asset.copy acp ON pr.target_copy = acp.id\n"
1359                            . ${spc} x ($spcdepth + 2) . "WHERE m.source = pr.peer_record\n"
1360                            . ${spc} x ($spcdepth + 5) . "AND acp.circ_lib IN (SELECT * FROM search_org_list)\n"
1361                            . ${spc} x ($spcdepth + 5) . "AND NOT acp.deleted\n"
1362                            . ${spc} x ($spcdepth + 5) . "AND acp.status IN (" . join(',', map { $self->QueryParser->quote_value($_) } @{ $filter->args }) . ")\n"
1363                            . ${spc} x ($spcdepth + 2) . "LIMIT 1\n"
1364                            . ${spc} x ($spcdepth + 1) . ")\n"
1365                            . ${spc} x $spcdepth . ")";
1366                 }
1367             } elsif ($filter->name eq 'bib_source') {
1368                 if (@{$filter->args} > 0) {
1369                     $where .= $joiner if $where ne '';
1370                     $where .= "${NOT}COALESCE(bre.source IN ("
1371                            . join(',', map { $self->QueryParser->quote_value($_) } @{ $filter->args })
1372                            . "), false)";
1373                 }
1374             }
1375         }
1376     }
1377     warn "flatten(): full filter where => $where\n" if $self->QueryParser->debug;
1378
1379     return { rank_list => \@rank_list, from => $from, where => $where,  with => $with };
1380 }
1381
1382
1383 #-------------------------------
1384 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::filter;
1385 use base 'QueryParser::query_plan::filter';
1386
1387 #-------------------------------
1388 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::facet;
1389 use base 'QueryParser::query_plan::facet';
1390
1391 sub classname {
1392     my $self = shift;
1393     my ($classname) = split '\|', $self->name;
1394     return $classname;
1395 }
1396
1397 sub fields {
1398     my $self = shift;
1399     my ($classname,@fields) = split '\|', $self->name;
1400     return \@fields;
1401 }
1402
1403 sub table_alias {
1404     my $self = shift;
1405
1406     my $table_alias = "$self";
1407     $table_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
1408     $table_alias .= '_' . $self->name;
1409     $table_alias =~ s/\|/_/go;
1410
1411     return $table_alias;
1412 }
1413
1414
1415 #-------------------------------
1416 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::modifier;
1417 use base 'QueryParser::query_plan::modifier';
1418
1419 #-------------------------------
1420 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::node::atom;
1421 use base 'QueryParser::query_plan::node::atom';
1422
1423 sub sql {
1424     my $self = shift;
1425     my $sql = shift;
1426
1427     $self->{sql} = $sql if ($sql);
1428
1429     return $self->{sql} if ($self->{sql});
1430     return $self->buildSQL;
1431 }
1432
1433 sub buildSQL {
1434     my $self = shift;
1435
1436     my $classname = $self->node->classname;
1437
1438     return $self->sql("to_tsquery('$classname','')") if $self->{dummy};
1439
1440     my $normalizers = $self->node->plan->QueryParser->query_normalizers( $classname );
1441     my $fields = $self->node->fields;
1442
1443     my $lang;
1444     my $filter = $self->node->plan->find_filter('preferred_language');
1445     $lang ||= $filter->args->[0] if ($filter && $filter->args);
1446     $lang ||= $self->node->plan->QueryParser->default_preferred_language;
1447     my $ts_configs = [];
1448
1449     if (@{$self->node->phrases}) {
1450         # We assume we want 'simple' for phrases. Gives us less to match against later.
1451         $ts_configs = ['simple'];
1452     } else {
1453         if (!@$fields) {
1454             $ts_configs = $self->node->plan->QueryParser->class_ts_config($classname, $lang);
1455         } else {
1456             for my $field (@$fields) {
1457                 push @$ts_configs, @{$self->node->plan->QueryParser->field_ts_config($classname, $field, $lang)};
1458             }
1459         }
1460         $ts_configs = [keys %{{map { $_ => 1 } @$ts_configs}}];
1461     }
1462
1463     # Assume we want exact if none otherwise provided.
1464     # Because we can reasonably expect this to exist
1465     $ts_configs = ['simple'] unless (scalar @$ts_configs);
1466
1467     $fields = $self->node->plan->QueryParser->search_fields->{$classname} if (!@$fields);
1468
1469     my %norms;
1470     my $pos = 0;
1471     for my $field (@$fields) {
1472         for my $nfield (keys %$normalizers) {
1473             for my $nizer ( @{$$normalizers{$nfield}} ) {
1474                 if ($field eq $nfield) {
1475                     my $param_string = OpenSRF::Utils::JSON->perl2JSON($nizer->{params});
1476                     if (!exists($norms{$nizer->{function}.$param_string})) {
1477                         $norms{$nizer->{function}.$param_string} = {p=>$pos++,n=>$nizer};
1478                     }
1479                 }
1480             }
1481         }
1482     }
1483
1484     my $sql = $self->node->plan->QueryParser->quote_value($self->content);
1485
1486     for my $n ( map { $$_{n} } sort { $$a{p} <=> $$b{p} } values %norms ) {
1487         $sql = join(', ', $sql, map { $self->node->plan->QueryParser->quote_value($_) } @{ $n->{params} });
1488         $sql = $n->{function}."($sql)";
1489     }
1490
1491     my $prefix = $self->prefix || '';
1492     my $suffix = $self->suffix || '';
1493     my $joiner = ' || ';
1494     $joiner = ' && ' if $self->prefix eq '!'; # Negative atoms should be "none of the variants" instead of "any of the variants"
1495
1496     $prefix = "'$prefix' ||" if $prefix;
1497     my $suffix_op = '';
1498     my $suffix_after = '';
1499
1500     $suffix_op = ":$suffix" if $suffix;
1501     $suffix_after = "|| '$suffix_op'" if $suffix;
1502
1503     my @sql_set = ();
1504     for my $ts_config (@$ts_configs) {
1505         push @sql_set, "to_tsquery('$ts_config', COALESCE(NULLIF($prefix '(' || btrim(regexp_replace($sql,E'(?:\\\\s+|:)','$suffix_op&','g'),'&|') $suffix_after || ')', '()'), ''))";
1506     }
1507
1508     $sql = join($joiner, @sql_set);
1509     $sql = '(' . $sql . ')' if (scalar(@$ts_configs) > 1);
1510
1511     return $self->sql($sql);
1512 }
1513
1514 #-------------------------------
1515 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::node;
1516 use base 'QueryParser::query_plan::node';
1517
1518 sub only_atoms {
1519     my $self = shift;
1520
1521     $self->{dummy_count} = 0;
1522
1523     my $atoms = $self->query_atoms;
1524     my @only_atoms;
1525     for my $a (@$atoms) {
1526         push(@only_atoms, $a) if (ref($a) && $a->isa('QueryParser::query_plan::node::atom'));
1527         $self->{dummy_count}++ if (ref($a) && $a->{dummy});
1528     }
1529
1530     return \@only_atoms;
1531 }
1532
1533 sub only_real_atoms {
1534     my $self = shift;
1535
1536     my $atoms = $self->query_atoms;
1537     my @only_real_atoms;
1538     for my $a (@$atoms) {
1539         push(@only_real_atoms, $a) if (ref($a) && $a->isa('QueryParser::query_plan::node::atom') && !($a->{dummy}));
1540     }
1541
1542     return \@only_real_atoms;
1543 }
1544
1545 sub only_positive_atoms {
1546     my $self = shift;
1547
1548     my $atoms = $self->query_atoms;
1549     my @only_positive_atoms;
1550     for my $a (@$atoms) {
1551         push(@only_positive_atoms, $a) if (ref($a) && $a->isa('QueryParser::query_plan::node::atom') && !($a->{dummy}) && ($a->{prefix} ne '!'));
1552     }
1553
1554     return \@only_positive_atoms;
1555 }
1556
1557 sub dummy_count {
1558     my $self = shift;
1559     return $self->{dummy_count};
1560 }
1561
1562 sub table {
1563     my $self = shift;
1564     my $table = shift;
1565     $self->{table} = $table if ($table);
1566     return $self->{table} if $self->{table};
1567     return $self->table( 'metabib.' . $self->classname . '_field_entry' );
1568 }
1569
1570 sub combined_table {
1571     my $self = shift;
1572     my $ctable = shift;
1573     $self->{ctable} = $ctable if ($ctable);
1574     return $self->{ctable} if $self->{ctable};
1575     return $self->combined_table( 'metabib.combined_' . $self->classname . '_field_entry' );
1576 }
1577
1578 sub table_alias {
1579     my $self = shift;
1580     my $table_alias = shift;
1581     $self->{table_alias} = $table_alias if ($table_alias);
1582     return $self->{table_alias} if ($self->{table_alias});
1583
1584     $table_alias = "$self";
1585     $table_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
1586     $table_alias .= '_' . $self->requested_class;
1587     $table_alias =~ s/\|/_/go;
1588
1589     return $self->table_alias( $table_alias );
1590 }
1591
1592 sub tsquery {
1593     my $self = shift;
1594     return $self->{tsquery} if ($self->{tsquery});
1595
1596     for my $atom (@{$self->query_atoms}) {
1597         if (ref($atom)) {
1598             $self->{tsquery} .= "\n" . ${spc} x 3 . $atom->sql;
1599         } else {
1600             $self->{tsquery} .= $atom x 2;
1601         }
1602     }
1603
1604     return $self->{tsquery};
1605 }
1606
1607 sub tsquery_rank {
1608     my $self = shift;
1609     return $self->{tsquery_rank} if ($self->{tsquery_rank});
1610     my @atomlines;
1611
1612     for my $atom (@{$self->only_positive_atoms}) {
1613         push @atomlines, "\n" . ${spc} x 3 . $atom->sql;
1614     }
1615     $self->{tsquery_rank} = join(' ||', @atomlines);
1616     $self->{tsquery_rank} = 'NULL::tsquery' unless $self->{tsquery_rank};
1617     return $self->{tsquery_rank};
1618 }
1619
1620 sub rank {
1621     my $self = shift;
1622     return $self->{rank} if ($self->{rank});
1623
1624     my $rank_norm_map = $self->plan->QueryParser->custom_data->{rank_cd_weight_map};
1625
1626     my $cover_density = 0;
1627     for my $norm ( keys %$rank_norm_map) {
1628         $cover_density += $$rank_norm_map{$norm} if ($self->plan->find_modifier($norm));
1629     }
1630
1631     my $weights = join(', ', @{$self->plan->QueryParser->search_class_weights($self->classname)});
1632
1633     return $self->{rank} = "ts_rank_cd('{" . $weights . "}', " . $self->table_alias . '.index_vector, ' . $self->table_alias . ".tsq_rank, $cover_density)";
1634 }
1635
1636
1637 1;
1638