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