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

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