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