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