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

   1 package OpenILS::Application::Storage::Driver::Pg::QueryParser;
   2 use OpenILS::Application::Storage::QueryParser;
   3 use base 'QueryParser';
   4 use OpenSRF::Utils::JSON;
   5 use OpenILS::Application::AppUtils;
   6 my $U = 'OpenILS::Application::AppUtils';
   7
   8 sub quote_value {
   9     my $self = shift;
  10     my $value = shift;
  11
  12     if ($value =~ /^\d/) { # may have to use non-$ quoting
  13         $value =~ s/'/''/g;
  14         $value =~ s/\\/\\\\/g;
  15         return "E'$value'";
  16     }
  17     return "\$_$$\$$value\$_$$\$";
  18 }
  19
  20 sub quote_phrase_value {
  21     my $self = shift;
  22     my $value = shift;
  23
  24     my $left_anchored  = $value =~ m/^\^/;
  25     my $right_anchored = $value =~ m/\$$/;
  26     $value =~ s/\^//   if $left_anchored;
  27     $value =~ s/\$$//  if $right_anchored;
  28     $value =~ quotemeta($value);
  29     $value = '^' . $value if $left_anchored;
  30     $value = "$value\$"   if $right_anchored;
  31     return $self->quote_value($value);
  32 }
  33
  34 sub init {
  35     my $class = shift;
  36 }
  37
  38 sub default_preferred_language {
  39     my $self = shift;
  40     my $lang = shift;
  41
  42     $self->custom_data->{default_preferred_language} = $lang if ($lang);
  43     return $self->custom_data->{default_preferred_language};
  44 }
  45
  46 sub default_preferred_language_multiplier {
  47     my $self = shift;
  48     my $lang = shift;
  49
  50     $self->custom_data->{default_preferred_language_multiplier} = $lang if ($lang);
  51     return $self->custom_data->{default_preferred_language_multiplier};
  52 }
  53
  54 sub simple_plan {
  55     my $self = shift;
  56
  57     return 0 unless $self->parse_tree;
  58     return 0 if @{$self->parse_tree->filters};
  59     return 0 if @{$self->parse_tree->modifiers};
  60     for my $node ( @{ $self->parse_tree->query_nodes } ) {
  61         return 0 if (!ref($node) && $node eq '|');
  62         next unless (ref($node));
  63         return 0 if ($node->isa('QueryParser::query_plan'));
  64     }
  65
  66     return 1;
  67 }
  68
  69 sub toSQL {
  70     my $self = shift;
  71     return $self->parse_tree->toSQL;
  72 }
  73
  74 sub dynamic_filters {
  75     my $self = shift;
  76     my $new = shift;
  77
  78     $self->custom_data->{dynamic_filters} ||= [];
  79     push(@{$self->custom_data->{dynamic_filters}}, $new) if ($new);
  80     return $self->custom_data->{dynamic_filters};
  81 }
  82
  83 sub dynamic_sorters {
  84     my $self = shift;
  85     my $new = shift;
  86
  87     $self->custom_data->{dynamic_sorters} ||= [];
  88     push(@{$self->custom_data->{dynamic_sorters}}, $new) if ($new);
  89     return $self->custom_data->{dynamic_sorters};
  90 }
  91
  92 sub facet_field_id_map {
  93     my $self = shift;
  94     my $map = shift;
  95
  96     $self->custom_data->{facet_field_id_map} ||= {};
  97     $self->custom_data->{facet_field_id_map} = $map if ($map);
  98     return $self->custom_data->{facet_field_id_map};
  99 }
 100
 101 sub add_facet_field_id_map {
 102     my $self = shift;
 103     my $class = shift;
 104     my $field = shift;
 105     my $id = shift;
 106     my $weight = shift;
 107
 108     $self->add_facet_field( $class => $field );
 109     $self->facet_field_id_map->{by_id}{$id} = { classname => $class, field => $field, weight => $weight };
 110     $self->facet_field_id_map->{by_class}{$class}{$field} = $id;
 111
 112     return {
 113         by_id => { $id => { classname => $class, field => $field, weight => $weight } },
 114         by_class => { $class => { $field => $id } }
 115     };
 116 }
 117
 118 sub facet_field_class_by_id {
 119     my $self = shift;
 120     my $id = shift;
 121
 122     return $self->facet_field_id_map->{by_id}{$id};
 123 }
 124
 125 sub facet_field_ids_by_class {
 126     my $self = shift;
 127     my $class = shift;
 128     my $field = shift;
 129
 130     return undef unless ($class);
 131
 132     if ($field) {
 133         return [$self->facet_field_id_map->{by_class}{$class}{$field}];
 134     }
 135
 136     return [values( %{ $self->facet_field_id_map->{by_class}{$class} } )];
 137 }
 138
 139 sub search_field_id_map {
 140     my $self = shift;
 141     my $map = shift;
 142
 143     $self->custom_data->{search_field_id_map} ||= {};
 144     $self->custom_data->{search_field_id_map} = $map if ($map);
 145     return $self->custom_data->{search_field_id_map};
 146 }
 147
 148 sub add_search_field_id_map {
 149     my $self = shift;
 150     my $class = shift;
 151     my $field = shift;
 152     my $id = shift;
 153     my $weight = shift;
 154
 155     $self->add_search_field( $class => $field );
 156     $self->search_field_id_map->{by_id}{$id} = { classname => $class, field => $field, weight => $weight };
 157     $self->search_field_id_map->{by_class}{$class}{$field} = $id;
 158
 159     return {
 160         by_id => { $id => { classname => $class, field => $field, weight => $weight } },
 161         by_class => { $class => { $field => $id } }
 162     };
 163 }
 164
 165 sub search_field_class_by_id {
 166     my $self = shift;
 167     my $id = shift;
 168
 169     return $self->search_field_id_map->{by_id}{$id};
 170 }
 171
 172 sub search_field_ids_by_class {
 173     my $self = shift;
 174     my $class = shift;
 175     my $field = shift;
 176
 177     return undef unless ($class);
 178
 179     if ($field) {
 180         return [$self->search_field_id_map->{by_class}{$class}{$field}];
 181     }
 182
 183     return [values( %{ $self->search_field_id_map->{by_class}{$class} } )];
 184 }
 185
 186 sub relevance_bumps {
 187     my $self = shift;
 188     my $bumps = shift;
 189
 190     $self->custom_data->{rel_bumps} ||= {};
 191     $self->custom_data->{rel_bumps} = $bumps if ($bumps);
 192     return $self->custom_data->{rel_bumps};
 193 }
 194
 195 sub find_relevance_bumps {
 196     my $self = shift;
 197     my $class = shift;
 198     my $field = shift;
 199
 200     return $self->relevance_bumps->{$class}{$field};
 201 }
 202
 203 sub add_relevance_bump {
 204     my $self = shift;
 205     my $class = shift;
 206     my $field = shift;
 207     my $type = shift;
 208     my $multiplier = shift;
 209     my $active = shift;
 210
 211     if (defined($active) and $active eq 'f') {
 212         $active = 0;
 213     } else {
 214         $active = 1;
 215     }
 216
 217     $self->relevance_bumps->{$class}{$field}{$type} = { multiplier => $multiplier, active => $active };
 218
 219     return { $class => { $field => { $type => { multiplier => $multiplier, active => $active } } } };
 220 }
 221
 222
 223 sub initialize_search_field_id_map {
 224     my $self = shift;
 225     my $cmf_list = shift;
 226
 227     for my $cmf (@$cmf_list) {
 228         __PACKAGE__->add_search_field_id_map( $cmf->field_class, $cmf->name, $cmf->id, $cmf->weight ) if ($U->is_true($cmf->search_field));
 229         __PACKAGE__->add_facet_field_id_map( $cmf->field_class, $cmf->name, $cmf->id, $cmf->weight ) if ($U->is_true($cmf->facet_field));
 230     }
 231
 232     return $self->search_field_id_map;
 233 }
 234
 235 sub initialize_aliases {
 236     my $self = shift;
 237     my $cmsa_list = shift;
 238
 239     for my $cmsa (@$cmsa_list) {
 240         if (!$cmsa->field) {
 241             __PACKAGE__->add_search_class_alias( $cmsa->field_class, $cmsa->alias );
 242         } else {
 243             my $c = $self->search_field_class_by_id( $cmsa->field );
 244             __PACKAGE__->add_search_field_alias( $cmsa->field_class, $c->{field}, $cmsa->alias );
 245         }
 246     }
 247 }
 248
 249 sub initialize_relevance_bumps {
 250     my $self = shift;
 251     my $sra_list = shift;
 252
 253     for my $sra (@$sra_list) {
 254         my $c = $self->search_field_class_by_id( $sra->field );
 255         __PACKAGE__->add_relevance_bump( $c->{classname}, $c->{field}, $sra->bump_type, $sra->multiplier, $sra->active );
 256     }
 257
 258     return $self->relevance_bumps;
 259 }
 260
 261 sub initialize_query_normalizers {
 262     my $self = shift;
 263     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" }] }
 264
 265     for my $cmfinm ( @$tree ) {
 266         my $field_info = $self->search_field_class_by_id( $cmfinm->field );
 267         __PACKAGE__->add_query_normalizer( $field_info->{classname}, $field_info->{field}, $cmfinm->norm->func, OpenSRF::Utils::JSON->JSON2perl($cmfinm->params) );
 268     }
 269 }
 270
 271 sub initialize_dynamic_filters {
 272     my $self = shift;
 273     my $list = shift; # open-ils.cstore.direct.config.record_attr_definition.search.atomic { "id" : { "!=" : null } }
 274
 275     for my $crad ( @$list ) {
 276         __PACKAGE__->dynamic_filters( __PACKAGE__->add_search_filter( $crad->name ) ) if ($U->is_true($crad->filter));
 277         __PACKAGE__->dynamic_sorters( $crad->name ) if ($U->is_true($crad->sorter));
 278     }
 279 }
 280
 281 sub initialize_filter_normalizers {
 282     my $self = shift;
 283     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" }] }
 284
 285     for my $crainm ( @$tree ) {
 286         __PACKAGE__->add_filter_normalizer( $crainm->name, $crainm->norm->func, OpenSRF::Utils::JSON->JSON2perl($crainm->params) );
 287     }
 288 }
 289
 290 our $_complete = 0;
 291 sub initialization_complete {
 292     return $_complete;
 293 }
 294
 295 sub initialize {
 296     my $self = shift;
 297     my %args = @_;
 298
 299     return $_complete if ($_complete);
 300
 301     # tsearch rank normalization adjustments. see http://www.postgresql.org/docs/9.0/interactive/textsearch-controls.html#TEXTSEARCH-RANKING for details
 302     $self->custom_data->{rank_cd_weight_map} = {
 303         CD_logDocumentLength    => 1,
 304         CD_documentLength       => 2,
 305         CD_meanHarmonic         => 4,
 306         CD_uniqueWords          => 8,
 307         CD_logUniqueWords       => 16,
 308         CD_selfPlusOne          => 32
 309     };
 310
 311     $self->add_search_modifier( $_ ) for (keys %{ $self->custom_data->{rank_cd_weight_map} });
 312
 313     $self->initialize_search_field_id_map( $args{config_metabib_field} )
 314         if ($args{config_metabib_field});
 315
 316     $self->initialize_aliases( $args{config_metabib_search_alias} )
 317         if ($args{config_metabib_search_alias});
 318
 319     $self->initialize_relevance_bumps( $args{search_relevance_adjustment} )
 320         if ($args{search_relevance_adjustment});
 321
 322     $self->initialize_query_normalizers( $args{config_metabib_field_index_norm_map} )
 323         if ($args{config_metabib_field_index_norm_map});
 324
 325     $self->initialize_dynamic_filters( $args{config_record_attr_definition} )
 326         if ($args{config_record_attr_definition});
 327
 328     $self->initialize_filter_normalizers( $args{config_record_attr_index_norm_map} )
 329         if ($args{config_record_attr_index_norm_map});
 330
 331     $_complete = 1 if (
 332         $args{config_metabib_field_index_norm_map} &&
 333         $args{search_relevance_adjustment} &&
 334         $args{config_metabib_search_alias} &&
 335         $args{config_metabib_field} &&
 336         $args{config_record_attr_definition}
 337     );
 338
 339     return $_complete;
 340 }
 341
 342 sub TEST_SETUP {
 343
 344     __PACKAGE__->add_search_field_id_map( series => seriestitle => 1 => 1 );
 345
 346     __PACKAGE__->add_search_field_id_map( series => seriestitle => 1 => 1 );
 347     __PACKAGE__->add_relevance_bump( series => seriestitle => first_word => 1.5 );
 348     __PACKAGE__->add_relevance_bump( series => seriestitle => full_match => 20 );
 349
 350     __PACKAGE__->add_search_field_id_map( title => abbreviated => 2 => 1 );
 351     __PACKAGE__->add_relevance_bump( title => abbreviated => first_word => 1.5 );
 352     __PACKAGE__->add_relevance_bump( title => abbreviated => full_match => 20 );
 353
 354     __PACKAGE__->add_search_field_id_map( title => translated => 3 => 1 );
 355     __PACKAGE__->add_relevance_bump( title => translated => first_word => 1.5 );
 356     __PACKAGE__->add_relevance_bump( title => translated => full_match => 20 );
 357
 358     __PACKAGE__->add_search_field_id_map( title => proper => 6 => 1 );
 359     __PACKAGE__->add_query_normalizer( title => proper => 'naco_normalize' );
 360     __PACKAGE__->add_relevance_bump( title => proper => first_word => 1.5 );
 361     __PACKAGE__->add_relevance_bump( title => proper => full_match => 20 );
 362     __PACKAGE__->add_relevance_bump( title => proper => word_order => 10 );
 363
 364     __PACKAGE__->add_search_field_id_map( author => coporate => 7 => 1 );
 365     __PACKAGE__->add_relevance_bump( author => coporate => first_word => 1.5 );
 366     __PACKAGE__->add_relevance_bump( author => coporate => full_match => 20 );
 367
 368     __PACKAGE__->add_facet_field_id_map( author => personal => 8 => 1 );
 369
 370     __PACKAGE__->add_search_field_id_map( author => personal => 8 => 1 );
 371     __PACKAGE__->add_relevance_bump( author => personal => first_word => 1.5 );
 372     __PACKAGE__->add_relevance_bump( author => personal => full_match => 20 );
 373     __PACKAGE__->add_query_normalizer( author => personal => 'naco_normalize' );
 374     __PACKAGE__->add_query_normalizer( author => personal => 'split_date_range' );
 375
 376     __PACKAGE__->add_facet_field_id_map( subject => topic => 14 => 1 );
 377
 378     __PACKAGE__->add_search_field_id_map( subject => topic => 14 => 1 );
 379     __PACKAGE__->add_relevance_bump( subject => topic => first_word => 1 );
 380     __PACKAGE__->add_relevance_bump( subject => topic => full_match => 1 );
 381
 382     __PACKAGE__->add_search_field_id_map( subject => complete => 16 => 1 );
 383     __PACKAGE__->add_relevance_bump( subject => complete => first_word => 1 );
 384     __PACKAGE__->add_relevance_bump( subject => complete => full_match => 1 );
 385
 386     __PACKAGE__->add_search_field_id_map( keyword => keyword => 15 => 1 );
 387     __PACKAGE__->add_relevance_bump( keyword => keyword => first_word => 1 );
 388     __PACKAGE__->add_relevance_bump( keyword => keyword => full_match => 1 );
 389
 390
 391     __PACKAGE__->add_search_class_alias( keyword => 'kw' );
 392     __PACKAGE__->add_search_class_alias( title => 'ti' );
 393     __PACKAGE__->add_search_class_alias( author => 'au' );
 394     __PACKAGE__->add_search_class_alias( author => 'name' );
 395     __PACKAGE__->add_search_class_alias( author => 'dc.contributor' );
 396     __PACKAGE__->add_search_class_alias( subject => 'su' );
 397     __PACKAGE__->add_search_class_alias( subject => 'bib.subject(?:Title|Place|Occupation)' );
 398     __PACKAGE__->add_search_class_alias( series => 'se' );
 399     __PACKAGE__->add_search_class_alias( keyword => 'dc.identifier' );
 400
 401     __PACKAGE__->add_query_normalizer( author => corporate => 'naco_normalize' );
 402     __PACKAGE__->add_query_normalizer( keyword => keyword => 'naco_normalize' );
 403
 404     __PACKAGE__->add_search_field_alias( subject => name => 'bib.subjectName' );
 405
 406 }
 407
 408 __PACKAGE__->default_search_class( 'keyword' );
 409
 410 # will be retained simply for back-compat
 411 __PACKAGE__->add_search_filter( 'format' );
 412
 413 # grumble grumble, special cases against date1 and date2
 414 __PACKAGE__->add_search_filter( 'before' );
 415 __PACKAGE__->add_search_filter( 'after' );
 416 __PACKAGE__->add_search_filter( 'between' );
 417 __PACKAGE__->add_search_filter( 'during' );
 418
 419 # used by layers above this
 420 __PACKAGE__->add_search_filter( 'statuses' );
 421 __PACKAGE__->add_search_filter( 'locations' );
 422 __PACKAGE__->add_search_filter( 'site' );
 423 __PACKAGE__->add_search_filter( 'lasso' );
 424 __PACKAGE__->add_search_filter( 'my_lasso' );
 425 __PACKAGE__->add_search_filter( 'depth' );
 426 __PACKAGE__->add_search_filter( 'language' );
 427 __PACKAGE__->add_search_filter( 'offset' );
 428 __PACKAGE__->add_search_filter( 'limit' );
 429 __PACKAGE__->add_search_filter( 'check_limit' );
 430 __PACKAGE__->add_search_filter( 'skip_check' );
 431 __PACKAGE__->add_search_filter( 'superpage' );
 432 __PACKAGE__->add_search_filter( 'superpage_size' );
 433 __PACKAGE__->add_search_filter( 'estimation_strategy' );
 434 __PACKAGE__->add_search_modifier( 'available' );
 435 __PACKAGE__->add_search_modifier( 'staff' );
 436
 437 # used internally, but generally not user-settable
 438 __PACKAGE__->add_search_filter( 'preferred_language' );
 439 __PACKAGE__->add_search_filter( 'preferred_language_weight' );
 440 __PACKAGE__->add_search_filter( 'preferred_language_multiplier' );
 441 __PACKAGE__->add_search_filter( 'core_limit' );
 442
 443 # XXX Valid values to be supplied by SVF
 444 __PACKAGE__->add_search_filter( 'sort' );
 445
 446 # modifies core query, not configurable
 447 __PACKAGE__->add_search_modifier( 'descending' );
 448 __PACKAGE__->add_search_modifier( 'ascending' );
 449 __PACKAGE__->add_search_modifier( 'metarecord' );
 450 __PACKAGE__->add_search_modifier( 'metabib' );
 451
 452
 453 #-------------------------------
 454 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan;
 455 use base 'QueryParser::query_plan';
 456 use OpenSRF::Utils::Logger qw($logger);
 457 use Data::Dumper;
 458
 459 sub toSQL {
 460     my $self = shift;
 461
 462     my %filters;
 463     my ($format) = $self->find_filter('format');
 464     if ($format) {
 465         my ($t,$f) = split('-', $format->args->[0]);
 466         $self->new_filter( item_type => [ split '', $t ] ) if ($t);
 467         $self->new_filter( item_form => [ split '', $f ] ) if ($f);
 468     }
 469
 470     for my $f ( qw/preferred_language preferred_language_multiplier preferred_language_weight core_limit check_limit skip_check superpage superpage_size/ ) {
 471         my $col = $f;
 472         $col = 'preferred_language_multiplier' if ($f eq 'preferred_language_weight');
 473         my ($filter) = $self->find_filter($f);
 474         if ($filter and @{$filter->args}) {
 475             $filters{$col} = $filter->args->[0];
 476         }
 477     }
 478
 479     $self->QueryParser->superpage($filters{superpage}) if ($filters{superpage});
 480     $self->QueryParser->superpage_size($filters{superpage_size}) if ($filters{superpage_size});
 481     $self->QueryParser->core_limit($filters{core_limit}) if ($filters{core_limit});
 482
 483     $logger->debug("Query plan:\n".Dumper($self));
 484
 485     my $flat_plan = $self->flatten;
 486
 487     # generate the relevance ranking
 488     my $rel = "AVG(\n\t\t(" . join(")+\n\t\t(", @{$$flat_plan{rank_list}}) . ")\n\t)";
 489
 490     # find any supplied sort option
 491     my ($sort_filter) = $self->find_filter('sort');
 492     if ($sort_filter) {
 493         $sort_filter = $sort_filter->args->[0];
 494     } else {
 495         $sort_filter = 'rel';
 496     }
 497
 498     if (($filters{preferred_language} || $self->QueryParser->default_preferred_language) && ($filters{preferred_language_multiplier} || $self->QueryParser->default_preferred_language_multiplier)) {
 499         my $pl = $self->QueryParser->quote_value( $filters{preferred_language} ? $filters{preferred_language} : $self->QueryParser->default_preferred_language );
 500         my $plw = $filters{preferred_language_multiplier} ? $filters{preferred_language_multiplier} : $self->QueryParser->default_preferred_language_multiplier;
 501         $rel = "($rel * COALESCE( NULLIF( FIRST(mrd.attrs \@> hstore('item_lang', $pl)), FALSE )::INT * $plw, 1))";
 502     }
 503     $rel = "1.0/($rel)::NUMERIC";
 504
 505     my %dyn_filters = ( '' => [] ); # the "catch-all" key
 506     for my $f ( @{ $self->QueryParser->dynamic_filters } ) {
 507         my $col = $f;
 508         $col = 'item_lang' if ($f eq 'language'); #XXX filter aliases would address this ... booo ... later
 509
 510         my ($filter) = $self->find_filter($f);
 511         if ($filter) {
 512             my @fargs = @{$filter->args};
 513
 514             if (@fargs > 1) {
 515                 $dyn_filters{$f} = "( " .
 516                     join(
 517                         " OR ",
 518                         map { "mrd.attrs \@> hstore('$col', " . $self->QueryParser->quote_value($_) . ")" } @fargs
 519                     ) .
 520                     " )";
 521             } else {
 522                 push(@{$dyn_filters{''}}, "hstore('$col', " . $self->QueryParser->quote_value($fargs[0]) . ")");
 523             }
 524         }
 525     }
 526
 527     my $combined_dyn_filters = '';
 528     $combined_dyn_filters .= 'AND mrd.attrs @> (' . join(' || ', @{$dyn_filters{''}}) . ') ' if (@{$dyn_filters{''}});
 529     delete($dyn_filters{''});
 530
 531     my @dyn_filter_list = values(%dyn_filters);
 532     $combined_dyn_filters .= 'AND ' . join(' AND ', @dyn_filter_list) if (@dyn_filter_list);
 533
 534     my $rank = $rel;
 535
 536     my $desc = 'ASC';
 537     $desc = 'DESC' if ($self->find_modifier('descending'));
 538
 539     if (grep {$_ eq $sort_filter} @{$self->QueryParser->dynamic_sorters}) {
 540         $rank = "FIRST(mrd.attrs->'$sort_filter')"
 541     } elsif ($sort_filter eq 'create_date') {
 542         $rank = "FIRST((SELECT create_date FROM biblio.record_entry rbr WHERE rbr.id = m.source))";
 543     } elsif ($sort_filter eq 'edit_date') {
 544         $rank = "FIRST((SELECT edit_date FROM biblio.record_entry rbr WHERE rbr.id = m.source))";
 545     } else {
 546         # default to rel ranking
 547         $rank = $rel;
 548     }
 549
 550     my $key = 'm.source';
 551     $key = 'm.metarecord' if (grep {$_->name eq 'metarecord' or $_->name eq 'metabib'} @{$self->modifiers});
 552
 553     my ($before) = $self->find_filter('before');
 554     my ($after) = $self->find_filter('after');
 555     my ($during) = $self->find_filter('during');
 556     my ($between) = $self->find_filter('between');
 557
 558     if ($before and @{$before->args} == 1) {
 559         $before = "AND (mrd.attrs->'date1') <= " . $self->QueryParser->quote_value($before->args->[0]);
 560     } else {
 561         $before = '';
 562     }
 563
 564     if ($after and @{$after->args} == 1) {
 565         $after = "AND (mrd.attrs->'date1') >= " . $self->QueryParser->quote_value($after->args->[0]);
 566     } else {
 567         $after = '';
 568     }
 569
 570     if ($during and @{$during->args} == 1) {
 571         $during = "AND " . $self->QueryParser->quote_value($during->args->[0]) . " BETWEEN (mrd.attrs->'date1') AND (mrd.attrs->'date2')";
 572     } else {
 573         $during = '';
 574     }
 575
 576     if ($between and @{$between->args} == 2) {
 577         $between = "AND (mrd.attrs->'date1') BETWEEN " . $self->QueryParser->quote_value($between->args->[0]) . " AND " . $self->QueryParser->quote_value($between->args->[1]);
 578     } else {
 579         $between = '';
 580     }
 581
 582     my $core_limit = $self->QueryParser->core_limit || 25000;
 583
 584     my $sql = <<SQL;
 585 SELECT  $key AS id,
 586         ARRAY_ACCUM(DISTINCT m.source) AS records,
 587         $rel AS rel,
 588         $rank AS rank,
 589         FIRST(mrd.attrs->'date1') AS tie_break
 590   FROM  metabib.metarecord_source_map m
 591         JOIN metabib.record_attr mrd ON (m.source = mrd.id)
 592         $$flat_plan{from}
 593   WHERE 1=1
 594         $before
 595         $after
 596         $during
 597         $between
 598         $combined_dyn_filters
 599         AND $$flat_plan{where}
 600   GROUP BY 1
 601   ORDER BY 4 $desc NULLS LAST, 5 DESC NULLS LAST, 3 DESC
 602   LIMIT $core_limit
 603 SQL
 604
 605     warn $sql if $self->QueryParser->debug;
 606     return $sql;
 607
 608 }
 609
 610
 611 sub rel_bump {
 612     my $self = shift;
 613     my $node = shift;
 614     my $bump = shift;
 615     my $multiplier = shift;
 616
 617     my $only_atoms = $node->only_atoms;
 618     return '' if (!@$only_atoms);
 619
 620     if ($bump eq 'first_word') {
 621         return " /* first_word */ COALESCE(NULLIF( (naco_normalize(".$node->table_alias.".value) ~ ('^'||naco_normalize(".$self->QueryParser->quote_value($only_atoms->[0]->content)."))), FALSE )::INT * $multiplier, 1)";
 622     } elsif ($bump eq 'full_match') {
 623         return " /* full_match */ COALESCE(NULLIF( (naco_normalize(".$node->table_alias.".value) ~ ('^'||".
 624                     join( "||' '||", map { "naco_normalize(".$self->QueryParser->quote_value($_->content).")" } @$only_atoms )."||'\$')), FALSE )::INT * $multiplier, 1)";
 625     } elsif ($bump eq 'word_order') {
 626         return " /* word_order */ COALESCE(NULLIF( (naco_normalize(".$node->table_alias.".value) ~ (".
 627                     join( "||'.*'||", map { "naco_normalize(".$self->QueryParser->quote_value($_->content).")" } @$only_atoms ).")), FALSE )::INT * $multiplier, 1)";
 628     }
 629
 630     return '';
 631 }
 632
 633 sub flatten {
 634     my $self = shift;
 635
 636     my $from = shift || '';
 637     my $where = shift || '(';
 638
 639     my @rank_list;
 640     for my $node ( @{$self->query_nodes} ) {
 641         if (ref($node)) {
 642             if ($node->isa( 'QueryParser::query_plan::node' )) {
 643
 644                 unless (@{$node->only_atoms}) {
 645                     push @rank_list, '1';
 646                     $where .= 'TRUE';
 647                     next;
 648                 }
 649
 650                 my $table = $node->table;
 651                 my $talias = $node->table_alias;
 652
 653                 my $node_rank = $node->rank . " * ${talias}.weight";
 654
 655                 my $core_limit = $self->QueryParser->core_limit || 25000;
 656                 $from .= "\n\tLEFT JOIN (\n\t\tSELECT fe.*, fe_weight.weight, x.tsq /* search */\n\t\t  FROM  $table AS fe";
 657                 $from .= "\n\t\t\tJOIN config.metabib_field AS fe_weight ON (fe_weight.id = fe.field)";
 658                 $from .= "\n\t\t\tJOIN (SELECT ".$node->tsquery ." AS tsq ) AS x ON (fe.index_vector @@ x.tsq)";
 659
 660                 my @bump_fields;
 661                 if (@{$node->fields} > 0) {
 662                     @bump_fields = @{$node->fields};
 663
 664                     my @field_ids;
 665                     push(@field_ids, $self->QueryParser->search_field_ids_by_class( $node->classname, $_ )->[0]) for (@bump_fields);
 666                     $from .= "\n\t\t\tWHERE fe_weight.id IN  (". join(',', @field_ids) .")";
 667
 668                 } else {
 669                     @bump_fields = @{$self->QueryParser->search_fields->{$node->classname}};
 670                 }
 671
 672                 ###$from .= "\n\t\tLIMIT $core_limit";
 673                 $from .= "\n\t) AS $talias ON (m.source = ${talias}.source)";
 674
 675
 676                 my %used_bumps;
 677                 for my $field ( @bump_fields ) {
 678                     my $bumps = $self->QueryParser->find_relevance_bumps( $node->classname => $field );
 679                     for my $b (keys %$bumps) {
 680                         next if (!$$bumps{$b}{active});
 681                         next if ($used_bumps{$b});
 682                         $used_bumps{$b} = 1;
 683
 684                         next if ($$bumps{$b}{multiplier} == 1); # optimization to remove unneeded bumps
 685
 686                         my $bump_case = $self->rel_bump( $node, $b, $$bumps{$b}{multiplier} );
 687                         $node_rank .= "\n\t\t\t\t * " . $bump_case if ($bump_case);
 688                     }
 689                 }
 690
 691                 $where .= '(' . $talias . ".id IS NOT NULL";
 692                 $where .= ' AND ' . join(' AND ', map {"${talias}.value ~* ".$self->QueryParser->quote_phrase_value($_)} @{$node->phrases}) if (@{$node->phrases});
 693                 $where .= ')';
 694
 695                 push @rank_list, $node_rank;
 696
 697             } elsif ($node->isa( 'QueryParser::query_plan::facet' )) {
 698
 699                 my $table = $node->table;
 700                 my $talias = $node->table_alias;
 701
 702                 my @field_ids;
 703                 if (@{$node->fields} > 0) {
 704                     push(@field_ids, $self->QueryParser->facet_field_ids_by_class( $node->classname, $_ )->[0]) for (@{$node->fields});
 705                 } else {
 706                     @field_ids = @{ $self->QueryParser->facet_field_ids_by_class( $node->classname ) };
 707                 }
 708
 709                 $from .= "\n\tJOIN /* facet */ metabib.facet_entry $talias ON (\n\t\tm.source = ${talias}.source\n\t\t".
 710                          "AND SUBSTRING(${talias}.value,1,1024) IN (" . join(",", map { $self->QueryParser->quote_value($_) } @{$node->values}) . ")\n\t\t".
 711                          "AND ${talias}.field IN (". join(',', @field_ids) . ")\n\t)";
 712
 713                 $where .= 'TRUE';
 714
 715             } else {
 716                 my $subnode = $node->flatten;
 717
 718                 push(@rank_list, @{$$subnode{rank_list}});
 719                 $from .= $$subnode{from};
 720                 $where .= "($$subnode{where})";
 721             }
 722         } else {
 723             $where .= ' AND ' if ($node eq '&');
 724             $where .= ' OR ' if ($node eq '|');
 725             # ... stitching the WHERE together ...
 726         }
 727     }
 728
 729     return { rank_list => \@rank_list, from => $from, where => $where.')' };
 730
 731 }
 732
 733
 734 #-------------------------------
 735 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::filter;
 736 use base 'QueryParser::query_plan::filter';
 737
 738 #-------------------------------
 739 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::facet;
 740 use base 'QueryParser::query_plan::facet';
 741
 742 sub classname {
 743     my $self = shift;
 744     my ($classname) = split '\|', $self->name;
 745     return $classname;
 746 }
 747
 748 sub table {
 749     my $self = shift;
 750     return 'metabib.' . $self->classname . '_field_entry';
 751 }
 752
 753 sub fields {
 754     my $self = shift;
 755     my ($classname,@fields) = split '\|', $self->name;
 756     return \@fields;
 757 }
 758
 759 sub table_alias {
 760     my $self = shift;
 761
 762     my $table_alias = "$self";
 763     $table_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
 764     $table_alias .= '_' . $self->name;
 765     $table_alias =~ s/\|/_/go;
 766
 767     return $table_alias;
 768 }
 769
 770
 771 #-------------------------------
 772 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::modifier;
 773 use base 'QueryParser::query_plan::modifier';
 774
 775 #-------------------------------
 776 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::node::atom;
 777 use base 'QueryParser::query_plan::node::atom';
 778
 779 sub sql {
 780     my $self = shift;
 781     my $sql = shift;
 782
 783     $self->{sql} = $sql if ($sql);
 784
 785     return $self->{sql} if ($self->{sql});
 786     return $self->buildSQL;
 787 }
 788
 789 sub buildSQL {
 790     my $self = shift;
 791
 792     my $classname = $self->node->classname;
 793
 794     my $normalizers = $self->node->plan->QueryParser->query_normalizers( $classname );
 795     my $fields = $self->node->fields;
 796
 797     $fields = $self->node->plan->QueryParser->search_fields->{$classname} if (!@$fields);
 798
 799     my %norms;
 800     my $pos = 0;
 801     for my $field (@$fields) {
 802         for my $nfield (keys %$normalizers) {
 803             for my $nizer ( @{$$normalizers{$nfield}} ) {
 804                 if ($field eq $nfield) {
 805                     my $param_string = OpenSRF::Utils::JSON->perl2JSON($nizer->{params});
 806                     if (!exists($norms{$nizer->{function}.$param_string})) {
 807                         $norms{$nizer->{function}.$param_string} = {p=>$pos++,n=>$nizer};
 808                     }
 809                 }
 810             }
 811         }
 812     }
 813
 814     my $sql = $self->node->plan->QueryParser->quote_value($self->content);
 815
 816     for my $n ( map { $$_{n} } sort { $$a{p} <=> $$b{p} } values %norms ) {
 817         $sql = join(', ', $sql, map { $self->node->plan->QueryParser->quote_value($_) } @{ $n->{params} });
 818         $sql = $n->{function}."($sql)";
 819     }
 820
 821     my $prefix = $self->prefix || '';
 822     my $suffix = $self->suffix || '';
 823
 824     $prefix = "'$prefix' ||" if $prefix;
 825     my $suffix_op = ":$suffix" if $suffix;
 826     my $suffix_after = "|| '$suffix_op'" if $suffix;
 827
 828     $sql = "to_tsquery('$classname', COALESCE(NULLIF($prefix '(' || btrim(regexp_replace($sql,E'(?:\\\\s+|:)','$suffix_op&','g'),'&|') $suffix_after || ')', '()'), ''))";
 829
 830     return $self->sql($sql);
 831 }
 832
 833 #-------------------------------
 834 package OpenILS::Application::Storage::Driver::Pg::QueryParser::query_plan::node;
 835 use base 'QueryParser::query_plan::node';
 836
 837 sub only_atoms {
 838     my $self = shift;
 839
 840     my $atoms = $self->query_atoms;
 841     my @only_atoms;
 842     for my $a (@$atoms) {
 843         push(@only_atoms, $a) if (ref($a) && $a->isa('QueryParser::query_plan::node::atom'));
 844     }
 845
 846     return \@only_atoms;
 847 }
 848
 849 sub table {
 850     my $self = shift;
 851     my $table = shift;
 852     $self->{table} = $table if ($table);
 853     return $self->{table} if $self->{table};
 854     return $self->table( 'metabib.' . $self->classname . '_field_entry' );
 855 }
 856
 857 sub table_alias {
 858     my $self = shift;
 859     my $table_alias = shift;
 860     $self->{table_alias} = $table_alias if ($table_alias);
 861     return $self->{table_alias} if ($self->{table_alias});
 862
 863     $table_alias = "$self";
 864     $table_alias =~ s/^.*\(0(x[0-9a-fA-F]+)\)$/$1/go;
 865     $table_alias .= '_' . $self->requested_class;
 866     $table_alias =~ s/\|/_/go;
 867
 868     return $self->table_alias( $table_alias );
 869 }
 870
 871 sub tsquery {
 872     my $self = shift;
 873     return $self->{tsquery} if ($self->{tsquery});
 874
 875     for my $atom (@{$self->query_atoms}) {
 876         if (ref($atom)) {
 877             $self->{tsquery} .= "\n\t\t\t" .$atom->sql;
 878         } else {
 879             $self->{tsquery} .= $atom x 2;
 880         }
 881     }
 882
 883     return $self->{tsquery};
 884 }
 885
 886 sub rank {
 887     my $self = shift;
 888
 889     my $rank_norm_map = $self->plan->QueryParser->custom_data->{rank_cd_weight_map};
 890
 891     my $cover_density = 0;
 892     for my $norm ( keys %$rank_norm_map) {
 893         $cover_density += $$rank_norm_map{$norm} if ($self->plan->find_modifier($norm));
 894     }
 895
 896     return $self->{rank} if ($self->{rank});
 897     return $self->{rank} = 'rank_cd(' . $self->table_alias . '.index_vector, ' . $self->table_alias . ".tsq, $cover_density)";
 898 }
 899
 900
 901 1;
 902