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