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