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